From ea5abadfd7b53c8ebdfdfd674c8a0ec5105e082f Mon Sep 17 00:00:00 2001 From: samcx Date: Fri, 12 Apr 2024 17:40:37 -0400 Subject: [PATCH] docs(next-lint): update help output --- docs/02-app/02-api-reference/08-next-cli.mdx | 74 ++++++++++---------- 1 file changed, 36 insertions(+), 38 deletions(-) diff --git a/docs/02-app/02-api-reference/08-next-cli.mdx b/docs/02-app/02-api-reference/08-next-cli.mdx index 185c91e45396b..e33a96e7648c4 100644 --- a/docs/02-app/02-api-reference/08-next-cli.mdx +++ b/docs/02-app/02-api-reference/08-next-cli.mdx @@ -357,48 +357,46 @@ The output should look like this: ```bash filename="Terminal" Usage: next lint [directory] [options] -Runs ESLint for all files in the `/src`, `/app`, `/pages`, `/components`, and `/lib` -directories. It also provides a guided setup to install any required dependencies if ESLint -is not already configured in your application. +Runs ESLint for all files in the `/src`, `/app`, `/pages`, `/components`, and `/lib` directories. It also +provides a guided setup to install any required dependencies if ESLint is not already configured in your +application. Arguments: - [directory] A base directory on which to lint the application. - If no directory is provided, the current - directory will be used. + [directory] A base directory on which to lint the application. + If no directory is provided, the current directory + will be used. Options: - -d, --dir, Include directory, or directories, to run ESLint. - --file, Include file, or files, to run ESLint. - --ext, [exts...] Specify JavaScript file extensions. (default: - [".js", ".mjs", ".cjs", ".jsx", ".ts", ".mts", ".cts", ".ts -x"]) - -c, --config, Uses this configuration file, overriding all other - configuration options. - --resolve-plugins-relative-to, Specify a directory where plugins should be - resolved from. - --strict Creates a `.eslintrc.json` file using the Next.js - strict configuration. - --rulesdir, Uses additional rules from this directory(s). - --fix Automatically fix linting issues. - --fix-type Specify the types of fixes to apply (e.g., problem, - suggestion, layout). - --ignore-path Specify a file to ignore. - --no-ignore Disables the `--ignore-path` option. - --quiet Reports errors only. - --max-warnings [maxWarnings] Specify the number of warnings before triggering a - non-zero exit code. (default: -1) - -o, --output-file, Specify a file to write report to. - -f, --format, Uses a specifc output format. - --no-inline-config Prevents comments from changing config or rules. - --report-unused-disable-directives Adds reprted errors for unused eslint-disable - directives. - --no-cache Disables caching. - --cache-location, Specify a location for cache. - --cache-strategy, [cacheStrategy] Specify a strategy to use for detecting changed - files in the cache. (default: "metadata") - --error-on-unmatched-pattern Reports errors when any file patterns are - unmatched. - -h, --help Displays this message. + -d, --dir, Include directory, or directories, to run ESLint. + --file, Include file, or files, to run ESLint. + --ext, [exts...] Specify JavaScript file extensions. (default: + [".js", ".mjs", ".cjs", ".jsx", ".ts", ".mts", ".cts", ".tsx"]) + -c, --config, Uses this configuration file, overriding all other + configuration options. + --resolve-plugins-relative-to, Specify a directory where plugins should be resolved + from. + --strict Creates a `.eslintrc.json` file using the Next.js + strict configuration. + --rulesdir, Uses additional rules from this directory(s). + --fix Automatically fix linting issues. + --fix-type Specify the types of fixes to apply (e.g., problem, + suggestion, layout). + --ignore-path Specify a file to ignore. + --no-ignore Disables the `--ignore-path` option. + --quiet Reports errors only. + --max-warnings [maxWarnings] Specify the number of warnings before triggering a + non-zero exit code. (default: -1) + -o, --output-file, Specify a file to write report to. + -f, --format, Uses a specifc output format. + --no-inline-config Prevents comments from changing config or rules. + --report-unused-disable-directives-severity Specify severity level for unused eslint-disable + directives. (choices: "error", "off", "warn") + --no-cache Disables caching. + --cache-location, Specify a location for cache. + --cache-strategy, [cacheStrategy] Specify a strategy to use for detecting changed files + in the cache. (default: "metadata") + --error-on-unmatched-pattern Reports errors when any file patterns are unmatched. + -h, --help Displays this message. ``` If you have other directories that you would like to lint, you can specify them using the `--dir` flag: