Linting JavaScript med JSHint

linting i dataprogrammering er prosessen med statisk analyse kode for å finne problemer som feil syntax og iffy bruk av kode. Verktøyet som brukes til linting er kjent som en lo eller linter. En av linters tilgjengelig for JavaScript i dag er JSHint.

JSHint er tilgjengelig for flere plattformer. Det elektroniske nettverktøyet som de fleste av oss er kjent med, er på jshint.com. Det er også kommandolinjeværktøy via Node.js, en JavaScript API, flere tekstredigerere og IDE-plugins for JSHint. Du kan se hele listen over tilgjengelige JSHint-verktøy for forskjellige miljøer i nedlastings- og installasjonssiden på JSHint-nettstedet.

Ifølge nettstedet er de to vanligste måtene JSHint-verktøyet brukt som kommandolinjeværktøy og API. La oss ta en titt på hvordan du kan laste ned bruk begge, sammen med andre linting optiosn verktøyene gir.

Via kommandolinjeverktøyet

(1) Hvis du ikke har Node.js installert på datamaskinen din, må du gå på nettsiden og laste ned og installere den først. For å sjekke om Node.js er installert, kan du kjøre kommandoen npm-versjon i kommandolinjegrensesnittet (CLI), og det vil vise deg versjonen av Node.js i datamaskinen din (eller du kan bare kjøre kommandoen NPM og se hva som skjer).

(2) For å installere JSHint-verktøyet, kjør kommandoen npm installere jshint i CLI. Hvis du vil sjekke om JSHint er installert, kjør du kommandoen jshint-versjon for å se sin versjon. Når dette trinnet er over, er installasjonen fullført.

(3) For å kjøre verktøyet, gå til katalogen i CLI der JavaScript-filen din (si test.js) er og kjører kommandoen jshint test.js. Resultatet av verktøyets analyse på JavaScript-koden din vil vises (noe som dette):

Via JavaScript API

(1) Last ned den komprimerte filen fra denne GitHub-lenken, og pakke den ut. I dist mappe finner du jshint JS-fil (API-biblioteket).

(2) For å bruke API, legg til jshint JS-fil til prosjektet ditt og lenke det til din side. API-en kan nås i JavaScript-koden ved hjelp av funksjonen / objektet som heter JSHINT. Nedenfor er et eksempel HTML-kode hvor JSHint's JavaScript API brukes til å analysere JavaScript-koden til stede i kilde array og vise analyseresultatene på siden.

(3) Vi passerte kilde array som inneholder JavaScript kildekoden som skal analyseres og opsjoner objekt som inneholder linting-alternativer (vi går inn i opsjoner kort) som parametere til JSHINT funksjon. Analyseresultatet (et JSON-objekt) hentes fra JSHINTFunksjonsegenskap kalt data.

(4) JSON.stringify brukes kun til visning her, for å vise resultatet returnert fra data Fungerer i strengformat på siden. De kjønnet JSON-streng ser slik ut. De uthevede delene er feilene funnet av JSHint formulert i enkle setninger.

Linting Options

Linting-alternativer lar oss konfigurere linting-prosessen. Vi kan spesifisere hvilken type feil eller wanring som skal linted og hvilke som ikke gjør det. I det forrige eksemplet ble det brukt to lintingalternativer udef og ubrukt.

udef alternativ flagger undeclared variabler, og ubrukt vil flagge variabler som ble erklært, men aldri brukt. Som disse er det mange flere alternativer som du kan se en liste over på denne siden, hvis du vil søke etter et alternativ, finnes det en søkefelt som finnes øverst til høyre.

Hvis du bruker CLI-verktøyet via Node.js, kan du skrive lintingalternativene i a package.json fil under eiendommen jshintConfig i samme katalog. Du kan også legge til alternativene som direktiver i JavaScript-koden.

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

Det er flere måter å konfigurere linting-alternativer på i prosjektet, basert på verktøyet du bruker. Sjekk ut de forskjellige måtene for konfigurasjon her.