Merge pull request #23 from hercules-ci/overlays

flake.overlay -> flake.overlays (Nix 2.8)

ChangeLog.md

@@ -27,3 +27,5 @@
     ```
 
  - `flake-modules-core` is now called `flake-parts`.
+
+ - `flake.overlay` has been removed in favor of `flake.overlays.default`.

all-modules.nix

@@ -10,7 +10,7 @@
     ./modules/nixosConfigurations.nix
     ./modules/nixosModules.nix
     ./modules/nixpkgs.nix
-    ./modules/overlay.nix
+    ./modules/overlays.nix
     ./modules/packages.nix
     ./modules/perSystem.nix
   ];

modules/overlay.nix

@@ -1,32 +0,0 @@
-{ config, lib, flake-parts-lib, ... }:
-let
-  inherit (lib)
-    mkOption
-    types
-    ;
-  inherit (flake-parts-lib)
-    mkSubmoduleOptions
-    ;
-in
-{
-  options = {
-    flake = mkSubmoduleOptions {
-      overlay = mkOption {
-        # uniq should be ordered: https://github.com/NixOS/nixpkgs/issues/147052
-        # also update description when done
-        type = types.uniq (types.functionTo (types.functionTo (types.lazyAttrsOf types.unspecified)));
-        # This eta expansion exists for the sole purpose of making nix flake check happy.
-        apply = f: final: prev: f final prev;
-        default = _: _: { };
-        defaultText = lib.literalExpression or lib.literalExample ''final: prev: {}'';
-        description = ''
-          An overlay.
-
-          Note that this option's type is not mergeable. While overlays can be
-          composed, the order of composition is significant, but the module
-          system does not guarantee deterministic definition ordering.
-        '';
-      };
-    };
-  };
-}

modules/overlays.nix

@@ -0,0 +1,37 @@
+{ config, lib, flake-parts-lib, ... }:
+let
+  inherit (lib)
+    mkOption
+    types
+    ;
+  inherit (flake-parts-lib)
+    mkSubmoduleOptions
+    ;
+in
+{
+  options = {
+    flake = mkSubmoduleOptions {
+      overlays = mkOption {
+        # uniq -> ordered: https://github.com/NixOS/nixpkgs/issues/147052
+        # also update description when done
+        type = types.lazyAttrsOf (types.uniq (types.functionTo (types.functionTo (types.lazyAttrsOf types.unspecified))));
+        # This eta expansion exists for the sole purpose of making nix flake check happy.
+        apply = lib.mapAttrs (k: f: final: prev: f final prev);
+        default = { };
+        example = lib.literalExpression or lib.literalExample ''
+          {
+            default = final: prev: {};
+          }
+        '';
+        description = ''
+          An attribute set of overlays.
+
+          Note that the overlays themselves are not mergeable. While overlays
+          can be composed, the order of composition is significant, but the
+          module system does not guarantee sufficiently deterministic
+          definition ordering, across versions and when changing <literal>imports</literal>.
+        '';
+      };
+    };
+  };
+}