wip: refactor extending modules -> defferred module

Author: MattSturgeon

modules/docs/_util.nix

@@ -1,12 +1,11 @@
 {
   lib,
   config,
-  pkgs,
   ...
 }:
 let
-  inherit (config.docs.menu)
-    sections
+  inherit (config.docs._utils)
+    docsPageModule
     ;
 
   transformOption =
@@ -28,81 +27,6 @@ let
           decl;
     in
     opt: opt // { declarations = builtins.map transformDeclaration opt.declarations; };
-
-  docsPageModule =
-    { name, config, ... }:
-    {
-      options = {
-        enable = lib.mkOption {
-          type = lib.types.bool;
-          description = "Whether to enable this page/menu item.";
-          default = true;
-          example = false;
-        };
-        target = lib.mkOption {
-          type = lib.types.str;
-          description = ''
-            The target filepath, relative to the root of the docs.
-          '';
-          default = lib.optionalString (name != "") (name + "/") + "index.md";
-          defaultText = lib.literalMD ''
-            `<name>` joined with `"index.md"`. Separated by `"/"` if `<name>` is non-empty.
-          '';
-        };
-        source = lib.mkOption {
-          type = with lib.types; nullOr path;
-          description = ''
-            Markdown page. Set to null to create a menu entry without a corresponding file.
-          '';
-        };
-        menu.location = lib.mkOption {
-          type = with lib.types; listOf str;
-          description = ''
-            A location path that represents the page's position in the menu tree.
-
-            The text displayed in the menu is derived from this value,
-            after the location of any parent nodes in the tree is removed.
-
-            For example, if this page has the location `[ "foo" "bar" ]`
-            and there is another page with the location `[ "foo" ]`,
-            then the menu will render as:
-            ```markdown
-            - foo
-              - bar
-            ```
-
-            However if there was no other page with the `[ "foo" ]` location,
-            the menu would instead render as:
-            ```markdown
-            - foo.bar
-            ```
-          '';
-          default =
-            let
-              list = lib.splitString "/" config.target;
-              last = lib.last list;
-              rest = lib.dropEnd 1 list;
-            in
-            if last == "index.md" then
-              rest
-            else if lib.hasSuffix ".md" last then
-              rest ++ [ (lib.removeSuffix ".md" last) ]
-            else
-              list;
-          defaultText = lib.literalMD ''
-            `target`, split by `"/"`, with any trailing `"index.md` or `".md"` suffixes removed.
-          '';
-        };
-        menu.section = lib.mkOption {
-          type = lib.types.enum (builtins.attrNames sections);
-          description = ''
-            Determines the menu section.
-
-            Must be a section defined in `docs.menu.sections`.
-          '';
-        };
-      };
-    };
 in
 {
   options.docs._utils = lib.mkOption {

modules/docs/all.nix

@@ -8,19 +8,19 @@
 
   imports = [
     ./_util.nix
-    ./all.nix
     ./files.nix
     ./mdbook
     ./menu
     ./options.nix
+    ./pages.nix
     ./platforms.nix
   ];
 
   config.docs.options = {
     docs = {
-      menu.location = [ "docs" ];
       optionScopes = [ "docs" ];
-      description = ''
+      page.menu.location = [ "docs" ];
+      page.text = ''
         Internal options used to construct these docs.
       '';
     };

modules/docs/default.nix

@@ -1,39 +1,9 @@
 {
   lib,
-  config,
   pkgs,
   ...
 }:
 let
-  inherit (config.docs._utils)
-    docsPageModule
-    ;
-
-  docsPageType = lib.types.submodule (
-    {
-      name,
-      config,
-      options,
-      ...
-    }:
-    let
-      derivationName = builtins.replaceStrings [ "/" ] [ "-" ] name;
-    in
-    {
-      imports = [
-        docsPageModule
-      ];
-      options.text = lib.mkOption {
-        type = with lib.types; nullOr lines;
-        default = null;
-        description = "Text of the file.";
-      };
-      config.source = lib.mkIf (config.text != null) (
-        lib.mkDerivedConfig options.text (builtins.toFile derivationName)
-      );
-    }
-  );
-
   user-guide = ../../docs/user-guide;
 
   sourceTransformers = {
@@ -45,45 +15,30 @@ let
   };
 in
 {
-  options.docs = {
-    files = lib.mkOption {
-      type = with lib.types; lazyAttrsOf docsPageType;
-      description = ''
-        A set of pages to include in the docs.
-      '';
-      default = { };
-    };
-  };
-
-  config.docs = {
-    files =
-      # TODO: contributing file
-      {
-        "" = {
-          menu.section = "header";
-          menu.location = [ "Home" ];
-          source = pkgs.callPackage ./readme.nix {
-            # TODO: get `availableVersions` and `baseHref` from module options
-          };
+  # TODO: contributing file
+  docs.pages =
+    {
+      "" = {
+        menu.section = "header";
+        menu.location = [ "Home" ];
+        source = pkgs.callPackage ./readme.nix {
+          # TODO: get `availableVersions` and `baseHref` from module options
+        };
+      };
+    }
+    // lib.concatMapAttrs (
+      name: type:
+      let
+        title = lib.removeSuffix ".md" name;
+        transformer = sourceTransformers.${title} or lib.id;
+      in
+      lib.optionalAttrs (type == "regular") {
+        "user-guide/${title}" = {
+          menu.section = "user-guide";
+          # TODO: define user-facing titles to show in the menu...
+          menu.location = [ title ];
+          source = transformer "${user-guide}/${name}";
         };
       }
-      // lib.concatMapAttrs (
-        name: type:
-        let
-          title = lib.removeSuffix ".md" name;
-          transformer = sourceTransformers.${title} or lib.id;
-        in
-        lib.optionalAttrs (type == "regular") {
-          "user-guide/${title}" = {
-            menu.section = "user-guide";
-            # TODO: define user-facing titles to show in the menu...
-            menu.location = [ title ];
-            source = transformer "${user-guide}/${name}";
-          };
-        }
-      ) (builtins.readDir user-guide);
-
-    # Register for inclusion in `all`
-    _allInputs = [ "files" ];
-  };
+    ) (builtins.readDir user-guide);
 }