Глава 2 Начало работы | Наука о данных в командной строке, 1e

В этой главе мы собираемся убедиться, что у вас есть все предпосылки для работы с данными из командной строки.Предварительные требования делятся на две части: (1) наличие надлежащей среды со всеми установленными инструментами командной строки, которые мы используем в этой книге, и (2) понимание основных концепций, которые вступают в игру при использовании командной строки.

Во-первых, мы опишем, как установить образ Docker, который представляет собой виртуальную среду на основе Linux, содержащую все необходимые инструменты командной строки. Затем мы объясним основные концепции командной строки на примерах.

К концу этой главы у вас будет все необходимое, чтобы продолжить первый шаг в области науки о данных, а именно получение данных.

Обзор

В этой главе вы узнаете:

• Как установить образ Docker.
• Основные концепции и инструменты, необходимые для выполнения анализа данных из командной строки.

Установка образа Docker

Этот раздел раньше назывался Настройка Data Science Toolbox и описывал, как установить модуль Vagrant, содержащий все инструменты командной строки. Этот блок Vagrant был создан в 2014 году, и, поскольку технологии виртуализации и контейнеризации продвинулись вперед, настало время для обновления.Итак, теперь вместо Vagrant box мы используем образ Docker.

В этой книге мы используем множество различных инструментов командной строки. Linux часто поставляется с целым набором предустановленных инструментов командной строки. Более того, Linux предлагает множество пакетов, содержащих другие соответствующие инструменты. Самостоятельно установить эти пакеты не так уж и сложно. Однако мы также используем инструменты, которые недоступны в виде пакетов и требуют более ручной и более сложной установки. Чтобы получить необходимые инструменты командной строки без необходимости проходить соответствующий процесс установки каждого из них, мы рекомендуем вам установить образ Docker, который был создан специально для этой книги.

Чтобы установить образ Docker, сначала необходимо загрузить и установить сам Docker с веб-сайта Docker.После установки Docker вы вызываете следующую команду в терминале или командной строке, чтобы загрузить образ Docker (не вводите знак доллара):

  $ docker pull datascienceworkshops / data-science-at-the-command-line  

Вы можете запустить образ Docker следующим образом:

  $ docker run --rm -it datascienceworkshops / data-science-at-the-command-line  

Теперь вы находитесь в изолированной среде Linux, известной как контейнер Docker , со всеми необходимыми инструментами командной строки.\ (оо) \ _______ (__) \) \ / \ || —- w | || ||

Запустите exit , чтобы выйти из контейнера. Если вы хотите получать данные в контейнере и из него, вы можете добавить том, что означает, что локальный каталог будет сопоставлен с каталогом внутри контейнера. Мы рекомендуем вам создать новый каталог, перейти в этот новый каталог, а затем запустить следующее, когда вы работаете в macOS или Linux:

  $ docker run --rm -it -v`pwd`: / data datascienceworkshops / data-science-at-the-command-line  

Или следующее, когда вы работаете в Windows и используете командную строку:

  $ docker run --rm -it -v% cd%: / data datascienceworkshops / data-science-at-the-command-line  

Или следующее, если вы используете Windows PowerShell:

  $ docker run --rm -it -v $ {PWD}: / data datascienceworkshops / data-science-at-the-command-line  

В приведенных выше командах параметр -v указывает докеру сопоставить текущий каталог с каталогом / data внутри контейнера, так что это место для получения данных в контейнере Docker и из него.

Основные концепции GNU / Linux

В главе 1 мы кратко показали вам, что такое командная строка. Теперь, когда вы запустили образ Docker, мы действительно можем приступить к работе. В этом разделе мы обсудим несколько концепций и инструментов, которые вам необходимо знать, чтобы чувствовать себя комфортно, занимаясь наукой о данных из командной строки. Если до сих пор вы в основном работали с графическими пользовательскими интерфейсами, это могло бы стать большим изменением. Но не волнуйтесь, мы начнем с самого начала и постепенно перейдем к более сложным темам.

Окружающая среда

Итак, вы только что вошли в совершенно новую среду. Прежде чем что-либо делать, стоит получить общее представление об этой среде.Окружающая среда примерно определяется четырьмя слоями, которые мы кратко обсуждаем сверху вниз.

