(#3700) Overhaul ChocolateyTabExpansion.ps1 #3701
Merged
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
This commit attempts to apply some clear organisation to the ChocolateyTabExpansion.ps1 file by using alphabetical orderding, both in terms of the commands that are listed out, as well as the options that are passed into commands. This will hopefully make this file easier to update, and to see what options are applied where.
Using a newly created spreadsheet which lists all the command/subcommands/options for Chocolatey CLI, update the ChocolateyTabExpansion.ps1 file to use this "source of truth". This includes adding missing commands/subcommands/options where required. In addition, the new default option for each command is applied, and these will be used elsewhere going forward, i.e. in our documentation, so that we can start to get some consistency. In addition, changes were made to the settings.json file for VSCode, so that known words would not cause "Problems" to be reported when editting the file.
Now that all the commands/subcommands/options have been updated in the main ChocolateyTabExpansion.ps1 file, the corresponding tests have had to be updated/added to use them.
|
Awesome work on getting this updated @gep13. |
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.
Description Of Changes
Using a newly created spreadsheet which lists all the
command/subcommands/options for Chocolatey CLI, update the
ChocolateyTabExpansion.ps1 file to use this "source of truth". This
includes adding missing commands/subcommands/options where required. In
addition, the new default option for each command is applied, and these
will be used elsewhere going forward, i.e. in our documentation, so that
we can start to get some consistency.
Motivation and Context
We need to ensure consistency across Chocolatey CLI's "API", and this is a first
pass at getting to a known set of command/subcommands/options for tab
completion, and once this is rolled out, these default options will flow into
our documentation.
Testing
We will complete a Test-Kitchen execution on this PR branch to ensure everything works as expected.
Operating Systems Testing
Windows 11
Change Types Made
Change Checklist
Related Issue
Fixes #3700