Subcommands4 subcommands
elm-review init
Initialize Elm Review in this directory
elm-review suppress
Generate suppression files for rules that report many errors
elm-review new-package
Creates an new project aimed to contain rules and to be published later
elm-review new-rule
Adds a new rule to your review configuration or review package
OptionsOn elm-review itself
--help-h
Show help for elm-review
--unsuppress
Include suppressed errors in the error report for all rules
--rules
Run with a subsection of the rules in the configuration. Specify them by their name, and separate them by commas <<rule1,rule2,...>>
--watch
Re-run elm-review automatically when your project or configuration changes
--watch-code
Re-run elm-review automatically when your project changes
--elmjson
Specify the path to the elm.json file of the project <<path-to-elm.json>>
--config
Use the review configuration in the specified directory <<path-to-review-directory>>
--template
Use the review configuration from a GitHub repository <<author>/<repo>[/path-to-the-config-folder][#branch-or-commit]>
--compiler
Specify the path to the elm compiler <<path-to-elm>>
--version-v
Print the version of the elm-review CLI
--debug
Add helpful information to debug your configuration or rules
--report
Error reports will be in JSON format <json or ndjson>
--no-details
Hide the details from error reports for a more compact view
--ignore-dirs
Ignore the reports of all rules for the specified directories <<dir1,dir2,...>>
--ignore-files
Ignore the reports of all rules for the specified files <<file1,file2,...>>
--fix
Elm Review will present fixes for the errors that offer an automatic fix, which you can then accept or refuse one by one
--fix-all
Elm Review will present a single fix containing the application of all available automatic fixes, which you can then accept or refuse
--elm-format-path
Specify the path to elm-format <<path-to-elm-format>>
--fix-limit
Limit the number of fixes applied in a single batch to N <N>
--extract
Enable extracting data from the project for the rules that have a data extractor. Requires running with --report=json. Learn more by reading the section about "Extracting information" at https://bit.ly/3UmNr0V
--benchmark-info
Print out how much time it took for rules and phases of the process to run. This is meant for benchmarking purposes
--no-color
Disable colors in the output
