Не называйте мир грязным из-за того, что вы забыли почистить очки.

Аарон Хилл

Линтинг

Во Flatiron School во время разработки кода звучит мантра, повторяющая мысль Кента Блэка: «Заставьте это работать. Сделать это правильно. Сделайте это быстро». В этом контексте линтинг можно рассматривать как элемент, позволяющий сделать все правильно.

В 1979 году программа под названием Lint широко использовалась для проверки исходного кода программ на языке C на наличие потенциальных ошибок. Lint предупредит вас, если у вас есть деление на ноль, значения вне допустимого диапазона или другие фатальные ошибки в вашем коде, приводящие к сбою системы.

Lint был спасением, и буквально спасением, поэтому разговор о linting неизбежно должен вернуться к размеру стандартов кода НАСА и важности согласованности. и надежность в вашем коде. НАСА по праву относится к стандартам кодирования более серьезно, чем все остальные.

(Чтобы узнать больше о том, как ученый-ракетчик концептуализирует эти проблемы проверки, обратитесь к презентации Джеральда Хольцмана, старшего научного сотрудника Лаборатории реактивного движения НАСА.)

В 2017 году определение линтинга стало более общим. Линтинг — это процесс проверки вашего кода не только на системные ошибки, но и на стилистические несоответствия.

Постоянство противоречит природе, противоречит жизни. Единственные полностью последовательные люди мертвы.

Олдос Хаксли

Трудно найти положительную цитату о постоянстве, но у него есть свои преимущества.

Область когнитивной нейробиологии давно изучает взаимосвязь между распознаванием образов и эффективностью. Общая идея состоит в том, что чем чаще вы видите паттерн вещи, тем быстрее вы сможете распознать, что это такое, а также его компоненты.

По этой причине команды разработчиков часто принимают общий набор стилистических стандартов. Если два человека используют один и тот же стиль, им будет намного легче читать, понимать и модифицировать код друг друга.

Никогда не оскорбляйте людей стилем, если вы можете оскорбить их по существу.

Сэм Браун — Washington Post

ESLint

Выбор инструмента анализа для собственных проектов зависит от личных предпочтений. Каждый инструмент будет иметь слабые и сильные стороны. В этом посте я напишу об ESLint, линтере JavaScript с открытым исходным кодом, созданном в 2013 году.

ESLint придерживается некоторых основных принципов, таких как:

  • Все правила можно включить или выключить (ничего нельзя считать «слишком важным, чтобы выключить»)
  • Правила «свободны от повестки дня» — ESLint не продвигает какой-либо конкретный стиль кодирования.
  • ESLint ценит документацию и четкую коммуникацию

Как и многие инструменты анализа, ESLint можно подключить непосредственно к предпочитаемому вами редактору, установив пакет. Например, в Атоме:

Затем поместите файл .eslintrc в корневой каталог вашего проекта. Где вы берете содержимое для файла? Поищите в Интернете шаблон для использования, напишите его с нуля или попросите друга.

Я был довольно напуган, когда впервые увидел файл .eslintrc, но после того, как вы видели его несколько раз, он оказывается довольно простым. Распознавание образов и эффективность, действительно.

Что хорошо в стандартах, так это то, что их так много на выбор.

Эндрю С. Таненбаум

Цель файла .eslintrc — определить правила, по которым вы хотите кодировать. Например: "quotes": [2, "single", "avoid-escape"] установит некоторые правила, связанные с кавычками. Поскольку ESLint уважает документацию и четкую коммуникацию, каждое правило подробно объясняется на eslint.org/docs/rules/. Например:

Помимо стилистических предпочтений, ESLint также можно использовать для выявления проблем в коде до его выполнения. Ошибки, которые я часто обнаруживал в своем коде, включают:

  • Отсутствующие точки с запятой
  • Неиспользуемые переменные
  • Неожиданные токены

Установив пакет в Atom, я сразу вижу ошибки в своем коде:

Будьте размеренными и упорядоченными в своей жизни, как буржуа, чтобы вы могли быть жестокими и оригинальными в своей работе.
Гюстав Флобер

Каким бы ни был ваш стиль написания кода, линтер может улучшить ваше эстетическое восприятие и помочь вам научиться придерживаться последовательного набора правил, которым вы решите следовать.

До:

После:

Первоначально опубликовано 9 января 2017 г.