Инструменты командной строки

Прежде всего, это инструменты командной строки, с которыми вы работаете. Мы используем их, набирая соответствующие им команды. Существуют различные типы инструментов командной строки, которые мы обсудим в следующем разделе. Примеры инструментов: ls (Stallman and MacKenzie 2012a), cat (Granlund and Stallman 2012a) и jq (Dolan 2014).

Терминал

Терминал, который является вторым уровнем, представляет собой приложение, в которое мы вводим наши команды. Если вы видите следующий текст:

, затем введите seq 3 в свой терминал и нажмите . (Инструмент командной строки seq (Drepper 2012) генерирует последовательность чисел.) Знак доллара не вводится. Это просто для того, чтобы сообщить вам, что эту команду вы можете ввести в терминал. Этот знак доллара известен как подсказка.Текст под seq 3 является результатом выполнения команды. В главе 1 мы показали вам два скриншота того, как терминал по умолчанию выглядит в macOS и Ubuntu с различными командами и их выводом.

Оболочка

Третий слой — это скорлупа. После того, как мы ввели нашу команду и нажали , терминал отправляет эту команду в оболочку. Оболочка — это программа, интерпретирующая команду. Образ Docker использует Bash в качестве оболочки, но доступно множество других.Когда вы немного научитесь работать с командной строкой, вы можете захотеть заглянуть в оболочку, называемую Z-оболочкой. Он предлагает множество дополнительных функций, которые могут повысить вашу производительность в командной строке.

Операционная система

Четвертый уровень — это операционная система, в нашем случае это GNU / Linux. Linux — это имя ядра, которое является сердцем операционной системы. Ядро находится в прямом контакте с процессором, дисками и другим оборудованием. Ядро также выполняет наши инструменты командной строки.GNU, что означает GNU, а не UNIX, относится к набору основных инструментов. Образ Docker основан на конкретном дистрибутиве Linux под названием Alpine Linux.

Перенаправление ввода и вывода

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

  $ seq 10> данные / десять чисел  

Здесь мы сохраняем вывод инструмента seq в файл с именем десять чисел в каталоге ~ / book / ch02 / data .Если этого файла еще нет, он создается. Если бы этот файл уже существовал, его содержимое было бы перезаписано. Вы также можете добавить вывод в файл с >> , что означает, что вывод помещается после исходного содержимого:

  $ echo -n "Привет"> привет-мир
$ echo "Мир" >> hello-world  

Инструмент эхо просто выводит указанное вами значение. Параметр -n указывает, что echo не должно выводить завершающую новую строку.

Сохранение вывода в файл полезно, если вам нужно сохранить промежуточные результаты, например, для продолжения анализа на более позднем этапе. Чтобы снова использовать содержимое файла hello-world , мы можем использовать cat (Granlund and Stallman 2012a), который читает файл и печатает его.

  $ котик привет-мир | туалет -w
2  

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

Таким образом, вы напрямую передаете файл на стандартный ввод wc без запуска дополнительного процесса.Если инструмент командной строки также позволяет указывать файлы в качестве аргументов командной строки, что многие делают, вы также можете сделать следующее для wc :

  $ wc -w привет-мир
2 привет-мир  

Работа с файлами

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

Вы уже видели, как мы можем создавать новые файлы, перенаправляя вывод с помощью > или >> . Если вам нужно переместить файл в другой каталог, вы можете использовать mv (Parker, MacKenzie и Meyering 2012):

  $ mv hello.txt ~ / book / ch02 / data /  

Вы также можете переименовывать файлы с помощью mv :

  $ cd data
$ mv привет.txt bye.txt  

Вы также можете переименовывать или перемещать целые каталоги. Если вам больше не нужен файл, вы удалите (или удалите) его с помощью rm (Rubin, MacKenzie, Stallman, et al. 2012):

Если вы хотите удалить весь каталог со всем его содержимым, укажите параметр -r , который означает рекурсивный:

  $ rm -r книга / ch02 / data / старая  

Если вы хотите скопировать файл, используйте cp (Granlund, MacKenzie, and Meyering 2012).Это полезно для создания резервных копий:

  $ cp server.log server.log.bak  

Вы можете создавать каталоги, используя mkdir (MacKenzie 2012):

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

