|
1 | | -Usage: [--project PROJECT] [--module MODULE] [--app APP] [--file FILE] [--rebar] [--as PROFILE] [--include-generated] [--include-tests] [--no-diags] [[--format FORMAT]] [--include-erlc-diagnostics] [--include-ct-diagnostics] [--include-edoc-diagnostics] [--include-eqwalizer-diagnostics] [--include-suppressed] [--use-cli-severity] [--diagnostic-ignore CODE] [--diagnostic-filter CODE] [--experimental] [--read-config] [--config-file CONFIG_FILE] [--apply-fix] [--ignore-fix-only] [--in-place] [--to TO] [--recursive] [--with-check] [--check-eqwalize-all] [--one-shot] [--report-system-stats] [--no-stream] <IGNORED_APPS>... |
| 1 | +Usage: [--project PROJECT] [--module MODULE] [--app APP] [--file FILE] [--rebar] [--as PROFILE] |
| 2 | +[--include-generated] [--include-tests] [--no-diags] [[--format FORMAT]] [--include-erlc-diagnostics] |
| 3 | +[--include-ct-diagnostics] [--include-edoc-diagnostics] [--include-eqwalizer-diagnostics] |
| 4 | +[--include-suppressed] [--use-cli-severity] [--diagnostic-ignore CODE] [--diagnostic-filter CODE] |
| 5 | +[--experimental] [--read-config] [--config-file CONFIG_FILE] [--apply-fix] [--ignore-fix-only] |
| 6 | +[--in-place] [--to TO] [--recursive] [--with-check] [--check-eqwalize-all] [--one-shot] |
| 7 | +[--report-system-stats] [--no-stream] <IGNORED_APPS>... |
2 | 8 |
|
3 | 9 | Available positional items: |
4 | 10 | <IGNORED_APPS> Rest of args are space separated list of apps to ignore |
5 | 11 |
|
6 | 12 | Available options: |
7 | | - --project <PROJECT> Path to directory with project, or to a JSON file (defaults to `.`) |
8 | | - --module <MODULE> Parse a single module from the project, not the entire project. |
9 | | - --app <APP> Parse a single application from the project, not the entire project. |
10 | | - --file <FILE> Parse a single file from the project, not the entire project. This can be an include file or escript, etc. |
11 | | - --rebar Run with rebar |
12 | | - --as <PROFILE> Rebar3 profile to pickup (default is test) |
13 | | - --include-generated Also generate diagnostics for generated files |
14 | | - --include-tests Also generate diagnostics for test files |
15 | | - --no-diags Do not print the full diagnostics for a file, just the count |
16 | | - --format <FORMAT> Show diagnostics in JSON format |
17 | | - --include-erlc-diagnostics Include diagnostics produced by erlc |
18 | | - --include-ct-diagnostics Deprecated (no-op): Common Test diagnostics are now always included |
19 | | - --include-edoc-diagnostics Include EDoc diagnostics |
| 13 | + --project <PROJECT> Path to directory with project, or to a JSON file (defaults to `.`) |
| 14 | + --module <MODULE> Parse a single module from the project, not the entire project. |
| 15 | + --app <APP> Parse a single application from the project, not the entire project. |
| 16 | + --file <FILE> Parse a single file from the project, not the entire project. This can be an |
| 17 | + include file or escript, etc. |
| 18 | + --rebar Run with rebar |
| 19 | + --as <PROFILE> Rebar3 profile to pickup (default is test) |
| 20 | + --include-generated Also generate diagnostics for generated files |
| 21 | + --include-tests Also generate diagnostics for test files |
| 22 | + --no-diags Do not print the full diagnostics for a file, just the count |
| 23 | + --format <FORMAT> Show diagnostics in JSON format |
| 24 | + --include-erlc-diagnostics Include diagnostics produced by erlc |
| 25 | + --include-ct-diagnostics Deprecated (no-op): Common Test diagnostics are now always included |
| 26 | + --include-edoc-diagnostics Include EDoc diagnostics |
20 | 27 | --include-eqwalizer-diagnostics Include Eqwalizer diagnostics |
21 | | - --include-suppressed Include Suppressed diagnostics (e.g. elp:fixme) |
22 | | - --use-cli-severity If specified, use the provided CLI severity mapping instead of the default one |
23 | | - --diagnostic-ignore <CODE> Ignore the specified diagnostic, by code or label |
24 | | - --diagnostic-filter <CODE> Filter out all reported diagnostics except this one, by code or label |
25 | | - --experimental Report experimental diagnostics too, if diagnostics are enabled |
26 | | - --read-config Get some configuration from a .elp_lint.toml file instead in the project root |
27 | | - --config-file <CONFIG_FILE> Override normal configuration file. When set, acts as if READ_CONFIG is true. |
28 | | - --apply-fix If the diagnostic has an associated fix, apply it. Modifies the original file. Use --to to write to a different directory. |
29 | | - --ignore-fix-only Only apply elp:ignore fixes |
30 | | - --in-place Deprecated: in-place is now the default behavior. This flag will be removed in a future release. |
31 | | - --to <TO> When applying a fix, put the results in this directory path |
32 | | - --recursive If applying fixes, apply any new ones that arise from the |
33 | | - prior fixes recursively. Limited in scope to the clause of the |
34 | | - prior change. |
35 | | - --with-check After applying a fix step, check that the diagnostics are clear, else roll back |
36 | | - --check-eqwalize-all After applying a fix step, check that all eqwalizer project diagnostics are clear, else roll back |
37 | | - --one-shot Apply to all matching diagnostic occurrences at once, rather |
38 | | - than one at a time. |
39 | | - --report-system-stats Report system memory usage and other statistics |
40 | | - --no-stream Disable streaming of diagnostics when applying fixes (collect all before printing) |
41 | | - -h, --help Prints help information |
| 28 | + --include-suppressed Include Suppressed diagnostics (e.g. elp:fixme) |
| 29 | + --use-cli-severity If specified, use the provided CLI severity mapping instead of the |
| 30 | + default one |
| 31 | + --diagnostic-ignore <CODE> Ignore the specified diagnostic, by code or label |
| 32 | + --diagnostic-filter <CODE> Filter out all reported diagnostics except this one, by code or |
| 33 | + label |
| 34 | + --experimental Report experimental diagnostics too, if diagnostics are enabled |
| 35 | + --read-config Get some configuration from a .elp_lint.toml file instead in the project |
| 36 | + root |
| 37 | + --config-file <CONFIG_FILE> Override normal configuration file. When set, acts as if |
| 38 | + READ_CONFIG is true. |
| 39 | + --apply-fix If the diagnostic has an associated fix, apply it. Modifies the original |
| 40 | + file. Use --to to write to a different directory. |
| 41 | + --ignore-fix-only Only apply elp:ignore fixes |
| 42 | + --in-place Deprecated: in-place is now the default behavior. This flag will be removed |
| 43 | + in a future release. |
| 44 | + --to <TO> When applying a fix, put the results in this directory path |
| 45 | + --recursive If applying fixes, apply any new ones that arise from the prior fixes |
| 46 | + recursively. Limited in scope to the clause of the prior change. |
| 47 | + --with-check After applying a fix step, check that the diagnostics are clear, else roll |
| 48 | + back |
| 49 | + --check-eqwalize-all After applying a fix step, check that all eqwalizer project diagnostics |
| 50 | + are clear, else roll back |
| 51 | + --one-shot Apply to all matching diagnostic occurrences at once, rather than one at a |
| 52 | + time. |
| 53 | + --report-system-stats Report system memory usage and other statistics |
| 54 | + --no-stream Disable streaming of diagnostics when applying fixes (collect all before |
| 55 | + printing) |
| 56 | + -h, --help Prints help information |
0 commit comments