2297 cli parameters consistency #6028
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
aledeg
requested changes
Jan 6, 2024
cli/_cli.php
Outdated
| /** | ||
| * Parses perameters used with FreshRSS' CLI commands. | ||
| * @param array{'valid':array<string,string>,'deprecated':array<string,string>} $parameters An array of 'valid': An | ||
| * array of perameters as keys and their respective getopt() notations as values. 'deprecated' An array with |
There was a problem hiding this comment.
Suggested change
| * array of perameters as keys and their respective getopt() notations as values. 'deprecated' An array with | |
| * array of parameters as keys and their respective getopt() notations as values. 'deprecated' An array with |
There are multiple instances of parameters. Please replace them by parameters.
There was a problem hiding this comment.
That's fixed now.
There was a problem hiding this comment.
Can't believe I forgot how to spell parameters...
|
Hello and thanks for the PR 👍🏻
|
Alkarex
reviewed
Jan 9, 2024
Alkarex
reviewed
Jan 9, 2024
3 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #2297
Changes proposed in this pull request:
We want to standardise flags used with CLI commands around the use of '-' rather than '_' while maintaining backward compatibility. To that end I've deprecated all flags using '_' in favour of an equivalent using '-' and introduced a check for the use of deprecated flags as well as logic to replace any used deprecated flags with their replacements. I've also scooped up some existing logic for CLI flag retrieval and validation and wrapped all this up into a parseCliParams() function. This way we can start to isolate some logic that otherwise is scattered throughout individual CLI commands.
If we're happy with the changes proposed here, then I could look at raising some related tickets such as extending use of parseCliParams() to other relevant CLI commands and looking at other opportunities for standardisation around validating CLI inputs as there is currently quite a bit of variation in how individual CLI commands handle similar work e.g. validating options associated with flags or updating config.
How to test the feature manually:
Use either cli/do-install, cli/reconfigure, cli/create-user or cli/update-user with updated flags (e.g. --default-user admin --allow-anonymous) to see successful behaviour.
Use deprecated flags (e.g. --default_user admin --allow_anonymous) to see successful behaviour with a deprecation warning.
Use unknown flags (e.g. --defaultuser admin --allow_anon)to trigger expected warning and failure.
Pull request checklist: