Mitä On Linter? Here ’ s a Definition and Quick-Start Guide

What is a linter? Lyhyesti sanottuna linteri on työkalu, jonka avulla voit parantaa koodia. Käsite linter ei ole yksinomainen JavaScript. Silti sanoisin, että suurin osa ihmisistä yrittää oppia puuvillalintterit ovat kiinnostuneita ne, jotka kohde JavaScript (tai, yleisemmin, dynaamisesti kirjoitettu kielellä.)

tämän päivän viestissä vastaamme nimikysymykseen, ja lisää. Aloitamme määrittelemällä termin ” linter.,”Ymmärrät, mikä tämä on ja miten se tapahtui. Sitten, puhumme eduista linters ja edetä puhua erilaisia tarkastuksia he tarjoavat.

Lopulta, näytämme sinulle useita esimerkkejä puuvillalintterit käytettävissänne, antaa joitakin käytännön vinkkejä siitä, miten päästä alkuun, ja wrap-up muutaman loppupäätelmät.

aloitetaan.

mikä on Linteri? A Brief Overview

Let ’ s start by defining what a linter is. Kuten olet lukenut johdannossa, linteri on työkalu, jonka avulla voit parantaa koodia. Mutta millä tavoin se tekee sen?, Vastaus on: analysoimalla lähdekoodisi etsivät ongelmia.

termi linteri tulee alun perin C-lähdekoodia analysoineesta työkalusta ”lint”. Tietojenkäsittelytieteilijä Stephen C. Johnson kehitti tämän apuohjelman vuonna 1978 työskennellessään Bell Labsissa.

Sekä alkuperäinen nukkaa työkalu, sekä aiemmin vastaavat apuohjelmia, tavoitteena oli analysoida lähdekoodin keksiä kääntäjä optimoinnit. Ajan myötä nukkamaiset työkalut alkoivat lisätä monia muita tarkastuksia ja todentamista.,

Kuitenkin, kuten olemme maininneet käyttöönoton aikana, puuvillalintterit eivät rajoitu koottu kieliä. Päinvastoin: voisimme sanoa, että linterit ovat paljon arvokkaampia tulkituille kielille, koska ei ole kääntäjää havaitsemaan virheitä kehitysaikana.

Edut Linting

Olet juuri oppinut määritelmä linter. Tiedät nyt myös, milloin tällainen työkalu keksittiin, ja kuka. Sinulla on luultavasti jo ainakin yleinen käsitys siitä, mitä linteri voi tehdä koodillesi., Mutta mitä hyötyä tämäntyyppisestä työkalusta on käytännön kannalta? Tässä muutamia:

• Vähemmän virheitä tuotannossa
• Luettavissa, huollettavissa ja johdonmukaisempaa koodi
• Vähemmän keskusteluja siitä, koodi tyyli ja esteettisiä valintoja koodi arvosteluja
• Tavoite mittaus koodin laatua
• Enemmän turvallinen ja suorituskykyinen koodi

seuraava osio kattaa joitakin tyyppisiä tarkastuksia, että puuvillalintterit tarjota. Kun olet lukenut sen, ymmärrät, miten linterit tarjoavat edellä mainitut edut.,

Tyyppisiä Tarkastuksia Puuvillalintterit Tarjota

Kuten olet juuri lukenut, alkuperäinen nukkaa työkalu analysoi koodia, jotta optimointeja kääntäjät, mutta ajan myötä kehittyneempiä ja täydellinen työkaluja vapautettiin. Nykyään meillä on lukemattomia erilaisia lintereitä, jotka tarjoavat monenlaisia tarkastuksia. Käydään ne nopeasti läpi.

Syntaksin Virheitä

alkeellisinta ja enemmän elintärkeitä tyyppi tarkistaa, että linter voi tarjota ovat syntax error tarkastukset, kun se tulee JavaScript ja muut tulkita kielillä., Kehittäjien ei pitäisi edes työntää koodia päälinjaan ilman, että se siirtää syntaksin tarkistuksia.

Yksi tapa tehdä tämä on käyttää pre-commit koukut, jotka estävät käyttäjiä ajaa heidän koodi, kun linter tarkastuksessa on ongelmia koodi.

Koodi Standardien Noudattaminen

Toinen tärkeä tyyppi tarkista, että puuvillalintterit on tarjota noudattamista koodaus standardeja. Jotkut saattavat pitää tätä puhtaasti esteettisenä huolena, mutta he olisivat väärässä., Ottaa yksi johdonmukainen koodaustyyli on hyödyllistä vähentää kognitiivista kuormitusta lukemisen, ymmärtämisen, ja ylläpitää koodia. Codebase, joka on johdonmukainen koodi tyyli on helpompi ymmärtää, ja kehittäjät, jotka käyttävät sitä on vähemmän todennäköisesti käyttöön vikoja.

siksi on puuvillalintterit, jotka ovat erikoistuneet tarkastaa codebases noudattamisen koodi tyylejä. Jotkut työkalut ovat opinionated, eli ne tulevat ennalta määritelty joukko sääntöjä ja yleissopimuksia, joita ei voida muuttaa., Toisaalta, on olemassa työkaluja, jotka voivat olla erittäin muokattavissa, jolloin käyttäjä voi mukauttaa työkalu heidän ensisijainen koodaus tyylejä.

mahdolliset ongelmat (alias koodin hajut)

koodin hajut ovat merkkejä siitä, että koodissasi saattaa olla jotain vikaa. On hämmästyttävän hyödyllistä olla työkalu tunnistaa nämä merkit automaattisesti, joten voit tutkia niitä edelleen, tarvittaessa.

esimerkiksi, monet ihmiset—myös minä—katsovat pitkään toiminnot koodi haju. Joten, voit määrittää linter tunnistaa toimintoja, jotka ovat pidempiä kuin tietty määrä rivejä.,

Toinen usein mainittu koodi haju on koodi, joka on liian monimutkainen. Mutta emme puhu monimutkaisuudesta subjektiivisesti, vaan hyvin objektiivisesti. Syklomaattinen kompleksisuus on hyödyllinen koodimittari, joka kuvaa mahdollisten suorituspolkujen määrää funktion sisällä. Puuvillalintterit voi laskea cyclomatic monimutkaisuutta toimintoja ja lippu niille, jotka ovat suurempi kuin tietty kynnys.

turvatarkastuksia

Viimeisenä mutta ei vähäisimpänä, meillä on turvallisuus, joka on epäilemättä kriittisin osa moderni sovellus, erityisesti web-sovellus., Saat sen väärin, ja seuraukset voivat olla katastrofaalisia, ei vain suhteen rahaa ja mainetta, mutta jopa oikeudellisista (ajatella yleisen tietosuoja-asetuksen ja vastaavia määräyksiä.)

Onneksi tämä on toinen alue, jossa puuvillalintterit voi olla apua, koska on olemassa työkaluja, jotka tarjoavat tärkeää turvallisuuden tarkastukset.

staattisen analyysin ymmärtäminen

olemme selittäneet, mitä linterit ovat ja miksi ne ovat hyödyllisiä. Olemme myös käsitelleet lintereiden päätyyppejä. Olet nyt valmis oppimaan joitakin esimerkkejä lintutyökaluista erilaisiin käyttötarkoituksiin ja kohdeohjelmointikieliin.,

Ennen kuin pääsemme sinne, vaikka, otetaanpa lyhyt harhauduttua puhua staattinen analyysi, koska tämä termi näkyy seuraavassa jaksossa, ja emme ole määritelleet sitä vielä.

So, what ’ s static analysis? Voit ajatella staattista analyysiä ennen ajamista debug. Staattinen analyysi koostuu käyttämällä työkaluja, jotka analysoivat lähdekoodin etsii virheitä, puute noudattaminen sääntöjä tai sopimuksia, tai muita mahdollisia ongelmia.

seuraava jakso esitetään esimerkkejä puuvillalintterit luokiteltu tyypin mukaan todentaminen he suorittaa., Staattiseen analyysiin luokitellut merkinnät viittaavat lähinnä edellä olevassa jaksossa lueteltuihin ensimmäisen ja kolmannen tyyppisiin lintereihin.

esimerkkejä Lintereistä

mainitaan nyt lyhyesti joitakin esimerkkejä lintereistä. Näytämme esimerkkejä eri ohjelmointikieliä, luokiteltuna tyypin tarkkailun ne tarjoavat. Muista, että jotkut työkalut voivat tarjota enemmän kuin yhden tyyppinen todentaminen, joten se on syy jotkut työkalut näkyvät useammassa kuin yhdessä luokassa.,>

StandardJS JavaScript

PHPMD PHP

StyleCop C#

Puuvillalintterit Turvallisuus

• Gosec Go
• Bandit Python
• LGTM useita kieliä, kuten JavaScript, Python, ja C#

Puuvillalintterit Koodausta Yleissopimusten / Koodaus Muotoilu

• Kauniimpi JavaScript
• Rubocop Ruby
• StyleCop C#

Puuvillalintterit JavaScript: Miten Päästä Alkuun

Ennen kuin voimme pukeutua artiklan, haluamme antaa sinulle lyhyt mutta käytännön opas siitä, miten päästä alkuun linting JavaScript., Koska se on JavaScript puhumme, se ei ole yllätys, että on olemassa monia työkaluja voit valita. Koska meidän on valittava yksi, menemme Eslintin kanssa.

Installing ESLint

First things first: let ’ s install the linter. ESLint on asennettu npm: n kautta, mikä tarkoittaa, että sinulla on oltava solmu.JS asennettu. Jos sinulla ei ole sitä, lataa se ja asenna se, jotta voimme jatkaa.

solmulla.JS asennettu, olemme valmiita asentamaan ESLint kautta npm., the following command:

However, this isn’t the approach recommended in their documentation., Sen sijaan ESLint kannattaa todennäköisesti asentaa projektikohtaisesti.,ory for your project:

Then, cd into the directory and run the command below to create a package.,JSON tiedosto(sitä tarvitaan tiellä.)

Npm pyytää sinua useita kysymyksiä., Vain paina enter käyttää oletusvastaus niille kaikille.,ei, suorittamalla:

Kun suoritat komennon edellä, ESLint kysyy, mitä haluat käyttää sitä., Vaihtoehdot ovat: tarkistaa vain syntaksi, tarkistaa syntaksi ja löytää ongelmia, ja tarkistaa syntaksi, löytää ongelmia ja valvoa koodin tyyli.

Let ’ s go with the last option. Käytä nuolinäppäimiä muuttaa vaihtoehtoja ja anna vahvistaa. ESLint haluaa sitten tietää, minkä tyyppisiä moduuleja projektisi käyttää. Vastaukset ovat:

• JavaScript-moduulit
• CommonJS Moduulit
• Mikään näistä

Valitse JavaScript-moduulien ja jatkaa. Sen jälkeen se kysyy, mitä kehystä projektisi käyttää., Vastauksia, jälleen, on kolme:

• Reagoi
• Vue
• Mikään näistä

Tässä tapauksessa, katsotaanpa valita ”ei mitään” vaihtoehto. Seuraava kysymys on ”kyllä / ei” kysymys: käyttääkö projektisi kirjoitusvirhettä? Paina” N ” ei. Sen jälkeen se kysyy, toimiiko koodi selaimessa vai solmussa.

ESLint kysyy sitten, miten valita tapa määritellä projektille koodityyli. Se tarjoaa sinulle kolme mahdollisuutta: käyttää suosittu tyyli opas, vastaamalla kysymyksiin, tyyli mieltymykset, tai tarkastaa oman .JS-tiedostoja. Valitse ensimmäinen vaihtoehto., Sitten sinua pyydetään valitsemaan kolmesta tyylistä: AirBNB, Standard ja Google. Tätä opetusohjelma, Let ’ s pick Google.

ESLint kysyy sitten, minkä formaatin asetuksellesi haluat. Valitse YAML. Lopuksi, kun kysytään, haluatko ladata valitun koodin tyyli käyttäen npm, vastaa ” kyllä.”

Käyttämällä ESLint Tarkistaa Tiedosto

Kun lataus on valmis, olet valmis käyttämään ESLint tarkistaa tiedoston. Mutta siihen tarvitaan tiedosto tarkistettavaksi. Jos sinulla sattuu olemaan .JS-tiedosto roikkuu jossain, kopioi se projektihakemistoon., Vaihtoehtoisesti voit kopioida tämän arkiston, joka sisältää yhden tiedoston, ja käyttää sitä oman testauksen.,

jos Haluat tarkistaa tiedoston, voit käyttää seuraavaa komentoa:

Tämä on tulos saan käynnissä komento suunnattujen tervehdyksen.,js-tiedosto voit ladata arkistosta GitHub:

Kuten näette, Minulla on kolme virheitä eikä varoituksia.

mikä on Linteri? Loistava työkalu Työkaluvelttiisi

tässä viestissä olemme tutkineet linterityökalun käsitettä. Nyt sinulla on vankka käsitys siitä, mitä linterit ovat ja miksi sinun pitäisi hyväksyä yksi., Lisäksi, olet oppinut erilaisia linter työkaluja ja esimerkkejä kunkin luokan, kohdistaminen useita eri ohjelmointikieliä.

kaiken tämän lisäksi nyt tiedät, miten pääset alkuun suositulla JavaScript-linkkityökalulla: ESLint.

mitkä ovat seuraavat vaiheet?, On olemassa useita asioita, voit oppia, miten tehdä seuraavan:

• Poista säännöt
• ota Käyttöön sääntö, kuten varoitus tai virhe
• Integroida linting omaan rakentaa prosessi
• Advanced configuration vaihtoehto
• Luo muokatun säännöt

Voit tietysti myös kokeilla muita puuvillalintterit. Vaikka olemme valinneet eslintin oppaaksi, se ei tarkoita, että sinun pitäisi juuttua siihen.

Lopuksi, älä unohda, että linting, kun taas uskomattoman arvokkaita, on vain yksi ase teidän arsenaali., Sinun ei pitäisi unohtaa automatisoitu testaus, koodi tarkistaa, refaktorointi, ja monia muita käytäntöjä, tekniikoita ja työkaluja käytettävissänne loputon taistelu kaaosta vastaan oman codebase.

Ja kaikista käytäntöjä, tekniikoita ja työkaluja, voit hyödyntää tehdä codebase paremmin, emme voi auttaa, mutta yhden pois end-to-end testaus, joka on usein unohdetaan tyyppinen testaus. Se on sääli. Oikea työkalu auttaa sinua, laatu end-to-end testaus voi olla voimakas liittolainen kamppailussa koodi entropy.