Linting JavaScript pomocí JSHint

Linting v počítačovém programování je proces statický analytický kód k nalezení problémů, jako je špatná syntaxe, a iffy použití kódu. Nástroj používaný pro obkládání je znám jako a lint nebo linter. Jeden z linters dostupných pro JavaScript dnes je JSHint.

JSHint je k dispozici pro více platforem. Online webový nástroj, se kterým se většina z nás seznámí, je na webu jshint.com. Tam jsou také nástroj příkazového řádku přes Node.js, A JavaScript API, více textových editorů a IDE pluginů pro JSHint. Úplný seznam dostupných nástrojů JSHint naleznete na stránce pro stahování a instalaci webové stránky JSHint.

Podle jeho webové stránky, dva nejběžnější způsoby, jak se používá nástroj JSHint jsou jako nástroj příkazového řádku a API. Pojďme se podívat na to, jak si můžete stáhnout obojí, spolu s dalšími linting optiosn nástroje poskytují.

Pomocí nástroje příkazového řádku

(1) Pokud nemáte ve svém počítači nainstalovaný Node.js, budete muset jít na jeho webovou stránku a nejprve si jej stáhnout a nainstalovat. Chcete-li zkontrolovat, zda byl Node.js úspěšně nainstalován, můžete příkaz spustit npm - konverze v rozhraní příkazového řádku (CLI) a ukáže vám verzi Node.js ve vašem počítači (nebo můžete příkaz spustit pouze npm a uvidíme, co se stane).

(2) Chcete-li nainstalovat nástroj JSHint, spusťte příkaz npm install jshint v CLI. Pokud chcete zkontrolovat, zda byl JSHint úspěšně nainstalován, spusťte příkaz jshint - konverze zobrazit jeho verzi. Po dokončení tohoto kroku je instalace dokončena.

(3) Chcete-li nástroj spustit, přejděte do adresáře v CLI, kde se nachází váš soubor JavaScript (řekněme test.js) je a spusťte příkaz jshint test.js. Zobrazí se výsledek analýzy nástroje na vašem kódu JavaScript (něco takového):

Prostřednictvím rozhraní API jazyka JavaScript

(1) Stáhněte komprimovaný soubor z tohoto odkazu GitHub a rozbalte jej. V dist složku najdete jshint Soubor JS (knihovna API).

(2) Chcete-li použít rozhraní API, přidejte jshint JS soubor do vašeho projektu a odkaz na vaši stránku. K rozhraní API lze přistupovat v kódu JavaScript pomocí funkce / objektu nazvaného JSHINT. Níže je ukázkový HTML kód, kde se JavaScript JSHint používá k analýze kódu JavaScriptu obsaženého v zdroj pole a zobrazí výsledky analýzy na stránce.

(3) Prošli jsme zdroj pole obsahující zdrojový kód JavaScriptu, který má být analyzován a možností objekt obsahující volby lintingu (půjdeme do možností krátce) jako parametry JSHINT funkce. Výsledek analýzy (objekt JSON) je převzat z JSHINTfunkce volal funkce data.

(4) JSON.stringify se používá pro zobrazení pouze zde, pro zobrazení výsledku vráceného z data funkce ve formátu řetězce na stránce. zkrášlený Řetězec JSON vypadá takto. Zvýrazněné části jsou chyby, které nalezl JSHint v jednoduchých větách.

Možnosti upínání

Volby lintingu nám umožňují nastavit proces lintingu. Můžeme specifikovat, který typ chyb nebo wanring je třeba vložit a které ne. V předchozím příkladu byly použity dvě možnosti obložení undef a nepoužitý.

undef volba označí nedeklarované proměnné a nepoužitý bude označovat proměnné, které byly deklarovány, ale nikdy nebyly použity. Podobně jako mnoho dalších možností, které můžete vidět na této stránce, můžete v pravém horním rohu vyhledat vyhledávací panel..

Používáte-li nástroj CLI přes Node.js, můžete napsat možnosti vkládání uvnitř package.json souboru jshintConfig ve stejném adresáři. Volby můžete také přidat jako direktivy v kódu JavaScript.

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

Existuje více způsobů, jak konfigurovat možnosti lintingu v projektu na základě používaného nástroje. Podívejte se na různé způsoby konfigurace tady.