Spec-Zone.ru › ESLint

Справочник по командной строке

Интерфейс ESLint командной строки (CLI) позволяет выполнять проверки кода из терминала. CLI имеет множество опций, которые можно передать для настройки ESLint.

Запуск CLI

ESLint требует Node.js для установки. Следуйте инструкциям в Руководстве по началу работы для установки ESLint.

Большинство пользователей используют npx для запуска ESLint в командной строке, например:

npx eslint [options] [file|dir|glob]*

Например:

# Run on two files
npx eslint file1.js file2.js

# Run on multiple files
npx eslint lib/**

Обратите внимание, что при передаче шаблона (glob) в качестве параметра, он расширяется вашей оболочкой. Результаты расширения могут различаться в зависимости от вашей оболочки и её настроек. Если вы хотите использовать синтаксис node glob , вам необходимо заключить параметр в кавычки (используйте двойные кавычки, если вам нужно, чтобы это работало в Windows), как показано ниже:

npx eslint "lib/**"

Если вы используете плоский файл конфигурации (eslint.config.js), вы также можете опустить аргументы файла, и ESLint будет использовать .. Например, эти две строки выполняют одинаковую операцию:

npx eslint .
npx eslint

Если вы не используете плоский файл конфигурации, запуск ESLint без аргументов файла приводит к ошибке.

Примечание: Вы также можете использовать альтернативные менеджеры пакетов, такие как Yarn или pnpm для запуска ESLint. Для pnpm используйте pnpm dlx eslint, а для Yarn – yarn dlx eslint.

Передача нескольких значений одной опции

Опции, принимающие несколько значений, можно указать, повторив опцию или с помощью списка, разделенного запятыми (кроме --ignore-pattern, который не допускает второй стиль).

Примеры опций, принимающих несколько значений:

npx eslint --global describe --global it tests/
# OR
npx eslint --global describe,it tests/

Опции

Вы можете просмотреть все опции CLI, выполнив npx eslint -h.

eslint [options] file.js [file.js] [dir]

Basic configuration:
  --no-config-lookup              Disable look up for eslint.config.js
  -c, --config path::String       Use this configuration instead of eslint.config.js, eslint.config.mjs, or
                                  eslint.config.cjs
  --inspect-config                Open the config inspector with the current configuration
  --global [String]               Define global variables
  --parser String                 Specify the parser to be used
  --parser-options Object         Specify parser options

Specify Rules and Plugins:
  --plugin [String]               Specify plugins
  --rule Object                   Specify rules

Fix Problems:
  --fix                           Automatically fix problems
  --fix-dry-run                   Automatically fix problems without saving the changes to the file system
  --fix-type Array                Specify the types of fixes to apply (directive, problem, suggestion, layout)

Ignore Files:
  --no-ignore                     Disable use of ignore files and patterns
  --ignore-pattern [String]       Patterns of files to ignore

Use stdin:
  --stdin                         Lint code provided on <STDIN> - default: false
  --stdin-filename String         Specify filename to process STDIN as

Handle Warnings:
  --quiet                         Report errors only - default: false
  --max-warnings Int              Number of warnings to trigger nonzero exit code - default: -1

Output:
  -o, --output-file path::String  Specify file to write report to
  -f, --format String             Use a specific output format - default: stylish
  --color, --no-color             Force enabling/disabling of color

Inline configuration comments:
  --no-inline-config              Prevent comments from changing config or rules
  --report-unused-disable-directives  Adds reported errors for unused eslint-disable and eslint-enable directives
  --report-unused-disable-directives-severity String  Chooses severity level for reporting unused eslint-disable and
                                                      eslint-enable directives - either: off, warn, error, 0, 1, or 2

Caching:
  --cache                         Only check changed files - default: false
  --cache-file path::String       Path to the cache file. Deprecated: use --cache-location - default: .eslintcache
  --cache-location path::String   Path to the cache file or directory
  --cache-strategy String         Strategy to use for detecting changed files in the cache - either: metadata or
                                  content - default: metadata

Miscellaneous:
  --init                          Run config initialization wizard - default: false
  --env-info                      Output execution environment information - default: false
  --no-error-on-unmatched-pattern  Prevent errors when pattern is unmatched
  --exit-on-fatal-error           Exit with exit code 2 in case of fatal error - default: false
  --no-warn-ignored               Suppress warnings when the file list includes ignored files
  --pass-on-no-patterns           Exit with exit code 0 in case no file patterns are passed
  --debug                         Output debugging information
  -h, --help                      Show help
  -v, --version                   Output the version number
  --print-config path::String     Print the configuration for the given file
  --stats                         Add statistics to the lint report - default: false
  --flag [String]                 Enable a feature flag

Базовая настройка

--no-eslintrc

Только режим eslintrc. Отключает использование конфигурации из файлов .eslintrc.* и package.json. Для режима плоской конфигурации используйте --no-config-lookup вместо этого.

  • Тип аргумента: Нет аргумента.
--no-eslintrc пример
npx eslint --no-eslintrc file.js

-c, --config

Эта опция позволяет указать дополнительный файл конфигурации для ESLint (см. Настройка ESLint для получения дополнительной информации).

  • Тип аргумента: Строка. Путь к файлу.
  • Несколько аргументов: Нет
-c, --config пример
npx eslint -c ~/my.eslint.config.js file.js

Этот пример использует файл конфигурации по адресу ~/my.eslint.config.js, который используется вместо поиска файла eslint.config.js.

--inspect-config

Только режим плоской конфигурации. Эта опция запускает npx @eslint/config-inspector@latest для запуска инспектора конфигурации. Вы можете использовать инспектор конфигурации, чтобы лучше понять, что делает ваша конфигурация и к каким файлам она применяется. Когда вы используете этот флаг, CLI не выполняет проверку кода.

  • Тип аргумента: Нет аргумента.
--inspect-config пример
npx eslint --inspect-config

--env

Только режим eslintrc. Эта опция включает определённые среды.

  • Тип аргумента: Строка. Одно из доступных сред.
  • Несколько аргументов: Да

Подробности о глобальных переменных, определённых каждой средой, доступны в документации Определение сред. Эта опция только включает среды. Она не отключает среды, установленные в других файлах конфигурации. Для указания нескольких сред разделяйте их запятыми или используйте опцию несколько раз.

--env пример
npx eslint --env browser,node file.js
npx eslint --env browser --env node file.js

--ext

Только режим eslintrc. Если вы используете плоскую конфигурацию (eslint.config.js), пожалуйста, ознакомьтесь с руководством по миграции.

Эта опция позволяет указать расширения файлов, которые ESLint использует при поиске целевых файлов в указанных директориях.

  • Тип аргумента: Строка. Расширение файла.
  • Несколько аргументов: Да
  • Значение по умолчанию: .js и файлы, которые соответствуют overrides записям вашей конфигурации.

--ext используется только тогда, когда шаблоны для проверки – это директории. Если вы используете шаблоны glob или имена файлов, то --ext игнорируется. Например, npx eslint "lib/*" --ext .js соответствует всем файлам в директории lib/, независимо от расширения.

--ext пример
# Use only .ts extension
npx eslint . --ext .ts

# Use both .js and .ts
npx eslint . --ext .js --ext .ts

# Also use both .js and .ts
npx eslint . --ext .js,.ts

--global

Эта опция определяет глобальные переменные, чтобы они не отмечались как неопределённые правилом no-undef.

  • Тип аргумента: Строка. Имя глобальной переменной. Любые указанные глобальные переменные по умолчанию считаются неизменяемыми, но добавление :true к имени переменной гарантирует, что no-undef также разрешает записи.
  • Несколько аргументов: Да
--global пример
npx eslint --global require,exports:true file.js
npx eslint --global require --global exports:true

--parser

Эта опция позволяет указать парсер, который будет использоваться ESLint.

  • Тип аргумента: Строка. Парсер, который будет использоваться ESLint.
  • Несколько аргументов: Нет
  • Значение по умолчанию: espree
--parser пример
# Use TypeScript ESLint parser
npx eslint --parser @typescript-eslint/parser file.ts

--parser-options

Эта опция позволяет указать параметры парсера, которые будут использоваться ESLint. Доступные параметры парсера определяются используемым парсером.

  • Тип аргумента: Пара ключ/значение, разделённые двоеточием (:).
  • Несколько аргументов: Да
--parser-options пример
echo '3 ** 4' | npx eslint --stdin --parser-options ecmaVersion:6 # fails with a parsing error
echo '3 ** 4' | npx eslint --stdin --parser-options ecmaVersion:7 # succeeds, yay!

--resolve-plugins-relative-to

Только режим eslintrc. Изменяет директорию, из которой разрешаются плагины.

  • Тип аргумента: Строка. Путь к директории.
  • Несколько аргументов: Нет
  • Значение по умолчанию: По умолчанию, плагины разрешаются из директории, в которой находится ваш файл конфигурации.

Эта опция должна использоваться, когда плагины были установлены не конечным пользователем. Она должна быть установлена в директорию проекта, зависимом от необходимых плагинов.

Например:

  • При использовании файла конфигурации, расположенного вне текущего проекта (с флагом --config), если конфигурация использует плагины, установленные локально к ней, --resolve-plugins-relative-to должен быть установлен в директорию, содержащую файл конфигурации.
  • Если интеграция имеет зависимости от ESLint и набора плагинов, и инструмент вызывает ESLint от имени пользователя с предопределённой конфигурацией, инструмент должен установить --resolve-plugins-relative-to в главную директорию инструмента.
--resolve-plugins-relative-to пример
npx eslint --config ~/personal-eslintrc.js \
--resolve-plugins-relative-to /usr/local/lib/

Указание правил и плагинов

--plugin

Эта опция указывает плагин для загрузки.

  • Тип аргумента: Строка. Имя плагина. Вы можете необязательно опустить префикс eslint-plugin- из имени плагина.
  • Несколько аргументов: Да

Перед использованием плагина его нужно установить с помощью npm.

--plugin пример
npx eslint --plugin jquery file.js
npx eslint --plugin eslint-plugin-mocha file.js

--rule

Эта опция указывает используемые правила.

  • Тип аргумента: Правила и их конфигурация, заданная в формате levn.
  • Несколько аргументов: Да

Эти правила объединяются с любыми правилами, указанными в файлах конфигурации. Если правило определено в плагине, необходимо префикснуть идентификатор правила именем плагина и /.

Чтобы проигнорировать правила в файлах конфигурации и запустить только правила, заданные в командной строке, используйте флаг --rule в сочетании с флагом --no-eslintrc.

--rule пример
# Apply single rule
npx eslint --rule 'quotes: [error, double]'
# Apply multiple rules
npx eslint --rule 'guard-for-in: error' --rule 'brace-style: [error, 1tbs]'
# Apply rule from jquery plugin
npx eslint --rule 'jquery/dollar-sign: error'
# Only apply rule from the command line
npx eslint --rule 'quotes: [error, double]' --no-eslintrc

--rulesdir

Устарело: Используйте правила из плагинов вместо этого.

Только режим eslintrc. Эта опция позволяет указать другую директорию для загрузки файлов правил. Это позволяет динамически загружать новые правила во время выполнения. Это полезно, когда у вас есть пользовательские правила, которые не подходят для включения в ESLint.

  • Тип аргумента: Строка. Путь к директории. Правила в вашей пользовательской директории правил должны соответствовать тому же формату, что и встроенные правила, чтобы правильно работать.
  • Несколько аргументов: Да.

Обратите внимание, что, как и с основными правилами и правилами плагинов, вам всё ещё нужно включить правила в конфигурацию или через опцию CLI --rule для фактического выполнения этих правил при проверке. Указание директории правил с --rulesdir не автоматически включает правила в этой директории.

--rulesdir пример
npx eslint --rulesdir my-rules/ file.js
npx eslint --rulesdir my-rules/ --rulesdir my-other-rules/ file.js

Исправление проблем

--fix

Эта опция указывает ESLint попробовать исправить как можно больше проблем. Исправления вносятся непосредственно в сами файлы, и выводятся только оставшиеся неисправленные проблемы.

  • Тип аргумента: Нет аргумента.

Не все проблемы можно исправить с помощью этой опции, и она не работает в этих ситуациях:

  1. Эта опция выдаёт ошибку, когда код подаётся в ESLint через конвейер.
  2. Эта опция не влияет на код, использующий процессор, если процессор не позволяет исправления.

Если вы хотите исправить код из stdin или по-другому получить исправления без фактической записи в файл, используйте опцию --fix-dry-run.

--fix пример
npx eslint --fix file.js

--fix-dry-run

Этот параметр имеет тот же эффект, что и --fix, за исключением того, что исправления не сохраняются в файловой системе. Поскольку форматировщик по умолчанию не выводит исправленный код, вам нужно использовать другой форматировщик (например, --format json), чтобы получить исправления.

  • Тип аргумента: Нет аргумента.

Это позволяет исправлять код из stdin, когда используется флаг --stdin.

Этот флаг может быть полезен для интеграций (например, плагинов для редакторов), которым нужно автоматически исправлять текст из командной строки без сохранения его в файловой системе.

Пример использования --fix-dry-run
getSomeText | npx eslint --stdin --fix-dry-run --format json

--fix-type

Этот параметр позволяет указать тип исправлений, которые следует применять при использовании --fix или --fix-dry-run.

  • Тип аргумента: Строка. Один из следующих типов исправлений:
    1. problem — исправить потенциальные ошибки в коде
    2. suggestion — применить исправления для улучшения кода
    3. layout — применить исправления, не изменяющие структуру программы (AST)
    4. directive — применить исправления к встроенным директивам, таким как // eslint-disable
  • Множественные аргументы: Да

Этот параметр полезен, если вы используете другую программу для форматирования кода, но все равно хотите, чтобы ESLint применял другие типы исправлений.

Пример использования --fix-type
npx eslint --fix --fix-type suggestion .
npx eslint --fix --fix-type suggestion --fix-type problem .
npx eslint --fix --fix-type suggestion,layout .

Игнорирование файлов

--ignore-path

Только режим eslintrc. Этот параметр позволяет указать файл, используемый в качестве вашего .eslintignore.

  • Тип аргумента: Строка. Путь к файлу.
  • Множественные аргументы: Нет
  • Значение по умолчанию: По умолчанию ESLint ищет .eslintignore в текущем рабочем каталоге.

Примечание: --ignore-path поддерживается только при использовании устаревшей конфигурации. Если вы хотите включить шаблоны из файла .gitignore в свой файл eslint.config.js, ознакомьтесь с включением файлов .gitignore.

Пример использования --ignore-path
npx eslint --ignore-path tmp/.eslintignore file.js
npx eslint --ignore-path .gitignore file.js

--no-ignore

Отключает исключение файлов из файлов .eslintignore, флагов --ignore-path, флагов --ignore-pattern и свойства ignorePatterns в конфигурационных файлах.

  • Тип аргумента: Нет аргумента.
Пример использования --no-ignore
npx eslint --no-ignore file.js

--ignore-pattern

Этот параметр позволяет указать шаблоны файлов для игнорирования. В режиме eslintrc они дополняют .eslintignore.

  • Тип аргумента: Строка. Поддерживаемый синтаксис аналогичен синтаксису для файлов .eslintignore, которые используют те же шаблоны, что и спецификация .gitignore. Вы должны заключать шаблоны в кавычки, чтобы избежать интерпретации оболочки глобальных шаблонов.
  • Множественные аргументы: Да
Пример использования --ignore-pattern
npx eslint --ignore-pattern "/lib/" --ignore-pattern "/src/vendor/*" .

Использование stdin

--stdin

Этот параметр сообщает ESLint о чтении и проверке исходного кода из STDIN вместо файлов. Вы можете использовать это для перенаправления кода в ESLint.

  • Тип аргумента: Нет аргумента.
Пример использования --stdin
cat myfile.js | npx eslint --stdin

--stdin-filename

Этот параметр позволяет указать имя файла для обработки STDIN.

  • Тип аргумента: Строка. Путь к файлу.
  • Множественные аргументы: Нет

Это полезно при обработке файлов из STDIN, если у вас есть правила, которые зависят от имени файла.

Пример использования --stdin-filename
cat myfile.js | npx eslint --stdin --stdin-filename myfile.js

Обработка предупреждений

--quiet

Этот параметр позволяет отключить сообщения о предупреждениях и выполнение правил, настроенных на предупреждение. Если вы включите этот параметр, ESLint будет сообщать только об ошибках и выполнять только правила, настроенные на ошибки.

  • Тип аргумента: Нет аргумента.
Пример использования --quiet
npx eslint --quiet file.js

--max-warnings

Этот параметр позволяет указать порог предупреждений, который может использоваться для принудительного выхода ESLint с кодом ошибки, если в проекте слишком много нарушений правил уровня предупреждения.

  • Тип аргумента: Целое число. Максимальное количество допустимых предупреждений. Чтобы предотвратить это поведение, не используйте этот параметр или укажите -1 в качестве аргумента.
  • Множественные аргументы: Нет

Обычно, если ESLint выполняется и находит только предупреждения (без ошибок), он завершается с кодом успешного завершения. Однако, если --max-warnings указан, и общее количество предупреждений превышает заданный порог, ESLint завершается с кодом ошибки.

Важно

При использовании вместе с --quiet, это заставит правила, помеченные как warn, все ещё выполняться, но не сообщать о них.

Пример использования --max-warnings
npx eslint --max-warnings 10 file.js

Вывод

-o, --output-file

Записать вывод результатов проверки в указанный файл.

  • Тип аргумента: Строка. Путь к файлу.
  • Множественные аргументы: Нет
-o, --output-file пример
npx eslint -o ./test/test.html

-f, --format

Этот параметр определяет формат вывода в консоль.

  • Тип аргумента: Строка. Один из встроенных форматировщиков или пользовательский форматировщик.
  • Множественные аргументы: Нет
  • Значение по умолчанию: stylish

Если вы используете пользовательский форматировщик, определенный в локальном файле, вы можете указать путь к файлу пользовательского форматировщика.

Форматировщик из npm-пакета разрешается с префиксом или без eslint-formatter-.

При указании, заданный формат выводится в консоль. Если вы хотите сохранить этот вывод в файл, вы можете сделать это в командной строке следующим образом:

# Saves the output into the `results.json` file.
npx eslint -f json file.js > results.json
-f, --format пример

Использование встроенного форматировщика json:

npx eslint --format json file.js

Использование локального пользовательского форматировщика:

npx eslint -f ./customformat.js file.js

Использование форматировщика из npm-пакета:

npm install eslint-formatter-pretty

# Then run one of the following commands
npx eslint -f pretty file.js
# or alternatively
npx eslint -f eslint-formatter-pretty file.js

--color и --no-color

Эти параметры принудительно включают/отключают цветной вывод.

  • Тип аргумента: Нет аргумента.

Вы можете использовать эти параметры для переопределения стандартного поведения, которое заключается в включении цветного вывода, если не обнаружен терминал (например, при перенаправлении eslint через cat или less).

Пример использования --color и --no-color
npx eslint --color file.js | cat
npx eslint --no-color file.js

Встроенные комментарии конфигурации

--no-inline-config

Этот параметр предотвращает действие встроенных комментариев, таких как /*eslint-disable*/ или /*global foo*/.

  • Тип аргумента: Нет аргумента.

Это позволяет вам установить конфигурацию ESLint без изменения файлов. Все встроенные комментарии конфигурации игнорируются, например:

  • /*eslint-disable*/
  • /*eslint-enable*/
  • /*global*/
  • /*eslint*/
  • /*eslint-env*/
  • // eslint-disable-line
  • // eslint-disable-next-line
Пример использования --no-inline-config
npx eslint --no-inline-config file.js

--report-unused-disable-directives

Этот параметр заставляет ESLint сообщать о комментариях к директивам, таких как // eslint-disable-line, если на этой строке не было бы сообщений об ошибках.

  • Тип аргумента: Нет аргумента.

Это может быть полезно для предотвращения неожиданного подавления будущих ошибок, очистив устаревшие комментарии eslint-disable и eslint-enable, которые больше не актуальны.

Предупреждение

При использовании этого параметра возможно появление новых сообщений об ошибках при обновлении ESLint или пользовательских правил.

Например, предположим, что у правила есть ошибка, которая приводит к ложному срабатыванию, и добавлен комментарий eslint-disable, чтобы подавить неправильное сообщение. Если ошибка будет исправлена в патче ESLint, комментарий eslint-disable станет неиспользуемым, так как ESLint больше не генерирует неправильное сообщение. Это приводит к новому сообщению об ошибке для неиспользуемой директивы, если используется параметр --report-unused-disable-directives.

Пример использования --report-unused-disable-directives
npx eslint --report-unused-disable-directives file.js

--report-unused-disable-directives-severity

То же, что и --report-unused-disable-directives, но позволяет указать уровень серьезности (error, warn, off ) сообщенных ошибок. Одновременно можно использовать только один из этих двух параметров.

  • Тип аргумента: Строка. Одно из следующих значений:
    1. off (или 0)
    2. warn (или 1)
    3. error (или 2)
  • Множественные аргументы: Нет
  • Значение по умолчанию: По умолчанию используется настройка linterOptions.reportUnusedDisableDirectives, которая по умолчанию равна "warn".
Пример использования --report-unused-disable-directives-severity
npx eslint --report-unused-disable-directives-severity warn file.js

Кэширование

--cache

Хранить информацию о обработанных файлах, чтобы работать только с измененными. Включение этого параметра может значительно улучшить время выполнения ESLint, гарантируя, что проверяются только измененные файлы. Кэш хранится в .eslintcache по умолчанию.

  • Тип аргумента: Без аргумента.

Если вы запустите ESLint с --cache и затем запустите ESLint без --cache, файл .eslintcache будет удалён. Это необходимо, потому что результаты проверки могут измениться и сделать .eslintcache недействительным. Если вы хотите контролировать, когда файл кеша удаляется, используйте --cache-location для указания альтернативного расположения файла кеша.

Автоматически исправленные файлы не помещаются в кеш. Последующая проверка, которая не вызывает автоматической фиксации, поместит файл в кеш.

--cache пример
npx eslint --cache file.js

--cache-file

Устарело: Используйте --cache-location вместо этого.

Путь к файлу кеша. Если не указано, используется .eslintcache. Файл создаётся в каталоге, где выполняется команда eslint.

--cache-location

Укажите путь к расположению кеша. Может быть файлом или каталогом.

  • Тип аргумента: Строка. Путь к файлу или каталогу. Если указан каталог, файл кеша создаётся внутри указанной папки. Имя файла основано на хэше текущего рабочего каталога, например: .cache_hashOfCWD.
  • Несколько аргументов: Нет
  • Значение по умолчанию: Если расположение не указано, используется .eslintcache. Файл создаётся в каталоге, где выполняется команда eslint.

Если каталог для кеша не существует, убедитесь, что вы добавили символ конца пути / на системах *nix или \ на Windows. В противном случае путь предполагается как файл.

--cache-location пример
npx eslint "src/**/*.js" --cache --cache-location "/Users/user/.eslintcache/"

--cache-strategy

Стратегия для использования кешем для обнаружения изменённых файлов.

  • Тип аргумента: Строка. Одно из следующих значений:
    1. metadata
    2. content
  • Несколько аргументов: Нет
  • Значение по умолчанию: metadata

Стратегия content может быть полезна в случаях, когда время изменения ваших файлов меняется, даже если их содержимое не изменилось. Например, это может произойти во время операций git, таких как git clone, потому что git не отслеживает время изменения файла.

--cache-strategy пример
npx eslint "src/**/*.js" --cache --cache-strategy content

Разное

--init

Этот параметр запускает npm init @eslint/config для запуска мастера настройки конфигурации. Он предназначен для помощи новым пользователям быстро создать файл .eslintrc путём ответа на несколько вопросов. Когда вы используете этот флаг, CLI не выполняет проверку.

  • Тип аргумента: Без аргумента.

Результирующий файл конфигурации создаётся в текущем каталоге.

--init пример
npx eslint --init

--env-info

Этот параметр выводит информацию об окружении выполнения, включая версию Node.js, npm и локальные и глобальные установки ESLint.

  • Тип аргумента: Без аргумента.

Команда ESLint может запросить эту информацию для решения проблем. Когда вы используете этот флаг, CLI не выполняет проверку.

--env-info пример
npx eslint --env-info

--no-error-on-unmatched-pattern

Этот параметр предотвращает ошибки, когда цитируемый шаблон glob или --ext не соответствует. Это не предотвращает ошибки, когда ваша оболочка не может сопоставить glob.

  • Тип аргумента: Без аргумента.
