Discourse は git フックに lefthook を使用しており、同じチェックを手動で実行するための主な CLI エントリポイントとして bin/lint を利用しています。
ローカルクローンで作業している場合、フックを一度だけインストールしてください：
pnpm install
pnpm lefthook install
これにより、git commit 時にステージされたファイルが自動的にチェックされるようになります。
メインコマンド: bin/lint
pre-commit フックを待つのではなく、リポジトリで設定されたリンターを自分で実行したい場合は bin/lint を使用します。
一般的な例:
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: リポジトリ内のすべてのサポート対象ファイルを lint するbin/lint path/to/file ...: 指定されたファイルのみを lint するbin/lint --recent: 直近 50 コミットで変更されたファイルと、未追跡ファイルを lint するbin/lint --staged: ステージされたファイルのみを lint するbin/lint --unstaged: ステージされていないファイルのみを lint するbin/lint --wip: ステージされたファイル、ステージされていないファイル、およびmainから変更されたファイルを lint するbin/lint --fix ...: 選択されたファイルに対して自動修正ツールを実行するbin/lint --fix: リポジトリ全体で利用可能なすべての自動修正ツールを実行するbin/lint --verbose: 基盤となる lefthook コマンドを表示する
明示的にファイルを指定すると、bin/lint は lefthook を呼び出す前に、それらを lint 可能なサポート対象ファイルタイプにフィルタリングします。
Markdown ファイルは
docs/developer-guides/の下にある場合のみ lint されます。他の Markdown ファイルに対してbin/lint path/to/doc.mdを実行しても、「何も lint されなかった」と報告されます。
lint 対象
正確な設定は lefthook.yml に記載されています。執筆時点では、bin/lint は以下を対象としています：
Ruby
**/*.{rb,rake,thor}bin/**/*配下の Ruby スクリプト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 の lint
frontend/**/*.{js,gjs}- 該当するプラグインやテーマの JS ファイル
チェック内容:
eslint(.gjsファイルのテンプレート部分をカバーするeslint-plugin-emberのtemplate-*ルールを含む)
SCSS の lint
app/assets/stylesheets/**/*.scss- 該当するプラグインやテーマの SCSS ファイル
チェック内容:
stylelint
YAML とロケールチェック
config/database.ymlを除く**/*.{yaml,yml}**/{client,server}.en.yml
チェック内容:
yaml-lintscript/i18n_lint.rb
型チェック
ファイル引数なしで bin/lint を実行すると、リポジトリ全体の lint として以下の処理も実行されます：
pnpm lint:types
これは Discourse の型情報に対する Glint/TypeScript スタイルのチェックです。TypeScript の strict モードで実行され、公開用の宣言ファイルも生成します。
bin/lint path/to/fileや pre-commit フックは、完全な型チェックを実行しません。リポジトリ全体の完全な lint パスを実行したい場合は、単なるbin/lintを使用してください。
自動修正可能な項目
bin/lint --fix は多くの問題を自動修正できますが、すべてではありません。
自動修正は以下に対して設定されています：
prettier --writeeslint --fixstylelint --fixrubocop -Asyntax_tree(stree write)
実際には、--fix によって以下が再フォーマットおよび書き換えられます：
- Ruby
- JavaScript / GJS
- CSS / SCSS
これらのチェックは bin/lint --fix によって自動修正されません：
- YAML の構文検証
client.en.yml/server.en.yml向けの i18n lint- Glint/型チェック
git フックとの関係
pre-commit フックは bin/lint と同じ lefthook 設定を使用しますが、ステージされたファイルに対してのみ実行されます。
つまり：
- ステージされたファイルが lint を通らないため、コミットが失敗することがあります
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
# 型チェックを含むリポジトリ全体の lint スイートを実行
bin/lint
このドキュメントはバージョン管理されています。変更提案は GitHub で行ってください。