Jaké užitečné nástroje ti pomohou s psaním clean codu?

Jedním z nejčastějších problémů, který trápí většinu programátorů, je držet se zásady clean code. Tento neduh je spojován se začátkem nového projektu, jenž často bývá našponovaný různými termíny. V těchto případech jdou osvojené postupy stranou a starost o clean code je až na posledním místě.

Vývojáři zapomínají na to, že správně a jednoduše napsaný kód jednak usnadní vývoj a jednak je významný pro následující úpravy či aktualizace. Clean code je důležitý nejen pro člověka, jenž kód aplikace píše, ale zejména usnadňuje práci kolegům, kteří se na vývoji podílí. Dobře napsaný kód často bývá neocenitelným pomocníkem při hledání chyb.

Co je clean code?

Udržování clean codu vyžaduje přijetí různých opatření. Kód musí být dostatečně přehledný a srozumitelný i po vizuální stránce. Pro vývojáře to nejčastěji znamená správné odsazení, které je nezbytné pro zvýraznění různých částí a logické struktury kódu. Zapomínat by se nemělo ani na názvy proměnných, tříd, funkcí a metod. 

Vše je potřeba popsat výstižně, aby každý vývojář pochopil, co vybraná část kódu dělá. Komentáře by měly být redukovány na nezbytné minimum. Pokud budou funkce, třídy a další části pojmenovány správně, není potřeba komentovat každou deklaraci. Stačit by proto měl jediný komentář, který popíše obecnou logiku třídy nebo složitost funkce.

Nástroje, které ti pomohou s tvým kódem

Držení se zásad clean codu může být složité, a to nejen pro začátečníky. Proto se podíváme na pár nástrojů, které ti pomohou psát lepší kód. Díky nim dokážeš udržet krok i s ostřílenými kolegy.

Prettier

Nástroj Prettier umožňuje formátovat kód specifickým i automatizovaným způsobem. Pro úpravu konfiguračního souboru tak můžeš zadat pravidla formátování, která se aplikují na tvůj kód, kdykoliv to bude potřeba.

Používání nástroje Prettier je snadné a využívá se pro čištění již napsaného kódu. Ušetříš tak čas a energii, kterou bys jinak musel*a vynaložit na případnou editaci.

Proč využít Prettier?

• Vyčistí stávající kódovou základnu pomocí zadání jednoho příkazového řádku.
• Dokáže pracovat s širokou škálou kódovacích stylů a díky tomu, že jde o open source, tak se na jeho vývoji podílí především komunita.
• Pomůže ti soustředit se na psaní kódu a jeho logiku, zatímco Prettier za tebe kód naformátuje do potřebné podoby.
• Začínajícím vývojářům pomůže udržet krok se zkušenějšími kolegy, a to zejména v oblasti clean codu.
• Dokáže zvýšit tvou produktivitu práce.

ESLint

Nástroj ESLint slouží ke statické analýze tvého kódu a využiješ ho zejména k nalezení problematických vzorů nebo částí, které se odchylují od stanovených stylových požadavků. 

ESLint se především zaměřuje na programovací jazyk JavaScript, který je specifický svou dynamičností a volnou jazykovou strukturou náchylnou k nežádoucím chybám. ESLit ti umožňuje najít syntaktické a jiné chyby, aniž by bylo potřeba spouštět soubor js.

Proč využít ESLint?

Pomocí ESLint získáš možnost úplného přizpůsobení toho, jak má tvůj kód vypadat. Pracovat také můžeš s různými pravidly, které se dají volně přidávat, nastavovat a aktivovat. Snadno tak získáš požadovaný formát, styl i kvalitu kódu. Dokážeš si tak individuálně přizpůsobit to, na co se chceš v rámci programování v JavaScriptu zaměřit:

• Pomáhá odhalit chyby, nekonzistentnost a špatné praktiky v rámci tvého kódu.
• Zlepší čitelnost, srozumitelnost a zejména udržitelnost kódu při budoucích úpravách.
• ESLint podporuje různé konfigurace, plungy a rozšíření pro přizpůsobení analýzy kódu.
• Využiješ ho při programování webové aplikace, knihoven, frameworků nebo jiných nástrojů v JavaScriptu.

Husky

Nástroj Husky ti umožní spouštět předdefinované skripty, než je pošleš do Gitu, přesněji před nebo po akci v Git hooks, jako je commit nebo push. To ti poskytuje velkou výhodu, protože si můžeš zkontrolovat formátování kódu, spustit vlastní test a také opravit některé chyby, než vše uložíš. Máš tak naprostou jistotu, že tvůj kód je čistý a konzistentní.

Proč využít Husky?

• Husky výrazně ulehčí práci s Gitem.
• Zabraňuje tomu, aby se do vzdáleného repozitáře dostaly chyby nebo nekonzistentní či špatně formátovaný kód.
• Zamezuje tomu, aby docházelo k nežádoucím konfliktům, regresím či zpomalení vývoje.
• Podporuje integraci dalších nástrojů, které se zabývají lintingem, testováním nebo formátováním kódu.
• Zvyšuje kvalitu jazyka, který používáš, a tím i tvou produktivitu.
• Husk se dá snadno nainstalovat a nakonfigurovat do souboru package.json

Lint-staged

Lint-staged je nástroj, který umožňuje provádění lintingu (opravy chyb) u souborů, které jsou ve fázi staging, tedy těsně před odesláním kódu do branch. Můžeš tak zabránit nahrání souboru s chybami a předejít tomu, že tebou napsaný jazyk nerespektuje zásady stanoveného stylu.

Tenhle tool ti pomůže ještě před odevzdáním kódu. Stačí Lint-taged spustit a budeš mít jistotu, že do uložiště na Gitu se nedostane nepatřičný kód. Navíc jej můžeš kombinovat třeba s nástrojem, jako je Husky.

Proč využít Lint-stage?

• Umožňuje kontrolu různých typů souborů, jako jsou JavaScript, CSS, HTML nebo Markdown.
• Pomáhá udržet kód čistý a čitelný, a tak se můžeš držet požadovaného standardu formátování.
• Urychluje revizi tvého kódu, a tak je připraven na budoucí kontroly a úpravy.
• Lint-staged se dá snadno integrovat do různých nástrojů pro provádění lintingu, testování a formátování kódu, jako je ESLint, Prettier, Jest nebo Husky.

Clean code nepomůže jen tobě

Ať už pracuješ jako programátor, nebo vývojář, vždy je potřeba mít na paměti, že s tvým kódem nebudeš pracovat jen ty. Clean code je řešení, které umožní bezproblémové používání kódu všem, kteří k němu budou mít přístup.

Výše zmíněné nástroje ti pomohou s tím, abys psal čistě, srozumitelně a vyhnul se chybám. Ušetříš tak čas nejen sobě, ale i dalším programátorům, pro které by práce s tvým kódem mohla být náročná. Proto hledej způsoby, jak se zlepšit, a neustále objevuj možnosti, které nástroje a znalosti ti dokážou pomoci v tvé kariéře.

Autor: Martin Šlat