7 шагов к качественному JavaScript коду

пост представляет собой резюме на  статью “7 steps to better JavaScript“.

Шаг 1 – Модульность

Любой крупный проект необходимо разбивать на составные части – модули. Это значительно упрощает работу над проектом. Для реализации модульного подхода мы можем использовать как специальные библиотеки типа RequireJs, так и встроенные возможности компонентного фреймворка.

В каждом модуле ставим оператор ‘use strict’, тем самым давая понять интерпретатору что мы хотим работать в “строгом режиме”, который фиксит некоторые неточности языка и выдает больше ошибок в случае неверного использования.

Шаг 2 – Документированность

Чтобы код хорошо читался не только сейчас, а и через месяц, – его следует дополнять комментарияеми. Используя JSDoc формат можно не только придерживается единого формата описания для всей команды, но еще потом по нему автоматически генерировать документацию всего проекта.

Но тут тоже нужно знать меру: имхо, отдельные методы комментировать хорошо; а вот строчки кода – только в самом крайнем слечае.

Шаг 3 – Стилистика

Также для качества кода проекта необходимо, чтобы вся команда писала код в одном стиле. Это касается в первую очередь именования переменных/методов, расстановки пробелов/переносов, использования кавычек. Для проверки стилистики существует прекрасный инструмент JSHint, который можно под себя(команду) удобно настроить.

Шаг 4 – Тесты

Качественный код должет содержать юнит-тесты. В помощь спешат библиотеки jasmine, mocha и тест драйвер karma.

Шаг 5 – Покрытие

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

Шаг 6 – Автоматизация

Почти всю рутину можно поручить на инструмент сборки – grunt, gulp и остальные варианты. Они для вас выполнят валидацию стилей, тесты и прочие полезные мелочи.

Шаг 7 – Отлов ошибок

Заключающий шаг. Про ошибки так же не нужно забывать. Я уже писал довольно подробный пост на эту тему.

Шаг 7 +1 – Ревью

То, чего не было в оригинале статьи, но то, что не могу не добавить – код ревью, совместный анализ кода, серьезно улучшает качество вашего кода и качество кода команды в целом. Это можно реализовать, как путем совместного просмотра кода за одной машиной, так и путем коментариев в репозитории.