feat(commands/config.ts): add support for 'describe' mode to print detailed help for config parameters #470
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
…tailed help for config parameters fix(commands/config.ts): improve error handling for 'get' and 'set' modes when no config keys are provided The changes in this commit add a new 'describe' mode to the config command, which allows users to get detailed information about the available configuration parameters. This includes a description of each parameter and the accepted values. The 'describe' mode can be used in two ways: 1. To print help for all available config parameters: ``` oco config describe ``` 2. To print help for specific config parameters: ``` oco config describe OCO_MODEL OCO_API_KEY ``` Additionally, the commit fixes the error handling for the 'get' and 'set' modes, ensuring that an error is thrown if no config keys are provided. These changes improve the usability and discoverability of the configuration system, making it easier for users to understand and manage their opencommit settings.
… section refactor(config.ts): improve config key descriptions and add default values
|
@benleibowitz hi, sorry, you should be merging to master directly, i know contributions guide tell to merge to dev, but i forgot to update it, people 99% never read it and merge to master anyway, so i aligned to how they do it. now master is the base of all PRs, i then try to ship a new version each month |
|
Sure, let me send out a new PR off of master. |
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.
Summary
feat(commands/config.ts): add support for 'describe' mode to print detailed help for config parameters
fix(commands/config.ts): improve error handling for
getandsetmodes when no config keys are providedChanges
The changes in this commit add a new
describemode to the config command, which allows users to get detailed information about the available configuration parameters. This includes a description of each parameter and the accepted values.The
describemode can be used in two ways:To print help for all available config parameters:
oco config describeTo print help for specific config parameters:
oco config describe OCO_MODEL OCO_API_KEYAdditionally, the commit fixes the error handling for the
getandsetmodes, ensuring that an error is thrown if no config keys are provided.These changes improve the usability and discoverability of the configuration system, making it easier for users to understand and manage their opencommit settings.
Example Usage