nix-platform-specific-options

Nix のモジュールにおけるプラットフォーム固有のオプション

概要

プラットフォーム固有のオプション（NixOS と Darwin）を隠す必要がある Nix モジュールを記述する際、mkIf だけを使うと無限再帰が発生します。このスキルでは、正しいパターンについて説明します。

問題

mkIf は遅延評価されますが、モジュールの評価中にはオプションのパスが可視のままです。そのため、次のようなエラーが発生します。

error: The option `users.defaultUserShell' does not exist.

または、オプションのデフォルト値や optionalAttrs の条件で config を参照すると、無限再帰が発生します。

パターン

プラットフォームのチェックには optionalAttrs を、設定に依存するチェックには mkIf を使います。

チェックの種類	ツール	評価時期
プラットフォーム（isDarwin、!isDarwin）	optionalAttrs	解析時
設定値（cfg.enable、cfg.flavor）	mkIf	遅延

例

❌ 誤り：プラットフォームのチェックに mkIf を使用

config = mkIf (!isDarwin) {
  users.defaultUserShell = pkgs.zsh;  # Darwin sees this path!
};

✅ 正しい：プラットフォームのチェックに optionalAttrs を使用

config = optionalAttrs (!isDarwin) {
  users.defaultUserShell = pkgs.zsh;  # Hidden from Darwin
};

❌ 誤り：optionalAttrs の条件で設定値を使用

# cfg.flavor evaluated at parse time → infinite recursion
(optionalAttrs (isDarwin && cfg.flavor == "personal") {
  services.onepassword-secrets.enable = true;
})

✅ 正しい：optionalAttrs の中に mkIf をネスト

# Platform check at parse time, config check lazy
(optionalAttrs isDarwin (mkIf (cfg.flavor == "personal") {
  services.onepassword-secrets.enable = true;
}))

❌ 誤り：オプションのデフォルト値で config を参照

options.modules.foo = {
  user = mkOpt types.str config.user.name;  # Infinite recursion!
};

✅ 正しい：デフォルト値は静的にし、設定セクションで config を使用

options.modules.foo = {
  user = mkOpt types.str null;
};

config = mkIf cfg.enable (let
  user = if cfg.user != null then cfg.user else config.user.name;
in {
  # Use 'user' variable here
});

組み合わせパターン

プラットフォーム固有のオプションと設定に依存する動作の両方があるモジュールでは、次のようにします。

config = mkIf cfg.enable (mkMerge [
  # Common config (all platforms)
  { /* ... */ }

  # Darwin-only options
  (optionalAttrs isDarwin {
    programs.zsh.interactiveShellInit = "...";
  })

  # NixOS-only options
  (optionalAttrs (!isDarwin) {
    users.defaultUserShell = pkgs.zsh;
  })

  # Darwin + config-dependent (nested)
  (optionalAttrs isDarwin (mkIf (cfg.flavor == "personal") {
    services.onepassword-secrets.enable = true;
  }))
]);

クイックリファレンス

シナリオ	パターン
NixOS 専用のオプション	optionalAttrs (!isDarwin) { ... }
Darwin 専用のオプション	optionalAttrs isDarwin { ... }
プラットフォーム＋有効化チェック	optionalAttrs isDarwin (mkIf cfg.enable { ... })
プラットフォーム＋設定値	optionalAttrs isDarwin (mkIf (cfg.foo == "bar") { ... })
設定から取得するオプションのデフォルト値	デフォルト値に null を使用し、config セクションで解決する

デバッグ

_module.freeformType または anon-43 に言及する無限再帰エラーが発生した場合：

1. オプションのデフォルト値に config. の参照がないか検索します
2. optionalAttrs の条件に cfg. の参照がないか検索します
3. プラットフォーム固有のオプションを囲む mkIf (!isDarwin) または mkIf isDarwin がないか検索します

# Find problematic patterns
grep -rn "mkOpt.*config\." modules/
grep -rn "optionalAttrs.*cfg\." modules/
grep -rn "mkIf.*isDarwin" modules/