Skip to content

Make rule level name text all caps #133

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

Make rule level name text all caps #133

merged 1 commit into from
Dec 23, 2020

Conversation

per1234
Copy link
Contributor

@per1234 per1234 commented Dec 23, 2020

The rule level (e.g., error, warning) is an important component of the output because it provides the significance of the rule result. The previous all lower case text of the rule level names in the output made it not very visually prominent.


Before:

Linting sketch in C:\Users\per\go\src\github.com\arduino\arduino-lint\test\testdata\compliance\Permissive
Rule SS001 result: fail
error: Sketch file/folder name mismatch. The primary sketch file name must match the folder: Permissive.ino. See: https://arduino.github.io/arduino-cli/latest/sketch-specification/#primary-sketch-file
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

Finished linting project. Results:
Warning count: 1
Error count: 1
Rules passed: false

After:

Linting sketch in C:\Users\per\go\src\github.com\arduino\arduino-lint\test\testdata\compliance\Permissive
Rule SS001 result: fail
ERROR: Sketch file/folder name mismatch. The primary sketch file name must match the folder: Permissive.ino. See: https://arduino.github.io/arduino-cli/latest/sketch-specification/#primary-sketch-file
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

Finished linting project. Results:
Warning count: 1
Error count: 1
Rules passed: false

The rule level is an important component of the output because it provides the significance of the rule result. The
previous all lower case text of the rule level names in the output made it not very visually prominent.
@per1234 per1234 requested a review from ubidefeo December 23, 2020 05:14
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 6a36229 into main Dec 23, 2020
@per1234 per1234 deleted the per1234/rule-level-caps branch December 23, 2020 09:06
@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