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

A dedicated rules command #440

Open
devnote-dev opened this issue Jan 4, 2024 · 1 comment
Open

A dedicated rules command #440

devnote-dev opened this issue Jan 4, 2024 · 1 comment
Labels

Comments

@devnote-dev
Copy link

This is more of an extension to #130 but implemented as a dedicated command. Most, if not all, Ameba rules have a comment describing the functionality of the rule, the YAML configuration key for the rule and code examples for some. Implementing these comments as part of the actual rules to be displayed in a dedicated command would help a lot with understanding how the rule works or what it's targeting.

For my specific use-case, it would help with identifying which rules are disabled by default so that I can enable them in the config instead of having to run ameba --all --except RulesThat,ShouldBe,Ignored. Ideally, a dedicated command to add all of these rules into the generated config file would be nice, but that's a separate issue.

@Sija
Copy link
Member

Sija commented Jan 18, 2024

There are --rules and --describe <rule-name> switches (see #390) that should alleviate your needs (at least to the certain degree) :)

Merit of #130 still holds and waits for a resolutions though.

@Sija Sija added the question label Jan 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants