Skip to content

Show brief after rule ID in verbose text output #132

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

Merged
merged 1 commit into from
Dec 23, 2020
Merged

Conversation

per1234
Copy link
Contributor

@per1234 per1234 commented Dec 23, 2020

The rule brief is a short description of the rule. When arduino-lint is run in --verbose mode, the ID of each rule is
displayed. While this serves to show the progress of linting each project, the user will not know the significance of
these IDs, and previously wouldn't get any other context unless the rule was violated (in which case the failure message
is displayed), so it is somewhat cryptic.

Displaying the brief after the rule ID explains the rules that are being run without increasing the volume of output significantly.


Before:

Running rule SC001...
Rule SC001 result: pass
Running rule SD001...
Rule SD001 result: fail
warning: No readme found. Please document your sketch. See: https://docs.github.com/en/free-pro-team@latest/github/creating-cloning-and-archiving-repositories/about-readmes
Running rule SM001...
Rule SM001 result: skipped
notice: No metadata file

After:

Running rule SC001 (incorrect Arduino.h case)...
Rule SC001 result: pass
Running rule SD001 (no readme)...
Rule SD001 result: fail
warning: No readme found. Please document your sketch. See: https://docs.github.com/en/free-pro-team@latest/github/creating-cloning-and-archiving-repositories/about-readmes
Running rule SM001 (invalid sketch.json JSON format)...
Rule SM001 result: skipped
notice: No metadata file

Note: The wording of the rule briefs will be improved by #130 (d4c5e9c) to be more suitable for this application, but those improvements won't take effect until #130 is merged. This PR only implements the mechanics of displaying the rule brief text.

The rule brief is a short description of the rule. When arduino-lint is run in `--verbose` mode, the ID of each rule is
displayed. While this serves to show the progress of linting each project, the user will not know the significance of
these IDs, and previously wouldn't get any other context unless the rule was violated (in which case the failure message
is displayed), so it is somewhat cryptic  Displaying the brief after the rule ID explains the rules that are being run
without increasing the volume of output significantly.
@per1234 per1234 requested a review from ubidefeo December 23, 2020 05:04
Copy link
Contributor

@ubidefeo ubidefeo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@per1234 per1234 merged commit 06da0e7 into main Dec 23, 2020
@per1234 per1234 deleted the per1234/show-brief branch December 23, 2020 09:09
@per1234 per1234 added topic: code Related to content of the project itself type: enhancement Proposed improvement labels Sep 29, 2021
@per1234 per1234 self-assigned this Nov 20, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: code Related to content of the project itself type: enhancement Proposed improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants