Это вводная статья, которая поможет вам начать работу с инструментом eslint и параметрами стиля кода, которые он предоставляет.
Введение
ESLint — это инструмент линтинга JavaScript (ECMAScript) для поиска и исправления проблемных шаблонов кода. eslint не следует путать с утилитой поиска и исправления ошибок, потому что она этого не делает. он просто запустит отправленный код в соответствии с предварительно настроенным/прекомпилированным набором правил и даст вам возможность исправить ваш код.
Установка
ESLint можно установить с помощью пакета npm eslint, подробности можно найти на странице https://www.npmjs.com/package/eslint.
Требования: Node.js (^8.10.0
, ^10.13.0
или >=11.10.1
), npm версии 3+.
Вы можете установить ESLint с помощью npm:
$ npm install eslint --save-dev
Конфигурация
Вы можете запустить следующую команду (нацеленную на папку установки eslint)
$ ./node_modules/bin/eslint --init
выполнение приведенной выше команды предоставит пользователю следующие параметры на выбор:
Вы можете выбрать любой из вышеперечисленных вариантов в зависимости от ваших потребностей.
затем попросите установить шаблоны импорта/экспорта модуля:
Примечание: если вы разрабатываете сервисное приложение на основе nodejs, вы можете выбрать CommonJS (опция require/exports0.
Затем он запрашивает фреймворк, который вы собираетесь использовать, вы можете выбрать подходящий вариант в зависимости от вашего приложения.
Затем он спросит, использует ли приложение TypeScript?
Затем выберите тип вашего приложения (узел [серверная сторона] или браузер [клиентская сторона]).
Далее интересная опция для выбора, здесь утилита спрашивает, хотите ли вы следовать какому-либо популярному руководству по стилю или хотите настроить свой собственный набор правил.
Выбор популярных стайл-гайдов поможет следить за популярным проектом (например, Airbnb и т. д.) и сэкономить время на настройке и составлении собственного.
В настоящее время он предоставляет следующие 3 популярных руководства по стилю:
post эта утилита установит соответствующие пакеты (если выбрано популярное руководство по стилю).
После этого шага ESILint настроен и готов к выполнению статического анализа кода.
Поиск ошибок линтинга
выполните следующую команду:
eslint.cmd .\app.js
Я добавил пример кода JavaScript (app.js)
function sampleTest(){ var name= "Lint Test" }
выполнение команды eslint показывает следующую ошибку линтинга в коде:
Исправление ошибок линтинга
ESLint помогает исправить ошибки линтинга, автоматически выполняя следующую команду, которая дает указание eslint исправить их:
eslint <filename> --fix
это исправляет наш код следующим образом:
function sampleTest() { const name = 'Lint Test'; }