Linting JavaScript з JSHint

Linting У комп'ютерному програмуванні йде процес статичний аналіз коду, щоб знайти такі питання, як неправильний синтаксис, і сумнів використання коду. Інструмент, що використовується для линтування, відомий як a lint або linter. Одним з доступних для JavaScript ліптерів сьогодні є JSHint.

JSHint доступний для декількох платформ. Інтернет-інструмент, з яким більшість з нас знайомий, знаходиться на сайті jshint.com. Є також і інструмент командного рядка через Node.js, a JavaScript API, кілька текстових редакторів і плагінів IDE для JSHint. Повний список доступних інструментів JSHint для різних середовищ можна переглянути на сторінці завантаження та встановлення веб-сайту JSHint.

Згідно з його веб-сайтом, два найпоширеніші способи використання інструменту JSHint - це інструмент командного рядка і API. Давайте подивимося, як ви можете завантажити обидва способи, разом з іншими linting optiosn інструменти забезпечують.

Через інструмент командного рядка

(1) Якщо у вас не встановлено Node.js на вашому комп'ютері, то вам доведеться перейти на його веб-сайт і спочатку завантажити та встановити його. Щоб перевірити, чи Node.js успішно встановлено, можна запустити команду npm -версія в інтерфейсі командного рядка (CLI), і він покаже вам версію Node.js у вашому комп'ютері (або ви можете запустити команду npm і подивитися, що відбувається).

(2) Щоб встановити інструмент JSHint, запустіть команду npm install jshint у CLI. Якщо ви хочете перевірити, чи успішно встановлено JSHint, запустіть команду jshint -version щоб переглянути його версію. Після завершення цього етапу встановлення завершено.

(3) Щоб запустити інструмент, перейдіть до каталогу CLI, де знаходиться ваш файл JavaScript (скажімо test.js) і запустіть команду jshint test.js. Результат аналізу інструмента на вашому JavaScript коді з'явиться (щось на зразок цього):

Через JavaScript API

(1) Завантажте стиснений файл із цього посилання GitHub і розпакуйте його. В dist Ви знайдете папку jshint Файл JS (бібліотека API).

(2) Щоб використовувати API, додайте jshint JS-файл до вашого проекту та пов'язати його з вашою сторінкою. Доступ до API можна отримати в JavaScript коді з використанням функції / об'єкт, званий JSHINT. Нижче наведено зразок HTML-коду, в якому JavaScript API JSHint використовується для аналізу JavaScript-коду, присутнього в джерело масиву та відображення результатів аналізу на сторінці.

(3) Ми пройшли джерело масив, що містить вихідний код JavaScript, який необхідно проаналізувати опції об'єкт, що містить опції linting (ми підемо в опції коротко) як параметри до JSHINT функції. Результат аналізу (об'єкт JSON) вибирається з JSHINTВластивість функції 's називається даних.

(4) JSON.Stringify використовується для відображення тільки тут, для відображення результату, що повертається з даних функція у форматі рядка на сторінці. The прикрашений Рядок JSON виглядає наступним чином. Виділені частини - це помилки, знайдені JSHint, сформульовані у простих реченнях.

Параметри Linting

Параметри linting дозволяють налаштувати процес linting. Ми можемо вказати, які типи помилок або wanring повинні бути linted, а які ні. У попередньому прикладі були використані два варіанти линзирования undef і невикористаний.

undef Опція flags недекларованих змінних, і невикористаний буде позначити змінні, які були оголошені, але ніколи не використовувалися. Подібно до цього, існує багато інших варіантів, які можна переглянути на цій сторінці, якщо ви хочете виконати пошук, у верхньому правому куті знаходиться рядок пошуку..

Якщо ви використовуєте інструмент CLI через Node.js, ви можете написати параметри linting всередині a package.json файл під власністю jshintConfig в тому ж каталозі. Ви також можете додати опції як директиви в коді JavaScript.

 // - test.js - / * jshint undef: true, unused: true * / foo (); a = 7;

Існує багато способів налаштування параметрів linting у вашому проекті на основі використовуваного інструменту. Перевірте різні способи конфігурації тут.