Mi a szöszökés és hogyan takaríthat meg időt?

A szoftverfejlesztés egyik legnagyobb kihívása az idő. Olyan dolog, amiből könnyen nem tudunk többet elérni, de a szöszökés segíthet a lehető legtöbbet kihozni a rendelkezésünkre álló időből.

Tehát mi a szöszös?

A lint vagy a linter olyan eszköz, amely a forráskódot elemzi a programozási hibák, hibák, stílushibák és gyanús konstrukciók megjelölésére. //hu.wikipedia.org/wiki/Lint(software)

Egyszerűen fogalmazva: a linter egy olyan eszköz, amely programszerűen beolvassa a kódot azzal a céllal, hogy olyan problémákat találjon, amelyek hibákhoz vagy inkonzisztenciákhoz vezethetnek a kód állapotával és stílusával kapcsolatban. Néhányan még segíthetnek nekik is javítani őket!

Vegyük például a következő példát:

const test = 'I am a test'; console.log(`Test: ${test}`); const test = 'Another one.';

testKétszer deklaráljuk az állandót , aminek javascript motorunk nem fog örülni. A megfelelő linter beállításokkal és az óra konfigurálásával ahelyett, hogy később hibaként ragadnánk meg a kód futtatásakor, azonnal hibát kap a háttérben futó linter révén:

 10:9 error Parsing error: Identifier 'test' has already been declared 8 | const test = 'I am a test'; 9 | console.log(`Test: ${2}`); > 10 | const test = 'Another one.'; | ^

Lehet, hogy elég nyilvánvaló, hogy 2 ugyanaz a constdeklaráció van, mivel ez csak 3 sor, de egy bonyolultabb alkalmazásban ez rengeteg időt takaríthat meg, amikor egy bosszantó hibát kell vadászni, ami nem mindig nyilvánvaló.

Miben segíthet a szöszmötlés?

Sok minden, többek között, de nem kizárólag:

  • Hibák megjelölése a kódban szintaxis hibákból
  • Figyelmeztetéseket adunk, ha a kód nem biztos, hogy intuitív
  • Javaslatok nyújtása a bevált gyakorlatokra vonatkozóan
  • A TODO és a FIXME nyomon követése
  • Állandó kódstílus megtartása

A legtöbb dolog, amire gondolhat, valószínűleg már létezik ilyen vagy olyan formában, és ha nem, akkor akár egyedi szabályokat is létrehozhat, amelyek megfelelnek az Ön igényeinek!

Hogyan segít ez valójában, vagy miért érdekelne?

A fenti lista valószínűleg a legfőbb témája az a tény, hogy ezeket a kérdéseket azonnal felhívják. Ezek a problémák már nem fognak feltűnni az alkalmazás futtatása közepette, és nem okoznak szorongást valakinek a kód felülvizsgálata során. Ön és véleményezője többé nem fog végtelenül agresszívan harcolni passzívan, a megjegyzésekkel kapcsolatban, hogy pontosvesszőt kell-e beilleszteni a JS-állítások végébe (kellene?).

Mindazok a pillanatok, amelyek megakadályozzák a termelékenységet egy ostoba szintaxis hiba vagy az Ön és csapattársai által a felülvizsgálat során tapasztalt mikrointerakciók miatt, időbe telik. Összeadódnak, és végül elveszik azt az időt, amelyet egy újabb hiba kijavításához vagy a termék következő nagyszerű tulajdonságának fejlesztéséhez fordíthat.

Szóval hogyan kezdjem el?

Annak ellenére, hogy vannak poszterek a legtöbb, ha nem az összes többi mainstream nyelv számára, e bejegyzés céljából a Javascriptre fogok összpontosítani. Ugyanezek az elvek érvényesek, de a szerszámozás kissé eltérhet.

Át fogom vizsgálni, hogyan lehet beállítani az alapvető szöszökést a React alkalmazásban. Könnyedén nyomon követheti saját React alkalmazásának felpörgetésével vagy a Gatsby indítóm használatával: //github.com/colbyfayock/gatsby-starter-sass#starting-from-scratch

Lintered

A kezdéshez először szükségünk van egy lintra. Valószínűleg a legnépszerűbb a Javascript világban az ESLint. A linter valójában a szabályok meghatározásának és a fájlok elemzésének motorja lesz. Az ESLint önmagában npm csomagként érhető el, és a telepítés után a dobozból lehetővé teszi, hogy beállítson egy alapvető konfigurációs fájlt, és néhány parancssori eszközzel fusson a földre.

Először adjuk hozzá az ESLint függőségünket:

yarn add eslint -D

Ezt telepítjük devDependency(ezért a -Dzászló), mert az alkalmazásunknak nem erre van szüksége. Miután sikeresen telepítette, adjuk hozzá package.jsonszkriptként:

... "scripts": { ... "lint": "eslint . --ext .js" ... }, ...

A fentiekben futtatjuk a lintert a teljes projektkönyvtárban minden olyan fájlnál, amelynek kiterjesztése van .js. Ha egy nagy, sok fájltípussal rendelkező projekttel dolgozik, esetleg még olyanokat is, amelyeket nem szeretne szálkásítani, megváltoztathatja a jelzőt, vagy konkrétabb lehet más lehetőségekkel.

Az ESLint támogatásához még egyet kell tennünk. Adjunk hozzá egy fájlt a projektünk gyökeréhez (valószínűleg ott, ahol package.jsonvan), .eslintrc.jsés egyszerűen állítsuk elő a fájl tartalmát:

module.exports = {};

Ha készen áll, futtathatja yarn lintés… hibát kaphat.

Ez rendben van, és ez várható a projektünkben, úgyhogy lépjünk tovább.

Az elemzője

A Javascript-fejlesztők számára a lánc egyik általános eszköze a Babel, amely lehetővé teszi olyan kódok írását, amelyek nem minden böngészőben támogatottak, például az ES6-ban elérhető nyílfüggvények használatával és más konvenciókkal, például a fájlok importálásával import.

Lehet, hogy az általad írt kód már fut a Babelben, hogy működjön egy böngészőben, de ez alapértelmezésben nem vonatkozik az ESLint-re, így az ESLint lehetővé teszi egy olyan elemző megadását, amely lehetővé teszi, hogy a szöszös feldolgozás ugyanazt a kódot nézze meg, amelyet a böngésző lát. Ebben az esetben a Babel általunk rendelkezésére bocsátott ESLint elemzőt akarjuk használni.

Ennek beállításához először telepítenünk kell a függőségünket:

yarn add babel-eslint -D

Typically if you're using babel-eslint you'll want to make sure babel is installed next to it, but in our case, Gatsby already uses babel, so we don’t necessarily need to add it. After that’s set up, we’ll want to update our .eslintrc.js config file with some new options:

module.exports = { "env": { "browser": true, "node": true, "es6": true }, "parser": "babel-eslint" };

Here, we’re letting ESLint know that our environment will be run in node (Gatsby’s precompiling), inside the browser (the app), and it will use ES6. This helps ESLint know how to run your code. Additionally, we want to set up our parser to be babel-eslint.

Once we’re ready to go, run yarn lint again and… well nothing really happened.

This is still expected, as we don’t have any rules set up!

Plugins for your code

Writing a React app? The Babel parser may help you transform your code, but you might have a hard time being productive, as ESLint needs to understand how it should work to lint your React files.

Part of the beauty of ESLint is that it allows you to configure plugins that have the opportunity to create and set rules for you. Luckily, along with our Babel parser above that does some of the heavy lifting, we have a React plugin available that does just that and takes care of linting the JSX for us.

Let’s first install our dependency:

yarn add eslint-plugin-react -D

Further, let’s update our .eslintrc.js file again:

module.exports = { "settings": { "react": { "version": "detect" } }, "env": { "browser": true, "node": true, "es6": true }, "plugins": [ "react" ], "parser": "babel-eslint" };

What we’re adding here is a setting that automatically detects what React version you’re using, which is helpful to let your linting get parsed properly, and then set up our react plugin that we installed above.

For one last final time, we will run our lint script and get nothing:

Rules defined by others’s opinions

If you’re not really sure where to get started or just want to quickly get up and running, it’s recommend that you enable ESLint’s own recommended rules. Let’s add this to our .eslintrc.js config file:

module.exports = { "settings": { "react": { "version": "detect" } }, "env": { "browser": true, "node": true, "es6": true }, "plugins": [ "react" ], "extends": [ "eslint:recommended" ], "parser": "babel-eslint" };

And let’s run our yarn lint.

Woah! This will immediately give you a lot errors, it seems like something’s wrong.

Since we’re running a React app, we also want to make sure our linter understands the rules it should follow, so let’s also add our React plugin to the .eslintrc.js config setup:

 "extends": [ "eslint:recommended", "plugin:react/recommended" ],

Now if you run yarn lint, you get something a little more logical.

If you’re following along, it looks like our starter app had a misplaced semicolon and a missing prop in our propTypes validation for Layout.js. Writing this helped me fix my own repo! ?

Going further, if those don’t seem to fit your needs, lots of developers and teams have published their own configurations that ESLint allows you to easily tap into.

Some popular ones include:

  • Airbnb’s config
  • Semistandard
  • Google’s JS Style Guide

Not happy with the options available? You can even create and publish your own to either layer on top of others as a starting point or give it a go from scratch.

Let it do the work (most of it)

You don’t think I’m going to make you fix all of those thing yourself do you? Well, you may have to fix some, but let’s try to get ESLint to fix some of it for us.

If you noticed after we ran the command above, ESLint gave us an extra message:

So let’s give it a try! Let’s run:

yarn lint --fix

And what do you know, it now only gives us 1 linting error.

Turns out ESLint was able to fix our semicolon issue automatically, but we’ll still have to add pageName to our Layout’s propTypes manually, not too much of a lift.

Running one more time and finally nothing again! But this time because everything's looking good.

Go forth and write messy code!

Kidding ? The good news here, is now you can easily take a look at the general health of your codebase as well as hopefully fix most of it automatically. This is going to save a lot of headaches as you work with others on your team, and generally, it’s nice to have all of your code neat and tidy.

This post is just getting started. ESLint is a wide open book with tons of plugins and rules, and it’s not the only linting tool in the game. Play around and find what fits best for you and your team. The little time spent configuring it to your app will save you lots more time in the long run.

Other linting tools to check out

  • JSHint: an alternative to ESLint
  • Stylelint: a linting tool for CSS and CSS-like syntaxes like Sass
  • Awesome ESLint: a simple list of awesome configs, parsers, plugins, and other tools to boost your ESLint game
  • Webhint: linting tool for accessibility, speed, and more website best practices
  • A11y JSX Plugin: ESLint plugin for checking accessibility rules on JSX elements

Follow me for more Javascript, UX, and other interesting things!

  • ? Follow Me On Twitter
  • ?️ Subscribe To My Youtube
  • ✉️ Sign Up For My Newsletter

Originally published at //www.colbyfayock.com/2019/10/what-is-linting-and-how-can-it-save-you-time