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.

Sign up for GitHub

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

Jump to bottom

List available rules and their description #37

Closed
mkindahl opened this issue Oct 17, 2023 · 0 comments · Fixed by #39 or #32
Closed

List available rules and their description #37

mkindahl opened this issue Oct 17, 2023 · 0 comments · Fixed by #39 or #32
Assignees
@mkindahl
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@mkindahl
Copy link
Collaborator

mkindahl commented Oct 17, 2023 •
edited
Loading

Since it is not clear what rules are available it would be good to have an option to list rules and their descriptions, something like

timescale-doctor --list=* --show=brief

Option --list would take a glob pattern to match the rules to list, so * here means match all (and would be the default).

Option --show would select how much to show for each rule: just the description, brief or detailed messages, or even the query.
@mkindahl mkindahl added enhancement New feature or request good first issue Good for newcomers labels Oct 23, 2023
mkindahl added a commit to mkindahl/doctor that referenced this issue Oct 26, 2023
@mkindahl
feat: add options to list rules
5e9af63 
The option `--list` is added that allow you to list rules matching a
pattern and the option `--show` is present that allow you to pick the
level of detail that you want to show for each rule.

Fixes timescale#37
@mkindahl mkindahl mentioned this issue Oct 26, 2023
Merged
@mkindahl mkindahl self-assigned this Oct 29, 2023
mkindahl added a commit to mkindahl/doctor that referenced this issue Nov 2, 2023
@mkindahl
feat: add options to list rules
b5e6f82 
The option `--list` is added that allow you to list rules matching a
pattern and the option `--show` is present that allow you to pick the
level of detail that you want to show for each rule.

Fixes timescale#37
mkindahl added a commit that referenced this issue Nov 2, 2023
@mkindahl
feat: add options to list rules
8e8a6b1 
The option `--list` is added that allow you to list rules matching a
pattern and the option `--show` is present that allow you to pick the
level of detail that you want to show for each rule.

Fixes #37
@github-actions github-actions bot mentioned this issue Nov 2, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@mkindahl mkindahl

Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat: add options to list rules mkindahl/doctor
chore(main): release 0.2.0 timescale/doctor
1 participant
@mkindahl