Рекомендации по написанию JavaScript-кода

Пишите JavaScript в соответствии с Airbnb Styleguide, с некоторыми исключениями:

• Используйте мягкие табуляции с отступом в два пробела. Пробелы — единственный способ гарантировать, что код будет отображаться одинаково в любой среде.
• Мы допускаем snake_case в свойствах объектов, таких как ajaxResponse.page_title, однако в остальных случаях следует использовать camelCase или UPPER_CASE.

Проверка и форматирование кода

Wagtail использует инструмент проверки кода ESLint, чтобы помочь убедиться, что ваш код соответствует стилистическим рекомендациям. Вам потребуется node.js и npm на вашей машине разработки. Убедитесь, что зависимости проекта установлены, выполнив npm install --no-save

Проверка кода

$ npm run lint:js

Это проверит весь JS-код в проекте Wagtail, исключая файлы vendor и скомпилированные библиотеки.

Некоторые модальные окна генерируются на стороне сервера. Они включают теги шаблонов, которые вызывают проблемы у инструмента проверки, поэтому JavaScript для работы с модальными окнами исключён из проверки.

Форматирование кода

$ npm run lint:js -- --fix

Это произведёт безопасные изменения, чтобы привести ваш JS-код в соответствие со стилистическими рекомендациями. Оно не будет трогать длину строки или преобразовывать кавычки из двойных в одинарные.

Запустите инструмент проверки кода после форматирования, чтобы увидеть, какие исправления вручную вам нужно внести в код.

Изменение конфигурации инструмента проверки

Конфигурация правил проверки кода хранится в отдельном репозитории, чтобы её можно было легко использовать в других проектах или плагинах Wagtail. Эту конфигурацию можно найти на eslint-config-wagtail.