Skip to content

Commit 728b828

Browse files
committed
Show brief after rule ID in verbose text output
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.
1 parent a58dfe9 commit 728b828

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

Diff for: internal/rule/rule.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ func Runner(project project.Type) {
4848
}
4949

5050
// Output will be printed after all rules are finished when configured for "json" output format.
51-
feedback.VerbosePrintf("Running rule %s...\n", ruleConfiguration.ID)
51+
feedback.VerbosePrintf("Running rule %s (%s)...\n", ruleConfiguration.ID, ruleConfiguration.Brief)
5252

5353
ruleResult, ruleOutput := ruleConfiguration.RuleFunction()
5454
reportText := result.Results.Record(project, ruleConfiguration, ruleResult, ruleOutput)

0 commit comments

Comments
 (0)