--no-error-on-unmatched-pattern пример
npx eslint --no-error-on-unmatched-pattern --ext .ts "lib/*"

--exit-on-fatal-error

Этот параметр заставляет ESLint завершать работу с кодом выхода 2, если произошли одна или несколько фатальных ошибок парсинга. Без этого параметра ESLint сообщает о фатальных ошибках парсинга как о нарушениях правил.

  • Тип аргумента: Без аргумента.
--exit-on-fatal-error пример
npx eslint --exit-on-fatal-error file.js

--no-warn-ignored

Только режим конфигурации в одну строку. Этот параметр подавляет как File ignored by default, так и File ignored because of a matching ignore pattern предупреждения, когда явно передаётся имя игнорируемого файла. Это полезно в сочетании с --max-warnings 0, так как это предотвратит код выхода 1 из-за вышеупомянутого предупреждения.

  • Тип аргумента: Без аргумента.
--no-warn-ignored пример
npx eslint --no-warn-ignored --max-warnings 0 ignored-file.js

--pass-on-no-patterns

Этот параметр позволяет ESLint завершать работу с кодом 0, когда не переданы никакие шаблоны файлов или каталогов. Без этого параметра ESLint предполагает, что вы хотите использовать . в качестве шаблона. (При запуске в режиме eslintrc legacy ESLint завершит работу с кодом 1.)

  • Тип аргумента: Без аргумента.
