Предисловие
Jshint используется для анализа и проверки того, что код JavaScript соответствует вашим правилам кодирования. Этот мощный инструмент может помочь определить ошибки и проблемы в вашем коде, и он заставляет вашу команду поддерживать определенные соглашения и стили кодирования, что делает код надежным и проще для чтения.
В этой статье я покажу вам, как установить, настраивать и использовать Jshint. Также включен пример, в котором перечислены некоторые из моих любимых редакторов, которые могут использовать Jshint.
Установите jshint
Установка Jshint очень проста, вы можете использовать диспетчер пакетов узлов (NPM). Если вы еще не установили NPM, вы можете скачать последнюю версию с веб -сайта Nodejs для установки Node.js и NPM.
После установки NPM вы можете использовать следующую команду для установки jshint:
NPM установить jshint -g
Параметр -g сообщает npm , что мы хотим установить глобально, чтобы мы могли вызвать эту команду в любом каталоге.
Проверьте код через командную строку
Теперь, когда Jshint установлен, давайте использовать jshint в командной строке для анализа файла кода JavaScript.
Вот файл с именем файла demo1.json:
Мы используем следующую команду для анализа кода:
Jshint demo1.js
Jshint сообщает нам, что в строке 8 есть ошибка в файле Demo1.js, причина: полуколон отсутствует.
Если мы заполним отсутствующий полуколон и снова запустим эту команду, не будет вывода сообщения об ошибке.
Настройка Jshint
Jshint имеет конфигурацию по умолчанию для анализа вашего кода, но его настройки конфигурации предназначены для того, чтобы быть очень гибкими. Существует четыре способа предоставления файлов обработки конфигурации для Jshint.
Одним из способов является использование параметра --config для указания файла конфигурации:
jshint demo1.js -config config.json
Другой способ - поместить конфигурацию в файл с именем. Если это не найдено, он будет продолжать искать верхний каталог до корневого каталога, который позволяет нам устанавливать различные файлы конфигурации для проекта.
Третий способ - разместить информацию о конфигурации в свойство jshintconfig файла package.json.
В любом из этих трех методов информация о конфигурации является форматом JSON, чтобы указать каждый параметр, чтобы сообщить опции JSHINT включаться или выключить. Например: «неиспользованные» и «Undef» в следующем файле конфигурации предназначены для активации тревоги для неиспользованных и неопределенных переменных. «Кудрявый» требует, чтобы вы всегда помещали брекеты на петли и условные блоки. «eqeqeq» означает, что == и! = запрещены, но следует использовать === и! ==. «Globals» используется для указания белого списка глобальных переменных, которые не определены в коде.
Четвертый метод состоит в том, чтобы записать информацию о конфигурации в файл кода в аннотации.
Вы можете просмотреть различные параметры конфигурации для управления поведением JSHINT.
Небольшой пример
Далее, давайте работать в параметрах в файле конфигурации config.json, упомянутого выше. Предположим, что у нас есть файл JavaScript ниже, который является лишь небольшим кусочком кода только для обучения.
Если мы выполним команду JSHINT demo2.js --config config.json , мы получим следующий результат:
В нашем коде есть 4 ошибки. В строке 9 JSHINT предлагает, чтобы кодовый блок «если» был обернут в брекеты. Переменная subscription_id определяется, но не используется. В строках 9 и 11 «Подтверждение» и «Консоль» не определены.
Мы можем избежать первых двух ошибок с небольшой модификацией:
Теперь давайте добавим опцию разработки в файл config.json и установим ее на True, чтобы JShint мог распознать «подтверждение» и «консоль».
На этом этапе, если мы снова запустим команду JSHINT, ошибок не будет.
Суммировать
Jshint - очень хороший инструмент для уменьшения ошибок кода. Многие редакторы оказывают поддержку JSHINT. Друзья, которые просто заинтересованы, могут дальше изучать jshint. Выше приведено использовать JSHINT для уменьшения ошибок JavaScript. Я надеюсь, что это будет полезно для всех, кто использует JavaScript.