lib/options: add moduleOptions (#59)

* lib/options: add moduleOptions

* lib/options!: improve moduleOptions

allows to not pass the `args` variable if they are needed inside and the
arguments are closer to the scope

* docs/src/options/introduction: add moduleOptions

* docs/src/ru/options/introduction: add moduleOpt...

...ions

* docs/src/options/introduction: add semicolon

* docs/src: fix second moduleOptions example

i actually forgot that only `options` attribute can be assigned to a
function and not something nested 💀

* docs/src: fix indent in moduleOptions examples

Author: shimeoki

docs/src/options/introduction.md

@@ -52,6 +52,38 @@ options = delib.singleEnableOption <default>;
 options = delib.singleCascadeEnableOption;
 ```
 
+- `moduleOptions <opts> <args>` - creates an attribute set with `<opts>` for the current module path. Usually, you need to use the module `name` once again to define all options, but this wrapper does this automatically. `<args>` is a set with [passed arguments](/modules/structure#passed-arguments). If `<opts>` is a function, then `<args>` set is automatically passed to it. See the example:
+
+```nix
+# current module's name is "programs.category.example".
+
+# if `singleEnableOption` is not enough:
+options = with delib; moduleOptions {
+  enable = boolOption true;
+  device = strOption "desktop";
+};
+
+# `options` block above is the same as:
+options.programs.category.example = with delib; {
+  enable = boolOption true;
+  device = strOption "desktop";
+};
+
+# but if `singleCascadeEnableOption` is not enough:
+options = with delib; moduleOptions ({ parent, ... }: {
+  enable = boolOption parent.enable;
+  device = strOption "desktop";
+}); # notice the parentheses
+
+# once again, `options` block above is the same as:
+options = with delib; { parent, ... }: {
+  programs.category.example = {
+    enable = boolOption parent.enable;
+    device = strOption "desktop";
+  };
+};
+```
+
 The list of current options can be found in the source code: [github:yunfachi/denix?path=lib/options.nix](https://github.com/yunfachi/denix/blob/master/lib/options.nix)
 
 ## Examples {#examples}

docs/src/ru/options/introduction.md

@@ -52,6 +52,38 @@ options = delib.singleEnableOption <default>;
 options = delib.singleCascadeEnableOption;
 ```
 
+- `moduleOptions <opts> <args>` - создаёт attribute set с `<opts>` для пути текущего модуля. Обычно, необходимо использовать `name` ещё раз, чтобы обозначить опции, но эта функция делает это автоматически. `<args>` это набор [передаваемых аргументов](/ru/modules/structure#passed-arguments). Если `<opts>` это функция, тогда `<args>` является её аргументом. Пример:
+
+```nix
+# имя текущего модуля это "programs.category.example".
+
+# если не хватает `singleEnableOption`:
+options = with delib; moduleOptions {
+  enable = boolOption true;
+  device = strOption "desktop";
+};
+
+# блок опций выше эквивалентен блоку ниже:
+options.programs.category.example = with delib; {
+  enable = boolOption true;
+  device = strOption "desktop";
+};
+
+# а если не хватает `singleCascadeEnableOption`:
+options = with delib; moduleOptions ({ parent, ... }: {
+  enable = boolOption parent.enable;
+  device = strOption "desktop";
+}); # обратите внимание на скобки
+
+# снова, блок опций выше эквивалентен блоку ниже:
+options = with delib; { parent, ... }: {
+  programs.category.example = {
+    enable = boolOption parent.enable;
+    device = strOption "desktop";
+  };
+};
+```
+
 Список актуальных опций можно найти в исходном коде: [github:yunfachi/denix?path=lib/options.nix](https://github.com/yunfachi/denix/blob/master/lib/options.nix)
 
 ## Примеры {#examples}

lib/options.nix

@@ -117,4 +117,8 @@ rec {
     default: { name, ... }: delib.attrset.setAttrByStrPath "${name}.enable" (boolOption default);
 
   singleCascadeEnableOption = args: delib.singleEnableOption args.parent.enable args;
+
+  moduleOptions =
+    opts: args:
+    delib.attrset.setAttrByStrPath args.name (if lib.isFunction opts then opts args else opts);
 }