Discourse использует lefthook для git-хуков, а bin/lint служит основной точкой входа в CLI для ручного запуска тех же проверок.
Если вы работаете с локальным клонированием, установите хуки один раз:
pnpm install
pnpm lefthook install
После этого прокоммиченные файлы будут автоматически проверяться при выполнении git commit.
Основная команда: bin/lint
Используйте bin/lint, если вы хотите самостоятельно запустить настроенные линтеры репозитория, вместо того чтобы ждать pre-commit хук.
Типичные примеры:
bin/lint
bin/lint path/to/file.rb path/to/file.gjs
bin/lint --recent
bin/lint --staged
bin/lint --unstaged
bin/lint --wip
bin/lint --fix path/to/file.rb
bin/lint --fix --recent
bin/lint --fix
Что делает каждый режим
bin/lint: линтер всех поддерживаемых файлов в репозиторииbin/lint path/to/file ...: линтер только указанных файловbin/lint --recent: линтер файлов, измененных в последних 50 коммитах, плюс неотслеживаемые файлыbin/lint --staged: линтер только прокоммиченных (staged) файловbin/lint --unstaged: линтер только непрокоммиченных (unstaged) файловbin/lint --wip: линтер staged, unstaged и файлов, измененных с момента веткиmainbin/lint --fix ...: запуск автоисправителей для выбранных файловbin/lint --fix: запуск всех доступных автоисправителей по всему репозиториюbin/lint --verbose: вывод базовых команд lefthook
Когда вы передаете явные файлы, bin/lint фильтрует их по поддерживаемым типам файлов, пригодным для линтинга, перед вызовом lefthook.
Файлы Markdown линтятся только в каталоге
docs/developer-guides/. Запускbin/lint path/to/doc.mdдля любого другого файла Markdown сообщит, что ничего не было пролинтовано.
Что подвергается линтингу
Точная конфигурация находится в lefthook.yml. На момент написания, bin/lint охватывает:
Ruby
**/*.{rb,rake,thor}- Скрипты Ruby в
bin/**/* Gemfile
Проверки:
rubocopsyntax_tree(stree check)
Форматирование JavaScript, GJS, CSS и SCSS
app/assets/stylesheets/**/*.{css,scss}frontend/**/*.{js,gjs,scss,css,cjs,mjs}- Соответствующие файлы ресурсов плагинов и тем
Проверки:
prettier/pprettier
Линтинг JavaScript и GJS
frontend/**/*.{js,gjs}- Соответствующие JS-файлы плагинов и тем
Проверки:
eslint(с правиламиtemplate-*изeslint-plugin-ember, охватывающими шаблонную часть файлов.gjs)
Линтинг SCSS
app/assets/stylesheets/**/*.scss- Соответствующие SCSS-файлы плагинов и тем
Проверки:
stylelint
Проверки YAML и локалей
**/*.{yaml,yml}, кромеconfig/database.yml**/{client,server}.en.yml
Проверки:
yaml-lintscript/i18n_lint.rb
Проверка типов
Когда вы запускаете bin/lint без аргументов файлов, полный линтинг репозитория также выполняет:
pnpm lint:types
Это проверка в стиле Glint/TypeScript для информации о типах Discourse. Она выполняется в режиме strict TypeScript и также генерирует опубликованные декларации.
![]()
bin/lint path/to/fileи pre-commit хук не выполняют полную проверку типов. Используйте обычныйbin/lint, если вам нужен полный проход линтинга по всему репозиторию.
Что можно исправить автоматически
bin/lint --fix может автоматически исправить многие проблемы, но не все.
Автоисправление настроено для:
prettier --writeeslint --fixstylelint --fixrubocop -Asyntax_tree(stree write)
На практике это означает, что --fix может переформатировать и переписать:
- Ruby
- JavaScript / GJS
- CSS / SCSS
Эти проверки не исправляются автоматически с помощью bin/lint --fix:
- Валидация синтаксиса YAML
- Линтинг i18n для
client.en.yml/server.en.yml - Проверка типов Glint
Отношение к git-хукам
Pre-commit хук использует ту же конфигурацию lefthook, что и bin/lint, но выполняется только для staged файлов.
Это означает:
- Коммит может завершиться ошибкой, если staged файлы не проходят линтинг
bin/lint --staged— ближайший ручной аналог pre-commit хукаbin/lint --fix --staged— хороший способ исправить именно то, что вы собираетесь коммитить
Практический рабочий процесс
Для повседневной разработки наиболее полезными являются следующие команды:
# Перед коммитом пары измененных файлов
bin/lint --fix path/to/file1.rb path/to/file2.gjs
# Проверить именно то, что проверит pre-commit хук
bin/lint --staged
# Убрать все текущие незавершенные работы
bin/lint --fix --wip
# Запустить полный набор линтеров репозитория, включая проверку типов
bin/lint
Этот документ управляется версиями — предложите изменения на github.