Рекомендации по кодированию JavaScript

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

Используйте Prettier для всех задач форматирования.
Мы принимаем snake_case в свойствах объектов, таких как ajaxResponse.page_title, однако везде используется camelCase или UPPER_CASE.

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

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

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

$ npm run lint:js

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

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

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

Для автоматического форматирования с помощью Prettier выполните:

$ npm run format

Если вы хотите автоматически исправлять ошибки проверки:

$ npm run lint:js -- --fix

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

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

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

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