Все вышеперечисленные инструменты командной строки принимают параметр -v , который означает подробный, так что они выводят то, что происходит.Все, кроме mkdir , принимают параметр -i , который означает интерактивный, и заставляет инструменты запрашивать подтверждение.

Помогите!

По мере того, как вы разбираетесь в командной строке, может случиться так, что вам понадобится помощь. Даже самым опытным пользователям Linux в какой-то момент понадобится помощь. Невозможно вспомнить все различные инструменты командной строки и их возможные аргументы. К счастью, командная строка предлагает несколько способов получить помощь.

Самая важная команда для получения помощи — это, возможно, man (Eaton and Watson 2014), что является сокращением от manual .Он содержит информацию для большинства инструментов командной строки. Представьте, что мы забыли различные варианты инструмента cat . Вы можете получить доступ к его странице руководства, используя:

  $ человек кот | голова -n 20
CAT (1) Пользовательские команды CAT (1)



ИМЯ
       cat - объединить файлы и распечатать на стандартный вывод

ОБЗОР
       cat [ВАРИАНТ] ... [ФАЙЛ] ...

ОПИСАНИЕ
       Объедините ФАЙЛ (ы) или стандартный ввод со стандартным выводом.

       -A, --show-all
              эквивалент -vET

       -b, --number-nonblank
              количество непустых выходных строк, отменяет -n

       -e эквивалент -vE  

Иногда вы можете увидеть, как мы используем head , fold или cut в конце команды.Это сделано только для того, чтобы вывод команды умещался на странице; вводить их не нужно. Например, head -n 5 печатает только первые пять строк, fold переносит длинные строки до 80 символов, а cut -c1-80 обрезает строки длиной более 80 символов.

Не каждый инструмент командной строки имеет справочную страницу. Для встроенных команд оболочки, таких как cd , необходимо использовать инструмент командной строки help :

  $ help cd | голова -n 20
cd: cd [-L | [-P [-e]] [- @]] [каталог]
    Измените рабочий каталог оболочки.Измените текущий каталог на DIR. По умолчанию DIR - это значение
    Переменная оболочки HOME.

    Переменная CDPATH определяет путь поиска для каталога, содержащего
    DIR. Альтернативные имена каталогов в CDPATH разделяются двоеточием (:).
    Нулевое имя каталога совпадает с именем текущего каталога. Если DIR начинается
    с косой чертой (/), то CDPATH не используется.

    Если каталог не найден и параметр оболочки `cdable_vars 'установлен,
    предполагается, что слово является именем переменной.Если эта переменная имеет значение,
    его значение используется для DIR.

    Параметры:
        -L принудительно использовать символические ссылки: разрешить символические ссылки в
        DIR после обработки экземпляров `.. '
        -P использовать физическую структуру каталогов без символических
        ссылки: разрешить символические ссылки в DIR перед обработкой экземпляров  

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

Более новые инструменты, которые можно использовать из командной строки, часто также не имеют справочной страницы. В этом случае лучше всего вызвать инструмент с параметром --help (а иногда и параметром -h ). Например:

  jq - справка

jq - процессор JSON командной строки [версия 1.4]
Использование: jq [параметры] <фильтр jq> [файл ...]

Для описания параметров командной строки и
как писать фильтры jq (и почему вы можете захотеть)
см. справочную страницу jq или онлайн-документацию по адресу
http: // stedolan.github.com/jq  

Указание параметра --help также работает для инструментов командной строки GNU, таких как cat . Однако на соответствующей странице руководства часто можно найти дополнительную информацию. Если, попробовав эти три подхода, вы все еще застряли, то вполне допустимо обратиться к Интернету. В приложении приведен список всех инструментов командной строки, используемых в этой книге. Помимо того, как можно установить каждый инструмент командной строки, он также показывает, как получить помощь.

Использование параметров командной строки

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

Для ввода параметров командной строки:

1. Запустите утилиту командной строки Windows. Его расположение зависит от вашей версии Windows. Если вы не знаете, где его найти, воспользуйтесь функцией поиска Windows.
2. В командной строке используйте команду DOS chdir , как показано в примере ниже, чтобы перейти в каталог, в котором установлен Dragon на вашем компьютере.По умолчанию это C: \ Program Files (x86) \ Nuance \ NaturallySpeaking14 \ Program .

