Skip to content

Commit c19c3e3

Browse files
committed
Update command line help to reflect check->lint terminology change
Some output messages were not switched over when the tool name and associated terminology was changed to using "lint"/"rule" in place of "check".
1 parent b7278c3 commit c19c3e3

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

Diff for: internal/cli/cli.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -27,15 +27,15 @@ func Root() *cobra.Command {
2727
Short: "Linter for Arduino projects.",
2828
Long: "arduino-lint checks for specification compliance and other common problems with Arduino projects",
2929
DisableFlagsInUseLine: true,
30-
Use: "arduino-lint [FLAG]... [PROJECT_PATH]...\n\nRun rules on PROJECT_PATH or current path if no PROJECT_PATH argument provided.",
30+
Use: "arduino-lint [FLAG]... [PROJECT_PATH]...\n\nLint project in PROJECT_PATH or current path if no PROJECT_PATH argument provided.",
3131
Run: command.ArduinoLint,
3232
}
3333

3434
rootCommand.PersistentFlags().String("compliance", "specification", "Configure how strict the tool is. Can be {strict|specification|permissive}")
3535
rootCommand.PersistentFlags().String("format", "text", "The output format can be {text|json}.")
3636
rootCommand.PersistentFlags().String("library-manager", "", "Configure the rules for libraries in the Arduino Library Manager index. Can be {submit|update|false}.\nsubmit: Also run additional rules required to pass before a library is accepted for inclusion in the index.\nupdate: Also run additional rules required to pass before new releases of a library already in the index are accepted.\nfalse: Don't run any Library Manager-specific rules.")
37-
rootCommand.PersistentFlags().String("project-type", "all", "Only check projects of the specified type and their subprojects. Can be {sketch|library|platform|all}.")
38-
rootCommand.PersistentFlags().Bool("recursive", false, "Search path recursively for Arduino projects to check. Can be {true|false}.")
37+
rootCommand.PersistentFlags().String("project-type", "all", "Only lint projects of the specified type and their subprojects. Can be {sketch|library|platform|all}.")
38+
rootCommand.PersistentFlags().Bool("recursive", false, "Search path recursively for Arduino projects to lint. Can be {true|false}.")
3939
rootCommand.PersistentFlags().String("report-file", "", "Save a report on the rules to this file.")
4040
rootCommand.PersistentFlags().BoolP("verbose", "v", false, "Show more information while running rules.")
4141
rootCommand.PersistentFlags().Bool("version", false, "Print version and timestamp of the build.")

0 commit comments

Comments
 (0)