--pass-on-no-patterns пример
npx eslint --pass-on-no-patterns

--debug

Этот параметр выводит отладочную информацию в консоль. Добавьте этот флаг в вызов ESLint в командной строке, чтобы получить дополнительную отладочную информацию во время выполнения команды.

  • Тип аргумента: Без аргумента.

Эта информация полезна, когда вы видите проблему и трудно её определить. Команда ESLint может запросить эту отладочную информацию для решения проблем.

--debug пример
npx eslint --debug test.js

-h, --help

Этот параметр выводит меню справки, отображая все доступные параметры. Все остальные параметры игнорируются, когда это присутствует. Когда вы используете этот флаг, CLI не выполняет проверку.

  • Тип аргумента: Без аргумента.
-h, --help пример
npx eslint --help

-v, --version

Этот параметр выводит текущую версию ESLint в консоль. Все остальные параметры игнорируются, когда это присутствует. Когда вы используете этот флаг, CLI не выполняет проверку.

  • Тип аргумента: Без аргумента.
-v, --version пример
npx eslint --version

--print-config

Этот параметр выводит конфигурацию, которая будет использоваться для переданного файла. При наличии этого параметра проверка не выполняется, и только параметры, связанные с конфигурацией, являются допустимыми. Когда вы используете этот флаг, CLI не выполняет проверку.

  • Тип аргумента: Строка. Путь к файлу.
  • Несколько аргументов: Нет
--print-config пример
npx eslint --print-config file.js

--stats

Этот параметр добавляет серию подробных статистических данных производительности (см. Тип статистики), такие как время parse-, fix- и lint- (время на правило) к объектам result, которые передаются форматировщику (см. Использование статистики в CLI).

  • Тип аргумента: Без аргумента.

Этот параметр предназначен для использования с пользовательскими форматировщиками, которые отображают статистику. Он также может использоваться с встроенным json форматировщиком.

--stats пример
npx eslint --stats --format json file.js

--flag

Этот параметр включает один или несколько флагов функций для ESLint.

  • Тип аргумента: Строка. Идентификатор функции.
  • Несколько аргументов: Да
--flag пример
npx eslint --flag x_feature file.js

Коды выхода

При проверке файлов ESLint завершает работу с одним из следующих кодов выхода:

  • 0: Проверка прошла успешно, и ошибок нет. Если флаг --max-warnings установлен на n, количество предупреждений проверки не превышает n.
  • 1: Проверка прошла успешно, и есть по крайней мере одна ошибка или предупреждений проверки больше, чем разрешено параметром --max-warnings.
  • 2: Проверка не удалась из-за проблемы с конфигурацией или внутренней ошибки.

© OpenJS Foundation and other contributors
Licensed under the MIT License.
https://eslint.org/docs/latest/use/command-line-interface

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API