Skip to content

Change make help output#7901

Merged
Alkarex merged 1 commit intoFreshRSS:edgefrom
aledeg:enhance/makefile
Sep 2, 2025
Merged

Change make help output#7901
Alkarex merged 1 commit intoFreshRSS:edgefrom
aledeg:enhance/makefile

Conversation

@aledeg
Copy link
Member

@aledeg aledeg commented Sep 2, 2025

The new output allows to categorize the targets.

Changes proposed in this pull request:

  • add target categories in the make output

How to test the feature manually:

  1. in the terminal, launch the make command
  2. validate that targets are categorized

Pull request checklist:

  • clear commit messages
  • code manually tested
  • unit tests written (optional if too hard)
  • documentation updated

Additional information can be found in the documentation.

Before

build                          Build a Docker image
i18n-add-key                   Add a translation key to all supported languages
i18n-add-language              Add a new supported language
i18n-format                    Format I18N files
i18n-ignore-key                Ignore a translation key for the selected language
i18n-ignore-unmodified-keys    Ignore all unmodified translation keys for the selected language
i18n-key-exists                Check if a translation key exists
i18n-remove-key                Remove a translation key from all supported languages
i18n-update-key                Update a translation key in all supported languages
lint                           Run the linter on the PHP files
lint-fix                       Fix the errors detected by the linter
pot                            Generate POT templates for docs
refresh                        Refresh feeds by fetching new messages
rtl                            Generate RTL CSS files
start                          Start the development environment (use Docker)
stop                           Stop FreshRSS container if any
test                           Run the test suite

After

Usage:
  make <target>

Docker
  build                           Build a Docker image
  start                           Start the development environment (use Docker)
  stop                            Stop FreshRSS container if any

Tests and linter
  test                            Run the test suite
  lint                            Run the linter on the PHP files
  lint-fix                        Fix the errors detected by the linter

I18n
  i18n-format                     Format I18N files
  i18n-add-language               Add a new supported language
  i18n-add-key                    Add a translation key to all supported languages
  i18n-remove-key                 Remove a translation key from all supported languages
  i18n-update-key                 Update a translation key in all supported languages
  i18n-ignore-key                 Ignore a translation key for the selected language
  i18n-ignore-unmodified-keys     Ignore all unmodified translation keys for the selected language
  i18n-key-exists                 Check if a translation key exists

Tools
  rtl                             Generate RTL CSS files
  pot                             Generate POT templates for docs
  refresh                         Refresh feeds by fetching new messages

Help
  help                            Display this help

The new output allows to categorize the targets.
@Alkarex Alkarex added this to the 1.28.0 milestone Sep 2, 2025
@Alkarex Alkarex merged commit 28e0a54 into FreshRSS:edge Sep 2, 2025
1 check passed
@Alkarex
Copy link
Member

Alkarex commented Sep 2, 2025

By the way, I use mostly make test-all and make fix-all

@aledeg
Copy link
Member Author

aledeg commented Sep 2, 2025

I have a next iteration in mind to allow for such things to me more visible. I am working on it

@aledeg aledeg deleted the enhance/makefile branch September 2, 2025 19:33
@Alkarex Alkarex modified the milestones: 1.28.0, 1.27.1 Sep 2, 2025
@marienfressinaud
Copy link
Member

I didn't notice this change, it's a really nice improvement! :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants