Co To jest Linter? Oto Definicja i Szybki przewodnik

Co to jest linter? Krótko mówiąc, linter jest narzędziem, które pomoże Ci ulepszyć kod. Pojęcie linter Nie dotyczy wyłącznie JavaScript. Mimo to, powiedziałbym, że większość osób próbujących dowiedzieć się o linerach interesuje się tymi, które kierują JavaScript (lub, bardziej ogólnie, dynamicznie typowanych języków.)

w dzisiejszym poście odpowiadamy na pytanie tytułowe i nie tylko. Zaczynamy od zdefiniowania terminu ” linter.,”Zrozumiesz, co to jest i jak to się stało. Następnie mówimy o zaletach linters i przystąpić do rozmowy o różnych rodzajach kontroli, które oferują.

na koniec przedstawiamy kilka przykładów linterów do twojej dyspozycji, podajemy kilka praktycznych wskazówek, jak zacząć, a na koniec kilka ostatecznych rozważań.

zaczynajmy.

Co To jest Linter? Krótki przegląd

Zacznijmy od zdefiniowania, czym jest linter. Jak przeczytałeś we wstępie, linter jest narzędziem, które pomoże Ci ulepszyć kod. Ale w jaki sposób to robi?, Odpowiedź brzmi: analizując kod źródłowy w poszukiwaniu problemów.

termin linter pochodzi od narzędzia pierwotnie nazywanego „lint”, które analizowało kod źródłowy C. Informatyk Stephen C. Johnson rozwinął to narzędzie w 1978 roku, kiedy pracował w Bell Labs.

zarówno oryginalne narzędzie lint, jak i wcześniejsze podobne narzędzia, miały na celu analizę kodu źródłowego, aby wymyślić optymalizację kompilatora. Z czasem narzędzia podobne do lint zaczęły dodawać wiele innych rodzajów kontroli i weryfikacji.,

jednak, jak wspomnieliśmy we wstępie, lintery nie są ograniczone do skompilowanych języków. Wręcz przeciwnie: można powiedzieć, że lintery są o wiele bardziej wartościowe dla języków interpretowanych, ponieważ nie ma kompilatora, który wykrywałby błędy w czasie programowania.

zalety lintingu

właśnie poznałeś definicję lintera. Teraz wiesz również, kiedy ten rodzaj narzędzia został wynaleziony i przez kogo. Prawdopodobnie masz już przynajmniej ogólne pojęcie, co linter może zrobić dla Twojego kodu., Ale w bardziej praktyczny sposób, jakie są korzyści, że tego typu narzędzie może zapewnić? Oto kilka:

• mniej błędów w produkcji
• czytelny, możliwy do utrzymania i bardziej spójny kod
• mniej dyskusji na temat stylu kodu i wyborów estetycznych podczas przeglądów kodu
• obiektywny pomiar jakości kodu
• bardziej bezpieczny i wydajny kod

następna sekcja obejmuje niektóre rodzaje weryfikacji, które zapewniają lintery. Po przeczytaniu go zrozumiesz, w jaki sposób linters zapewniają powyższe korzyści.,

rodzaje sprawdzeń Lintery zapewniają

jak już przeczytałeś, Oryginalne narzędzie lint analizowało kod, aby umożliwić optymalizację dla kompilatorów, ale z czasem pojawiły się bardziej zaawansowane i kompletne narzędzia. Obecnie mamy mnóstwo różnych linters, które zapewniają wiele rodzajów kontroli. Szybko przejrzyjmy niektóre z nich.

Błędy składniowe

najbardziej podstawowym i bardziej istotnym rodzajem sprawdzania, jakie może zapewnić linter, są weryfikacje błędów składni, jeśli chodzi o JavaScript i inne języki interpretowane., Programiści nie powinni nawet wysyłać kodu do linii głównej bez weryfikacji składni.

jednym ze sposobów na osiągnięcie tego celu jest użycie przed zatwierdzeniem hooków, które uniemożliwiają użytkownikom wypychanie kodu, gdy weryfikacja lintera wskazuje na problemy z kodem.

przestrzeganie standardów kodowania

kolejnym istotnym rodzajem sprawdzania, które zapewniają linters, jest przestrzeganie standardów kodowania. Niektórzy ludzie mogą odrzucić to jako czysto estetyczną troskę, ale będą w błędzie., Posiadanie jednego spójnego stylu kodowania jest korzystne dla zmniejszenia obciążenia poznawczego czytania, rozumienia i utrzymywania kodu. Baza kodu, która ma spójny styl kodu, będzie łatwiejsza do zrozumienia, a deweloperzy, którzy go używają, będą mniej skłonni do wprowadzania błędów.

