Linting JavaScript s JSHint
nepĺzne v počítačovom programovaní je proces statický analytický kód na nájdenie problémov, ako je nesprávna syntax a uspokojenie používania kódu. Nástroj používaný na linting je známy ako a cupanina alebo linter. Jedným z linters k dispozícii pre JavaScript dnes je JSHint.
JSHint je k dispozícii pre viaceré platformy. Online webový nástroj, ktorý väčšina z nás pozná, je na adrese jshint.com. K dispozícii je tiež nástroj príkazového riadku cez Node.js, API jazyka JavaScript, viacerých textových editorov a plug-inov IDE pre JSHint. Úplný zoznam dostupných nástrojov JSHint pre rôzne prostredia nájdete na stránke sťahovania a inštalácie webovej stránky JSHint.
Podľa jeho webovej stránky sú dva najbežnejšie spôsoby, ako sa používa nástroj JSHint, ako nástroj príkazového riadku a API. Poďme sa pozrieť na to, ako si môžete stiahnuť použitie oboch, spolu s ďalšími lusting optiosn nástroje poskytujú.
Pomocou príkazového riadku
(1) Ak nemáte Node.js nainštalovaný vo vašom počítači, potom budete musieť ísť na jeho webovú stránku a prevziať a nainštalovať najprv. Ak chcete skontrolovať, či bol Node.js úspešne nainštalovaný, môžete spustiť príkaz npm -version
v rozhraní rozhrania príkazového riadka (CLI) a zobrazí vám vo vašom počítači verziu Node.js (alebo môžete len spustiť príkaz NPM
a uvidíte, čo sa stane).
(2) Ak chcete nainštalovať nástroj JSHint, spustite príkaz npm nainštalovať jshint
v CLI. Ak chcete skontrolovať, či bol JSHint úspešne nainštalovaný, spustite príkaz jshint -version
vidieť jeho verziu. Keď tento krok skončí, inštalácia je dokončená.
(3) Ak chcete spustiť nástroj, prejdite do adresára CLI, kde sa nachádza súbor JavaScript (povedzme test.js) a spustite príkaz jshint test.js
. Výsledok analýzy nástroja v kóde JavaScript sa zobrazí (niečo podobné):
Prostredníctvom rozhrania JavaScript API
(1) Prevezmite komprimovaný súbor z tohto odkazu na GitHub a rozbaľte ho. V dist priečinok nájdete jshint Súbor JS (knižnica API).
(2) Ak chcete použiť API, pridajte jshint JS súboru do projektu a prepojiť ho s vašou stránkou. Rozhranie API je možné získať v kóde JavaScript pomocou funkcie / objektu nazvaného JSHINT
. Nižšie je uvedený vzorový kód HTML, v ktorom sa rozhranie JSHint JavaScript API používa na analýzu kódu JavaScript v súbore zdroj
a zobrazí výsledky analýzy na stránke.
dokument
(3) Prešli sme zdroj
pole obsahujúce zdrojový kód jazyka JavaScript, ktorý sa má analyzovať a možnosti
objekt obsahujúci možnosti lintingu (ideme do možnosti krátko) ako parametre pre JSHINT
Funkcie. Výsledok analýzy (objekt JSON) je odčítaný JSHINT
Vlastnosť funkcie nazvaná dáta
.
(4) JSON.stringify
sa používa na zobrazenie len tu, aby sa zobrazil výsledok vrátený z dáta
funkcia vo formáte reťazca na stránke. skrášlený Reťazec JSON vyzerá takto. Zvýraznené časti sú chyby nájdené v JSHint v jednoduchých vetách.
Možnosti lintingu
Možnosti lintingu nastavíme proces lakovania. Môžeme špecifikovať, ktorý typ chýb alebo wanring je potrebné preložiť a ktoré nie. V predchádzajúcom príklade boli použité dve možnosti lintingu undef
a nepoužívaný
.
undef
voľby príznakov nenahlásených premenných a nepoužívaný
bude označovať premenné, ktoré boli deklarované, ale nikdy neboli použité. Rovnako ako je tu mnoho ďalších možností, ktoré môžete vidieť v zozname na tejto stránke, ak chcete vyhľadať nejakú možnosť, v pravom hornom rohu je vyhľadávacia lišta.
Ak používate nástroj CLI cez Node.js, môžete zapísať možnosti linting do a package.json
súbor v rámci vlastníctva jshintConfig
v tom istom adresári. Možnosti môžete tiež pridať ako smernice v kóde JavaScript.
// - test.js - / * jshint undef: true, nepoužité: true * / foo (); a = 7;
Existuje viacero spôsobov, ako môžete konfigurovať možnosti vytvárania farieb vo vašom projekte na základe nástroja, ktorý používate. Pozrite sa na rôzne spôsoby konfigurácia tu.