Примечание: Чтобы получить справку по синтаксису команд DOS, введите help в окне командной строки.

Пример:
C: \ Users \ YourName> chdir .. \ Program Files (x86) \ Nuance \ NaturallySpeaking14 \ Program

3. Введите natspeak / switch, заменив «/ switch» переключателем из таблицы ниже.

Расширение корпуса звена

Интерфейс командной строки — ESLint

Чтобы запустить ESLint на Node.js, у вас должен быть установлен npm. Если npm не установлен, следуйте инструкциям здесь: https://www.npmjs.com/

После установки npm запустите следующую команду

  npm i -g eslint
  

Устанавливает интерфейс командной строки ESLint из репозитория npm.Чтобы запустить ESLint, используйте следующий формат:

  eslint [параметры] [файл | каталог | glob] *
  

Например:

  eslint file1.js file2.js
  

или:

  eslint lib / **
  

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

  eslint "lib / **"
  

Параметры

Утилита командной строки имеет несколько параметров.Вы можете просмотреть параметры, запустив eslint -h .

  eslint [параметры] file.js [file.js] [каталог]

Базовая конфигурация:
  --no-eslintrc Отключить использование конфигурации из .eslintrc. *
  -c, --config path :: String Использовать эту конфигурацию, переопределяя параметры конфигурации .eslintrc. *, если они есть
  --env [String] Укажите среду
  --ext [String] Указать расширения файлов JavaScript - по умолчанию: .js
  --global [String] Определить глобальные переменные
  --parser String Укажите используемый синтаксический анализатор
  --parser-options Объект Указать параметры парсера
  --resolve-plugins-relative-to path :: String Папка, из которой должны быть разрешены плагины, по умолчанию CWD

Определение правил и плагинов:
  --rulesdir [path :: String] Использовать дополнительные правила из этого каталога
  --plugin [String] Указать плагины
  --rule Object Указать правила

Устранение проблем:
  --fix Автоматически исправлять проблемы
  --fix-dry-run Автоматически исправлять проблемы без сохранения изменений в файловой системе
  --fix-type Array Укажите типы применяемых исправлений (проблема, предложение, макет)

Игнорирование файлов:
  --ignore-path путь :: String Указать путь к файлу игнорирования
  --no-ignore Отключить использование игнорируемых файлов и шаблонов
  --ignore-pattern [String] Шаблон игнорируемых файлов (в дополнение к файлам в.Эслинтиньор)

Используя стандартный ввод:
  --stdin Код линта предоставляется на  - по умолчанию: false
  --stdin-filename Строка Укажите имя файла для обработки STDIN как

Обработка предупреждений:
  --quiet Сообщать только об ошибках - по умолчанию: false
  --max-warnings Int Число предупреждений для запуска ненулевого кода выхода - по умолчанию: -1

Вывод:
  -o, --output-file path :: String Указать файл для записи отчета
  -f, --format String Использовать определенный формат вывода - по умолчанию: стильный
  --color, --no-color Принудительное включение / выключение цвета

Встроенные комментарии к конфигурации:
  --no-inline-config Запрещать комментариям изменять конфигурацию или правила
  --report-unused-disable-directives Добавляет сообщения об ошибках для неиспользуемых директив eslint-disable

Кеширование:
  --cache Проверять только измененные файлы - по умолчанию: false
  --cache-file path :: String Путь к файлу кеша.Устарело: используйте --cache-location - по умолчанию: .eslintcache
  --cache-location path :: String Путь к файлу или каталогу кеша

Разное:
  --init Запустить мастер инициализации конфигурации - по умолчанию: false
  --env-info Выводить информацию о среде выполнения - по умолчанию: false
  --no-error-on-unmatched-pattern Предотвращать ошибки, когда шаблон не совпадает - по умолчанию: false
  --debug Выводить отладочную информацию
  -h, --help Показать справку
  -v, --version Вывести номер версии
  --print-config path :: String Распечатать конфигурацию для данного файла
  

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

Пример:

  eslint --ext .jsx --ext .js lib /

eslint --ext .jsx, .js lib /
  

Базовая конфигурация

--no-eslintrc

