Skip to content

Update command line help to reflect check->lint terminology change #147

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

Merged
merged 1 commit into from
Jan 11, 2021
Merged

Update command line help to reflect check->lint terminology change #147

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions internal/cli/cli.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,15 +27,15 @@ func Root() *cobra.Command {
Short: "Linter for Arduino projects.",
Long: "arduino-lint checks for specification compliance and other common problems with Arduino projects",
DisableFlagsInUseLine: true,
Use: "arduino-lint [FLAG]... [PROJECT_PATH]...\n\nRun rules on PROJECT_PATH or current path if no PROJECT_PATH argument provided.",
Use: "arduino-lint [FLAG]... [PROJECT_PATH]...\n\nLint project in PROJECT_PATH or current path if no PROJECT_PATH argument provided.",
Run: command.ArduinoLint,
}

rootCommand.PersistentFlags().String("compliance", "specification", "Configure how strict the tool is. Can be {strict|specification|permissive}")
rootCommand.PersistentFlags().String("format", "text", "The output format can be {text|json}.")
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.")
rootCommand.PersistentFlags().String("project-type", "all", "Only check projects of the specified type and their subprojects. Can be {sketch|library|platform|all}.")
rootCommand.PersistentFlags().Bool("recursive", false, "Search path recursively for Arduino projects to check. Can be {true|false}.")
rootCommand.PersistentFlags().String("project-type", "all", "Only lint projects of the specified type and their subprojects. Can be {sketch|library|platform|all}.")
rootCommand.PersistentFlags().Bool("recursive", false, "Search path recursively for Arduino projects to lint. Can be {true|false}.")
rootCommand.PersistentFlags().String("report-file", "", "Save a report on the rules to this file.")
rootCommand.PersistentFlags().BoolP("verbose", "v", false, "Show more information while running rules.")
rootCommand.PersistentFlags().Bool("version", false, "Print version and timestamp of the build.")
Expand Down