コミット前にコードを自動でLint・フォーマットする

[Discourse]

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

チェック項目:

• rubocop
• syntax_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 およびロケールチェック

• **/*.{yaml,yml} (ただし config/database.yml は除外)
• **/{client,server}.en.yml

チェック項目:

• yaml-lint
• script/i18n_lint.rb

型チェック

ファイル引数なしで bin/lint を実行すると、リポジトリ全体の lint として以下も実行されます：

• pnpm lint:types

これは、Discourse の JavaScript 型情報に対する Glint/TypeScript スタイルのチェックです。

bin/lint path/to/file および pre-commit フックは、完全な型チェックを実行しません。リポジトリ全体の完全な lint パスを実行したい場合は、単なる bin/lint を使用してください。

自動修正可能な項目

bin/lint --fix は多くの問題を自動修正できますが、すべてではありません。

自動修正は以下に設定されています：

• prettier --write
• eslint --fix
• stylelint --fix
• rubocop -A
• syntax_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 でどうぞ。