feat: enable strict mode for command-line arguments #332
Conversation
This file contains hidden or 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
According to the docs: > Any command-line argument given that is not demanded, or does not have a corresponding description, will be reported as an error. > Unrecognized commands will also be reported as errors. This solves the use-cases when a user passes an non-existent parameter and neonctl, continuing to work, Example: ``` node dist project update --project-id super-base-59043008 --name "Chaporgin-Chaporgin-Chaporgin1" --block-public-connections 1 ERROR: Unknown arguments: project-id, projectId node dist project update --project-id super-base-59043008 --name "Chaporgin-Chaporgin-Chaporgin1" --block-public-connections 1 ERROR: Unknown arguments: project-id, projectId neonctl project update --project-id super-base-59043008 --name "Chaporgin-Chaporgin-Chaporgin1" --block-public-connections 1 ``` Expected: ``` Error: parameter project-id does not exist ``` Actual: ``` ERROR: The request could not be authorized due to an internal error ``` This fixes that with the following examples: ``` node dist project update super-base-59043008 --name "Chaporgin-Chaporgin-Chaporgin1" --block-public-connections yes ERROR: Unknown command: yes node dist project update super-base-59043008 --name "Chaporgin-Chaporgin-Chaporgin1" --block-public-connections true ┌─────────────────────┬────────────────────────────────┬──────────────────┬──────────────────────┐ │ Id │ Name │ Region Id │ Created At │ ├─────────────────────┼────────────────────────────────┼──────────────────┼──────────────────────┤ │ super-base-59043008 │ Chaporgin-Chaporgin-Chaporgin1 │ aws-eu-central-1 │ 2025-01-22T15:30:36Z │ └─────────────────────┴────────────────────────────────┴──────────────────┴──────────────────────┘ ``` As you can see, still not perfect, see the first line: ERROR: Unknown arguments: project-id, projectId they do provide you with a hint, `project-id` is indeed missing, but for a complex misconfigured commands it will be hard to fix them by looking at the error message `ERROR: Unknown arguments: project-id, projectId`. This, being a backward incompatible change might break workflows for the people. I have no good idea how to solve it.
neonctl-semantic-release
bot
force-pushed
the
main
branch
from
e373afc to
67e3eb4
Compare
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.
BACKWARD COMPATIBILITY BREAKING.
According to the docs:
This solves the use cases when a user passes a non-existent parameter and
neonctl, continuing to work,Example:
Expected:
Actual:
This fixes that with the following examples:
As you can see, it is still not perfect; see the first line:
ERROR: Unknown arguments: project-id, projectIdThey provide you with a hint,
project-idis indeed missing, but for complex misconfigured commands, it will be hard to fix them by looking at the error messageERROR: Unknown arguments: project-id, projectId.This, being a backward incompatible change, might break workflows for the people.
I have no idea how to release this, because it breaks backward compatibility.