elm-review <command...>

Arguments

NameDescription
commandfilepaths, folders

Subcommands

NameDescription
initInitialize Elm Review in this directory
suppressGenerate suppression files for rules that report many errors
new-packageCreates an new project aimed to contain rules and to be published later
new-ruleAdds a new rule to your review configuration or review package

Options

NameDescription
--help,-hShow help for elm-review
--unsuppressInclude suppressed errors in the error report for all rules
--rules <command...>Run with a subsection of the rules in the configuration. Specify them by their name, and separate them by commas
--watchRe-run elm-review automatically when your project or configuration changes
--watch-codeRe-run elm-review automatically when your project changes
--elmjson <command>Specify the path to the elm.json file of the project
--config <command>Use the review configuration in the specified directory
--template <command>Use the review configuration from a GitHub repository
--compiler <command>Specify the path to the elm compiler
--version,-vPrint the version of the elm-review CLI
--debugAdd helpful information to debug your configuration or rules
--report <command>Error reports will be in JSON format
--no-detailsHide the details from error reports for a more compact view
--ignore-dirs <command...>Ignore the reports of all rules for the specified directories
--ignore-files <command...>Ignore the reports of all rules for the specified files
--fixElm Review will present fixes for the errors that offer an automatic fix, which you can then accept or refuse one by one
--fix-allElm Review will present a single fix containing the application of all available automatic fixes, which you can then accept or refuse
--elm-format-path <command>Specify the path to elm-format