treefmt

treefmt-nix

概要

treefmtはプロジェクト内の複数言語ファイルを一コマンドで並列フォーマットするツールです。 treefmt-nixはNixモジュールシステムでtreefmtを設定・管理するラッパーです。

nix fmtコマンドはflakeのformatter出力を呼び出します。 treefmt-nixを組み込むとnix fmtの実体がtreefmtになり、 設定されたすべてのプログラムが実行されます。

FlakeはGitで追跡されているファイルのみを対象とするため、 新規ファイルがある場合は事前にgit ls-files --others --exclude-standard -z | git add --intent-to-add --pathspec-from-file=- --pathspec-file-nulを実行してください。 未追跡ファイルがなく空の入力でもエラーにはなりません。

フォーマッタだけではなくリンターも含む

nix fmtやtreefmtという名前から「フォーマッタだけ」と誤解されがちですが、 treefmt-nixのprogramsにはリンターやチェッカーが多数含まれています。

フォーマッタの例:

• nixfmt
• prettier
• rustfmt
• shfmt

リンターの例:

• actionlint
• deadnix
• hlint
• shellcheck
• statix

その他:

• typos(スペルチェック)
• zizmor(GitHub Actionsセキュリティ)

treefmtのフォーマッタ仕様は「ファイルパスのリストを受け取り、変更があればファイルに書き戻す」というものです。 リンターはファイルを変更しませんが、エラー時に非ゼロ終了するためtreefmtがエラーとして検出します。

典型的な設定例

flake-partsを使う場合の例です。

{
  inputs = {
    nixpkgs.url = "github:NixOS/nixpkgs/nixpkgs-unstable";
    flake-parts.url = "github:hercules-ci/flake-parts";
    treefmt-nix = {
      url = "github:numtide/treefmt-nix";
      inputs.nixpkgs.follows = "nixpkgs";
    };
  };

  outputs =
    inputs@{
      flake-parts,
      treefmt-nix,
      ...
    }:
    flake-parts.lib.mkFlake { inherit inputs; } {
      imports = [
        treefmt-nix.flakeModule
      ];

      systems = [
        "aarch64-linux"
        "x86_64-linux"
      ];

      perSystem = { pkgs, ... }: {
        treefmt.config = {
          projectRootFile = "flake.nix";
          programs = {
            nixfmt.enable = true;
            prettier.enable = true;
            shellcheck.enable = true;
            shfmt.enable = true;
          };
        };
      };
    };
}

nix fmtで全プログラムが実行されます。

フォーマッタのカスタム設定をする際の注意

treefmtの設定モジュールを使ってカスタム引数を渡すこともできます。

しかしなるべくflake.nixに書くのではなく、 そのツール自体が標準的に使う設定ファイルなどに設定を書き込んでください。

そうするとそのツールをnix fmt経由以外で使うときも同じ設定が適用されるため一貫性が保たれます。