Отключает использование конфигурации из файлов .eslintrc. * и package.json .

Пример:

  eslint --no-eslintrc file.js
  

-c , --config

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

Пример:

  eslint -c ~ / my-eslint.json file.js
  

В этом примере используется файл конфигурации по адресу ~ / my-eslint.json .

Если .eslintrc. * и / или package.json файлы также используются для конфигурации (т.е. --no-eslintrc не указан), конфигурации будут объединены. Параметры из этого файла конфигурации имеют приоритет над параметрами из файлов .eslintrc. * и package.json .

--env

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

Примеры:

  eslint --env browser, node file.js
eslint --env browser - файл узла env.js
  

--ext

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

Примеры:

  # Использовать только расширение .ts
eslint. --ext .ts

# Используйте как .js, так и .ts
eslint. --ext .js --ext .ts

# Также используйте .js и .ts
eslint.--ext .js, .ts
  

Примечание: --ext используется только в том случае, если аргументами являются каталоги. Если вы используете глобальные шаблоны или имена файлов, то --ext игнорируется.

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

--global

Этот параметр определяет глобальные переменные, поэтому они не будут помечены как неопределенные правилом no-undef .Предполагается, что любые указанные глобальные переменные по умолчанию доступны только для чтения, но добавление : true к имени переменной гарантирует, что no-undef также разрешит запись. Чтобы указать несколько глобальных переменных, разделите их запятыми или используйте этот параметр несколько раз.

Примеры:

  eslint --global require, exports: true file.js
eslint --global require --global exports: true
  

--parser

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

--parser-options

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

Примеры:

  echo '3 ** 4' | eslint --stdin --parser-options = ecmaVersion: 6 # завершится ошибкой синтаксического анализа
echo '3 ** 4' | eslint --stdin --parser-options = ecmaVersion: 7 # успешно, ура!
  

--resolve-plugins-relative-to

Изменяет папку, в которой разрешаются плагины.По умолчанию плагины разрешаются из текущего рабочего каталога. Этот параметр следует использовать, если плагины были установлены кем-то, кроме конечного пользователя. Он должен быть установлен в каталог проекта, который зависит от необходимых плагинов. Например:

• При использовании файла конфигурации, расположенного вне текущего проекта (с флагом --config ), если в конфигурации используются плагины, которые устанавливаются локально для себя, --resolve-plugins-relative -to должен быть установлен в каталог, содержащий файл конфигурации.
• Если у интеграции есть зависимости от ESLint и набора подключаемых модулей, и инструмент вызывает ESLint от имени пользователя с предварительно заданной конфигурацией, инструмент должен установить --resolve-plugins-relative-to- на верхний уровень каталог инструмента.

Указание правил и подключаемых модулей

--rulesdir

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

Пример:

  eslint --rulesdir my-rules / file.js
  

Для правильной работы правила в вашем каталоге настраиваемых правил должны соответствовать тому же формату, что и связанные правила. Вы также можете указать несколько мест для настраиваемых правил, включив несколько параметров --rulesdir :

  eslint --rulesdir my-rules / --rulesdir my-other-rules / file.js
  

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

--plugin

Этот параметр указывает подключаемый модуль для загрузки. Вы можете опустить префикс eslint-plugin- в имени плагина.

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

Примеры:

  eslint --plugin jquery file.js
eslint --plugin eslint-plugin-mocha file.js
  

--rule

Этот параметр определяет правила, которые будут использоваться.Эти правила будут объединены с любыми правилами, указанными в файлах конфигурации. (Вы можете использовать --no-eslintrc , чтобы изменить это поведение.) Чтобы определить несколько правил, разделите их запятыми или используйте этот параметр несколько раз. Формат levn используется для определения правил.

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

Примеры:

  eslint --rule 'кавычки: [2, double]'
eslint --rule 'guard-for-in: 2' --rule 'brace-style: [2, 1tbs]'
eslint --rule 'jquery / знак доллара: 2'
  

Устранение проблем

--fix

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

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

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

--fix-dry-run

Этот параметр имеет тот же эффект, что и --fix , с одним отличием: исправления не сохраняются в файловой системе. Это позволяет исправить код из stdin (при использовании с флагом --stdin ).