dlatego istnieją lintery, które specjalizują się w sprawdzaniu baz kodowych pod kątem zgodności ze stylami kodu. Niektóre narzędzia są opiniowane, tzn. pochodzą z predefiniowanego zestawu reguł i konwencji, których nie można zmienić., Z drugiej strony istnieją narzędzia, które mogą być wysoce konfigurowalne, umożliwiając użytkownikowi dostosowanie narzędzia do preferowanych stylów kodowania.

potencjalne problemy (a.K.a. zapachy kodu)

zapachy kodu są oznakami, że coś może być nie tak z Twoim kodem. Niezwykle przydatne jest posiadanie narzędzia do automatycznego wykrywania tych znaków, aby w razie potrzeby móc je dalej badać.

na przykład wiele osób—w tym ja—uważa długie funkcje za zapach kodu. Możesz więc skonfigurować linter tak, aby wykrywał funkcje dłuższe niż określona liczba linii.,

kolejnym często cytowanym kodem jest kod, który jest zbyt skomplikowany. Ale nie mówimy o złożoności w sposób subiektywny, ale bardzo obiektywny. Złożoność cyklomatyczna jest użyteczną metryką kodu, która reprezentuje liczbę możliwych ścieżek wykonania wewnątrz funkcji. Linters może obliczyć złożoność cyklomatyczną Twoich funkcji i oznaczać te, które są wyższe niż określony próg.

kontrole bezpieczeństwa

wreszcie, ale nie mniej ważne, mamy bezpieczeństwo, które jest bez wątpienia najbardziej krytycznym aspektem nowoczesnej aplikacji, zwłaszcza aplikacji internetowej., Zrozum to źle, a konsekwencje mogą być katastrofalne, nie tylko w odniesieniu do pieniędzy i reputacji, ale nawet prawnych (pomyśl o RODO i podobnych przepisach.)

na szczęście jest to kolejny obszar, w którym lintery mogą być pomocne, ponieważ istnieją narzędzia, które zapewniają ważną weryfikację bezpieczeństwa.

zrozumienie analizy statycznej

wyjaśniliśmy czym są lintery i dlaczego są przydatne. Omówiliśmy również główne typy linterów. Teraz możesz zapoznać się z przykładowymi narzędziami lintingowymi do różnych zastosowań i docelowych języków programowania.,

zanim jednak tam dotrzemy, zróbmy krótką dygresję, aby porozmawiać o analizie statycznej, ponieważ termin ten pojawia się w następnej sekcji, a my jeszcze go nie zdefiniowaliśmy.

czym jest analiza statyczna? Analizę statyczną można traktować jako debugowanie przed uruchomieniem. Analiza statyczna polega na użyciu narzędzi, które analizują kod źródłowy w poszukiwaniu błędów, braku przestrzegania reguł lub konwencji lub innych potencjalnych problemów.

następna sekcja pokazuje przykłady linterów sklasyfikowanych według rodzaju weryfikacji, jaką wykonują., Wpisy sklasyfikowane w kategorii analiza statyczna odnoszą się głównie do pierwszego i trzeciego rodzaju linterów wymienionych w powyższej sekcji.

przykłady Linterów

wspomnijmy teraz krótko kilka przykładów linterów. Pokażemy przykłady dla różnych języków programowania, podzielonych na kategorie według rodzaju sprawdzania, które zapewniają. Należy pamiętać, że niektóre narzędzia mogą oferować więcej niż jeden rodzaj weryfikacji, dlatego niektóre narzędzia pojawiają się w więcej niż jednej kategorii.,

StandardJS dla JavaScript

PHPMD dla PHP

StyleCop dla C#

łączniki dla bezpieczeństwa

• Gosec dla Go
• Bandit dla Pythona
• LGTM dla kilku języków, w tym JavaScript, Python i C#

łączniki dla Konwencji kodowania / formatowania kodowania

• prettier for JavaScript
• rubocop for Ruby
• StyleCop for C#

linters in Javascript: How to get started

zanim zakończymy artykuł, chcemy dać Ci krótki, ale praktyczny przewodnik jak zacząć od lintingu w JavaScript., Ponieważ mówimy o JavaScript, nie jest zaskoczeniem, że istnieje wiele narzędzi do wyboru. Skoro musimy wybrać jedną, wybieramy ESLint.

instalacja Eslinta

po kolei: zainstalujmy lintera. ESLint jest instalowany przez npm, co oznacza, że musisz mieć węzeł.js zainstalowany. Jeśli jeszcze go nie masz, pobierz go i zainstaluj, abyśmy mogli kontynuować.

z węzłem.js zainstalowany, jesteśmy gotowi do instalacji ESLint poprzez npm., the following command:

However, this isn’t the approach recommended in their documentation., Zamiast tego powinieneś prawdopodobnie zainstalować ESLint na podstawie projektu.,ory for your project:

Then, cd into the directory and run the command below to create a package.,plik json (będzie potrzebny w przyszłości.)