Development

このページでは ExParamsSchema のローカル開発手順を説明します。

English

Toolchain

このプロジェクトでは、Erlang、Elixir、prek のバージョンを mise.toml で固定しています。clone 後にツールチェーンをインストールします。

mise install

Mix の依存関係は別途取得します。

mix deps.get

手順を分けることで、ツールチェーンのインストールと依存関係の解決を個別に切り分けられます。

Git フック

prek は Elixir ファイルを含むコミットの前に、次のチェックを実行します。

• mix format --check-formatted
• mix credo --strict
• mix compile --warnings-as-errors
• mix dialyzer
• mix test --cover --warnings-as-errors

ローカル clone で一度だけ Git フックを有効化します。

mise exec -- prek install

コミットを作成せず、追跡対象のすべてのファイルに設定済みフックを実行するには次を使います。

mise exec -- prek run --all-files

完全な CI スイート

プルリクエストを作成する前に、ローカルで完全な CI スイートを実行できます。

mise run ci

このコマンドは、コミット前チェックに加えて mix docs によるドキュメント生成も実行します。