Java-lintimine JSHintiga

Närimine arvutiprogrammides on protsess staatiline analüüsi kood, et leida selliseid küsimusi nagu vale süntaks ja koodide kasutatav kasutamine. Lintimiseks kasutatav tööriist on tuntud kui a lint või linter. Üks linters, mis on täna JavaScript saadaval, on JSHint.

JSHint on saadaval mitme platvormi jaoks. Online veebitööriist, mida enamik meist on tuttav, asub aadressil jshint.com. Samuti on olemas käsurea tööriist Node.js kaudu, a JavaScript API, mitu tekstiredaktorit ja IDE-pluginaid JSHinti jaoks. Erinevate keskkondade JSHint tööriistade täieliku nimekirja leiate JSHinti veebisaidi allalaadimise ja installimise lehelt.

Vastavalt oma veebisaidile on kaks kõige tavalisemat viisi, kuidas JSHintit kasutatakse käsurea tööriist ja API. Vaatame, kuidas saate mõlemat alla laadida, koos teiste tööriistade linting optiosn'iga.

Käsurea tööriista abil

(1) Kui te ei ole arvutisse installinud Node.js-i, peate oma veebisaidi juurde minema ja laadima ja installima. Kontrollimaks, kas Node.js on edukalt installitud, saate käsu käivitada npm-konversioon käsurealiideses (CLI) ja see näitab teile Node.js'i versiooni teie arvutis (või saate lihtsalt käsu käivitada npm ja vaata, mis juhtub).

(2) JSHint-tööriista installimiseks käivitage käsk npm installige jshint CLI-s. Kui soovite kontrollida, kas JSHint on edukalt installitud, käivitage käsk jshint -versioon näha selle versiooni. Kui see samm on lõppenud, on installimine lõpetatud.

(3) Tööriista käivitamiseks minge kataloogi CLI-s, kus JavaScript-fail (nt test.js) on ja käivitab käsu jshint test.js. Ilmub teie JavaScripti koodi tööriista analüüsi tulemus (midagi sellist):

JavaScripti API kaudu

(1) Laadige selle GitHubi lingilt tihendatud fail lahti ja eemaldage see. In dist kaust leiad selle jshint JS-fail (API-raamatukogu).

(2) API kasutamiseks kasuta jshint JS-faili oma projektile ja linkige see oma lehele. API-d saab kasutada JavaScripti koodis, kasutades selleks valitud funktsiooni / objekti JSHINT. Allpool on näidis-HTML-kood, kus JSHindi JavaScript API-d kasutatakse, et analüüsida JavaScripti koodi, mis asub allikas kuvada ja kuvada lehel analüüsi tulemused.

(3) Me läksime allikas massiiv, mis sisaldab analüüsitavat JavaScript lähtekoodi ja võimalusi objekti, mis sisaldab linting võimalusi (me läheme võimalusi varsti) parameetritena JSHINT funktsiooni. Analüüsitulemus (JSON-objekt) pärineb JSHINTfunktsiooni omadust kutsutakse andmeid.

(4) JSON.stringify kuvatakse ainult siin kuvamiseks, et kuvada andmeid funktsioon stringi vormingus lehel. The kaunistatud JSON string näeb välja selline. Esiletõstetud osad on JSHinti poolt leitud lihtsad laused.

Linting Options

Linting valikud võimaldavad konfigureerida linting protsessi. Me saame täpsustada, millist tüüpi vigu või kahanemine peab olema värvitud ja mis ei ole. Eelmises näites kasutati kahte lintimisvõimalust undef ja kasutamata.

undef valiku puhul märgitakse deklareerimata muutujad ja kasutamata tähistab deklareeritud, kuid mitte kunagi kasutatud muutujaid. Nagu need, on palju rohkem võimalusi, mida näete selles lehes, kui soovite seda valikut otsida, paremas ülanurgas on otsinguriba.

Kui kasutate CLI-tööriista Node.js-i kaudu, saate kirjutusvahendite valikuid kirjutada a package.json faili all jshintConfig samas kataloogis. Valikud on võimalik ka JavaScripti koodi suunistena lisada.

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

Kasutatavast tööriistast lähtudes on teie projekti linting-valikuid võimalik rohkem konfigureerida. Vaadake erinevaid viise konfiguratsioon siin.