Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add command to allow viewing any rules implemented by Chocolatey CLI or an extension #3381

Closed
2 tasks done
AdmiringWorm opened this issue Jan 15, 2024 · 0 comments · Fixed by #3382
Closed
2 tasks done
Assignees
Labels
4 - Done Feature Issues that introduce new functionality to the project, instead of updating existing functionality
Milestone

Comments

@AdmiringWorm
Copy link
Member

Checklist

  • I have verified this is the correct repository for opening this issue.
  • I have verified no other issues exist related to my request.

Is Your Feature Request Related To A Problem? Please describe.

No response

Describe The Solution. Why is it needed?

In Version 2.0.0 we implemented a service that can collect and run rules that are validated when a package is created.

As of right now, there is no visibility of what these rules are doing, and what they currently implement. As such, we should implement a command that can be used to list out any rules that are available, and to view the details of such a rule as well.

Additional Context

While this may be too helpful currently, there are plans in the future to implement something that will make such a rule command more useful (outside Chocolatey CLI).

To have this ability already implemented at that time makes it so that a user does not need to update Chocolatey CLI when these features are available.

Related Issues

No response

AdmiringWorm added a commit to AdmiringWorm/choco that referenced this issue Jan 15, 2024
This adds a new command called ´rule` with an alias of `rules` to be
able to view any Validation Rules that have been implemented by
Chocolatey CLI, or the details of a specific view.

This allows a user to see what is implemented when they are packaging
their Chocolatey CLI package. This is intended to be used in the future
to enhance other functionality.
AdmiringWorm added a commit to AdmiringWorm/choco that referenced this issue Jan 15, 2024
This adds a new command called ´rule` with an alias of `rules` to be
able to view any Validation Rules that have been implemented by
Chocolatey CLI, or the details of a specific view.

This allows a user to see what is implemented when they are packaging
their Chocolatey CLI package. This is intended to be used in the future
to enhance other functionality.
AdmiringWorm added a commit to AdmiringWorm/choco that referenced this issue Jan 15, 2024
This adds a new command called ´rule` with an alias of `rules` to be
able to view any Validation Rules that have been implemented by
Chocolatey CLI, or the details of a specific view.

This allows a user to see what is implemented when they are packaging
their Chocolatey CLI package. This is intended to be used in the future
to enhance other functionality.
AdmiringWorm added a commit to AdmiringWorm/choco that referenced this issue Jan 15, 2024
This adds a new command called ´rule` with an alias of `rules` to be
able to view any Validation Rules that have been implemented by
Chocolatey CLI, or the details of a specific view.

This allows a user to see what is implemented when they are packaging
their Chocolatey CLI package. This is intended to be used in the future
to enhance other functionality.
AdmiringWorm added a commit to AdmiringWorm/choco that referenced this issue Jan 26, 2024
This adds a new command called ´rule` with an alias of `rules` to be
able to view any Validation Rules that have been implemented by
Chocolatey CLI, or the details of a specific view.

This allows a user to see what is implemented when they are packaging
their Chocolatey CLI package. This is intended to be used in the future
to enhance other functionality.
AdmiringWorm added a commit to AdmiringWorm/choco that referenced this issue Jan 26, 2024
This adds a new command called ´rule` with an alias of `rules` to be
able to view any Validation Rules that have been implemented by
Chocolatey CLI, or the details of a specific view.

This allows a user to see what is implemented when they are packaging
their Chocolatey CLI package. This is intended to be used in the future
to enhance other functionality.
@AdmiringWorm AdmiringWorm self-assigned this Jan 26, 2024
@gep13 gep13 added this to the 2.3.0 milestone May 7, 2024
@gep13 gep13 added Feature Issues that introduce new functionality to the project, instead of updating existing functionality and removed FeatureParity labels May 7, 2024
gep13 pushed a commit to AdmiringWorm/choco that referenced this issue May 20, 2024
This adds a new command called ´rule` with an alias of `rules` to be
able to view any Validation Rules that have been implemented by
Chocolatey CLI, or the details of a specific view.

This allows a user to see what is implemented when they are packaging
their Chocolatey CLI package. This is intended to be used in the future
to enhance other functionality.
gep13 pushed a commit to AdmiringWorm/choco that referenced this issue May 21, 2024
This adds a new command called ´rule` with an alias of `rules` to be
able to view any Validation Rules that have been implemented by
Chocolatey CLI, or the details of a specific view.

This allows a user to see what is implemented when they are packaging
their Chocolatey CLI package. This is intended to be used in the future
to enhance other functionality.
gep13 added a commit that referenced this issue May 21, 2024
@gep13 gep13 added 4 - Done and removed 3 - Review labels May 21, 2024
gep13 added a commit that referenced this issue May 22, 2024
With the addition of the new choco rule command, we need to update the
tab completion to allow usage of the command.  This includes both the
new command name itself, as well as the options that are available to
the rule.
gep13 added a commit that referenced this issue May 22, 2024
This commit adds some Pester tests to ensure that the output for the
rule command, during tab expansion, works as expected.
gep13 added a commit to gep13/choco that referenced this issue May 24, 2024
The next release includes a new choco rule command, that allows
displaying information about the validation rules that are currently in
use by Chocolatey CLI.

This commit adds basic Pester tests for exercising this command, along
with its subcommands.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
4 - Done Feature Issues that introduce new functionality to the project, instead of updating existing functionality
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants