Linting JavaScript med JSHint

ludd i datorprogrammering är processen av statisk analyskod för att hitta problem som fel syntax och iffy användning av kod. Det verktyg som används för linting är känt som a ludd eller slinter. En av de linters som är tillgängliga för JavaScript idag är JSHint.

JSHint är tillgängligt för flera plattformar. Det online-webbverktyg som de flesta av oss är bekanta med är på jshint.com. Det finns också kommandoradsverktyget via Node.js, en JavaScript API, flera textredigerare och IDE-plugins för JSHint. Du kan se den fullständiga listan över tillgängliga JSHint-verktyg för olika miljöer på nedladdnings- och installationssidan på JSHint-webbplatsen.

Enligt webbplatsen är de två vanligaste sätten JSHint-verktyget används som kommandoradsverktyget och den API. Låt oss ta en titt på hur du kan ladda ner användningen både, tillsammans med andra lintingoptioner som verktygen ger.

Via kommandoradsverktyget

(1) Om du inte har Node.js installerat på din dator måste du gå till sin webbplats och hämta och installera den först. För att kontrollera om Node.js har installerats kan du köra kommandot npm-version i kommandoradsgränssnittet (CLI) och det visar dig versionen av Node.js i din dator (eller du kan bara köra kommandot npm och se vad som händer).

(2) För att installera JSHint-verktyget, kör kommandot npm installera jshint i CLI. Om du vill kontrollera om JSHint har installerats, kör kommandot jshint -version för att se dess version. När detta steg är över är installationen klar.

(3) För att köra verktyget, gå till katalogen i CLI där din JavaScript-fil (säg test.js) är och kör kommandot jshint test.js. Resultatet av verktygets analys på din JavaScript-kod kommer att visas (något liknande detta):

Via JavaScript API

(1) Hämta den komprimerade filen från den här GitHub-länken och packa upp den. I dist mapp hittar du jshint JS-fil (API-biblioteket).

(2) För att använda API: n, lägg till jshint JS-filen till ditt projekt och länka den till din sida. API: n kan nås i JavaScript-koden med funktionen / objektet som heter JSHINT. Nedan finns ett exempel på HTML-kod där JSHints JavaScript API används för att analysera JavaScript-koden som finns i källa array och visa analysresultatet på sidan.

(3) Vi passerade källa array som innehåller JavaScript källkoden som ska analyseras och alternativ objekt som innehåller linting-alternativ (vi går in i alternativ inom kort) som parametrar till JSHINT fungera. Analysresultatet (ett JSON-objekt) hämtas från JSHINTfunktionsegenskap som heter data.

(4) JSON.stringify används endast för visning här, för att visa resultatet som returneras från data funktionen i strängformat på sidan. De beautified JSON-strängen ser ut så här. De markerade delarna är de fel som hittades av JSHint formulerad i enkla meningar.

Linting Options

Linting alternativ låt oss konfigurera linting processen. Vi kan ange vilken typ av fel eller störning som behöver lintas och vilka som inte gör det. I det föregående exemplet användes två lintingalternativ nämligen undef och oanvänd.

undef alternativ flaggor odeklarerade variabler, och oanvänd kommer att flagga variabler som deklarerades men aldrig använts. Liksom dessa finns det många fler alternativ som du kan se en lista med på den här sidan, om du vill söka ett alternativ finns det en sökfält som finns längst upp till höger.

Om du använder CLI-verktyget via Node.js kan du skriva lintalternativen inuti a package.json fil under egenskapen jshintConfig i samma katalog. Du kan också lägga till alternativen som direktiv i JavaScript-koden.

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

Det finns flera sätt att konfigurera lintingalternativ i ditt projekt baserat på verktyget du använder. Kolla in de olika sätten för konfiguration här.