Поскольку модуль форматирования по умолчанию не выводит фиксированный код, вам придется использовать другой (например, json ), чтобы получить исправления. Вот пример этого шаблона:

  getSomeText | eslint --stdin --fix-dry-run --format = json
  

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

--fix-type

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

1. проблема — исправить потенциальные ошибки в коде
2. предложение — применить исправления к коду, которые его улучшают
3. layout — применить исправления, которые не изменяют структуру программы ( AST)

В командной строке можно указать один или несколько типов исправлений.Вот несколько примеров:

  eslint --fix --fix-type предложение.
eslint --fix --fix-type предложение --fix-type проблема.
eslint --fix --fix-тип предложения, макет.
  

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

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

--ignore-path

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

Пример:

  eslint --ignore-path tmp / .eslintignore file.js
eslint --ignore-path .gitignore file.js
  

--no-ignore

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

Пример:

  eslint --no-ignore file.js
  

--ignore-pattern

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

Пример:

  eslint --ignore-pattern '/ lib /' --ignore-pattern '/ src / vendor / *'.
  

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

--stdin

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

Пример:

  cat myfile.js | eslint --stdin
  

--stdin-filename

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

Пример

  cat myfile.js | eslint --stdin --stdin-filename = myfile.js
  

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

--quiet

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

Пример:

  eslint --quiet file.js
  

--max-warnings

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

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

Пример:

  eslint --max-warnings 10 file.js
  

Выход

-o , --output-file

Разрешить запись отчета в файл.

Пример:

  eslint -o ./test/test.html
  

Если указано, данный формат выводится в указанное имя файла.

-f , --format

Этот параметр определяет выходной формат для консоли. Возможные форматы:

Пример:

  eslint -f compact file.js
  

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

Пример:

  eslint -f ./customformat.js file.js
  

Установленный npm форматтер разрешается с префиксом eslint-formatter- или без него.

Пример:

  npm install eslint-formatter-pretty

eslint -f довольно file.js

// эквивалент:
eslint -f eslint-formatter-pretty file.js
  

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

  eslint -f compact file.js> results.txt
  

Результат сохраняется в файле results.txt .

--color , --no-color

Этот параметр включает / отключает цветной вывод. Вы можете использовать это, чтобы переопределить поведение по умолчанию, которое состоит в том, чтобы включить цветной вывод, если TTY не обнаружен, например, при соединении с eslint до cat или меньше .

Примеры:

  eslint --color file.js | Кот
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

Пример:

  eslint --no-inline- файл конфигурации.js
  

--report-unused-disable-directives

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

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

Пример:

  eslint --report-unused-disable-directives файл.js
  

Кэширование

--cache

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

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

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

--cache-file

Путь к файлу кеша. Если не указано .eslintcache будет использоваться. Файл будет создан в каталоге, где выполняется команда eslint . Устарело : используйте вместо --cache-location .

--cache-location

Путь к расположению кеша. Может быть файлом или каталогом. Если местоположение не указано, будет использоваться .eslintcache . В этом случае файл будет создан в каталоге, в котором выполняется команда eslint .

Если указан каталог, в указанной папке будет создан файл кеша.Имя файла будет основано на хэше текущего рабочего каталога (CWD). например: .cache_hashOfCWD

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

Пример:

  eslint "src / ** / *. Js" --cache --cache-location "/Users/user/.eslintcache/"
  

Разное

--init

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

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

--env-info

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

--no-error-on-unmatched-pattern

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

--debug

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

-h , --help

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

-v , --version

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

--print-config

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

Пример:

  eslint --print-config file.js
  

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

ESLint поддерживает файлов .eslintignore , чтобы исключить файлы из процесса линтинга, когда ESLint работает с каталогом. Файлы, указанные как отдельные аргументы CLI, не будут исключены. Файл .eslintignore — это простой текстовый файл, содержащий по одному шаблону на строку.Он может быть расположен в любом из предков целевого каталога; это повлияет на файлы в содержащем его каталоге, а также на все подкаталоги. Вот простой пример файла .eslintignore :

  temp.js
** / vendor / *. js
  

Более подробное описание поддерживаемых шаблонов и каталогов, которые ESLint игнорирует по умолчанию, можно найти в разделе «Настройка ESLint».

Коды выхода

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

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