Working on titles/descriptions for attrs/extensions

Author: thomasjm

modules/kernels/clojure/default.nix

@@ -10,7 +10,7 @@
 , settingsSchema
 }:
 
-with { inherit (settings) attrs extensions; };
+with { inherit (settings.interface) attrs extensions; };
 
 let
   common = callPackage ../common.nix {};

modules/kernels/clojure/module.nix

@@ -1,4 +1,4 @@
-{ config, options, lib, pkgs, nixosOptionsToSettingsSchema, ... }:
+{ config, options, lib, pkgs, nixosOptionsToSettingsSchema, boilerplate, ... }:
 
 with lib;
 
@@ -12,12 +12,15 @@ with lib;
         visible = false;
       };
 
-      attrs = mkOption {
+      interface.attrs = mkOption {
+        example = boilerplate.attrsTitle;
+        description = boilerplate.attrsDescription;
         type = types.listOf types.str;
         default = ["clojure"];
       };
-
-      extensions = mkOption {
+      interface.extensions = mkOption {
+        example = boilerplate.extensionsTitle;
+        description = boilerplate.extensionsDescription;
         type = types.listOf types.str;
         default = ["clj"];
       };

modules/kernels/coq/default.nix

@@ -10,7 +10,8 @@
 , settingsSchema
 }:
 
-with { inherit (settings) packages attrs extensions; };
+with { inherit (settings) packages; };
+with { inherit (settings.interface) attrs extensions; };
 
 let
   common = callPackage ../common.nix {};

modules/kernels/coq/module.nix

@@ -1,23 +1,24 @@
-{ config, options, lib, pkgs, nixosOptionsToSettingsSchema, ... }:
+{ config, options, lib, pkgs, nixosOptionsToSettingsSchema, boilerplate, ... }:
 
 with lib;
 
 {
   options = {
     kernels.coq = {
       enable = mkOption {
-        description = "Enable Coq kernel";
+        example = "Enable Coq kernel";
         type = types.bool;
         default = false;
         visible = false;
       };
 
       packages = mkOption {
+        example = "List of Coq packages to use";
         type = types.listOf (types.either types.str types.attrs);
         default = [];
       };
-
       coqPackages = mkOption {
+        example = "Coq packages set";
         type = types.enum (
           ["coqPackages"]
           ++ (builtins.filter (name: builtins.substring 0 (builtins.stringLength "coqPackages_") name == "coqPackages_")
@@ -26,12 +27,15 @@ with lib;
         default = "coqPackages";
       };
 
-      attrs = mkOption {
+      interface.attrs = mkOption {
+        example = boilerplate.attrsTitle;
+        description = boilerplate.attrsDescription;
         type = types.listOf types.str;
         default = ["coq"];
       };
-
-      extensions = mkOption {
+      interface.extensions = mkOption {
+        example = boilerplate.extensionsTitle;
+        description = boilerplate.extensionsDescription;
         type = types.listOf types.str;
         default = ["v"];
       };

modules/kernels/cpp/module.nix

@@ -1,4 +1,4 @@
-{ config, options, lib, pkgs, nixosOptionsToSettingsSchema, ... }:
+{ config, options, lib, pkgs, nixosOptionsToSettingsSchema, boilerplate, ... }:
 
 with lib;
 
@@ -35,12 +35,15 @@ with lib;
         default = "c++20";
       };
 
-      attrs = mkOption {
+      interface.attrs = mkOption {
+        example = boilerplate.attrsTitle;
+        description = boilerplate.attrsDescription;
         type = types.listOf types.str;
         default = ["cpp"];
       };
-
-      extensions = mkOption {
+      interface.extensions = mkOption {
+        example = boilerplate.extensionsTitle;
+        description = boilerplate.extensionsDescription;
         type = types.listOf types.str;
         default = ["cpp" "hpp" "cxx" "hxx" "c" "h"];
       };

modules/kernels/go/default.nix

@@ -10,7 +10,8 @@
 , settingsSchema
 }:
 
-with { inherit (settings) packages attrs extensions; };
+with { inherit (settings) packages; };
+with { inherit (settings.interface) attrs extensions; };
 
 with lib;
 

modules/kernels/go/module.nix

@@ -1,4 +1,4 @@
-{ config, options, lib, pkgs, nixosOptionsToSettingsSchema, ... }:
+{ config, options, lib, pkgs, nixosOptionsToSettingsSchema, boilerplate, ... }:
 
 with lib;
 
@@ -26,12 +26,15 @@ with lib;
         default = "go";
       };
 
-      attrs = mkOption {
+      interface.attrs = mkOption {
+        example = boilerplate.attrsTitle;
+        description = boilerplate.attrsDescription;
         type = types.listOf types.str;
         default = ["go"];
       };
-
-      extensions = mkOption {
+      interface.extensions = mkOption {
+        example = boilerplate.extensionsTitle;
+        description = boilerplate.extensionsDescription;
         type = types.listOf types.str;
         default = ["go"];
       };

modules/kernels/haskell/default.nix

@@ -13,7 +13,8 @@
 , settingsSchema
 }:
 
-with { inherit (settings) packages attrs extensions; };
+with { inherit (settings) packages; };
+with { inherit (settings.interface) attrs extensions; };
 
 with lib;
 

modules/kernels/haskell/module.nix

@@ -1,4 +1,4 @@
-{ config, options, lib, pkgs, nixosOptionsToSettingsSchema, ... }:
+{ config, options, lib, pkgs, nixosOptionsToSettingsSchema, boilerplate, ... }:
 
 with lib;
 
@@ -16,18 +16,20 @@ with lib;
         type = types.listOf (types.either types.str types.attrs);
         default = [];
       };
-
       ghcPackage = mkOption {
         type = types.enum ["ghc92" "ghc94" "ghc96" "ghc98"];
         default = "ghc92";
       };
 
-      attrs = mkOption {
+      interface.attrs = mkOption {
+        example = boilerplate.attrsTitle;
+        description = boilerplate.attrsDescription;
         type = types.listOf types.str;
         default = ["haskell"];
       };
-
-      extensions = mkOption {
+      interface.extensions = mkOption {
+        example = boilerplate.extensionsTitle;
+        description = boilerplate.extensionsDescription;
         type = types.listOf types.str;
         default = ["hs"];
       };

modules/kernels/julia/default.nix

@@ -13,7 +13,8 @@
 , settingsSchema
 }:
 
-with { inherit (settings) packages attrs extensions; };
+with { inherit (settings) packages; };
+with { inherit (settings.interface) attrs extensions; };
 
 with lib;
 

modules/kernels/julia/module.nix

@@ -1,4 +1,4 @@
-{ config, options, lib, pkgs, nixosOptionsToSettingsSchema, ... }:
+{ config, options, lib, pkgs, nixosOptionsToSettingsSchema, boilerplate, ... }:
 
 with lib;
 
@@ -29,12 +29,15 @@ with lib;
         default = "julia";
       };
 
-      attrs = mkOption {
+      interface.attrs = mkOption {
+        example = boilerplate.attrsTitle;
+        description = boilerplate.attrsDescription;
         type = types.listOf types.str;
         default = ["julia"];
       };
-
-      extensions = mkOption {
+      interface.extensions = mkOption {
+        example = boilerplate.extensionsTitle;
+        description = boilerplate.extensionsDescription;
         type = types.listOf types.str;
         default = ["jl"];
       };

modules/kernels/octave/default.nix

@@ -14,7 +14,8 @@
 , settingsSchema
 }:
 
-with { inherit (settings) packages attrs extensions; };
+with { inherit (settings) packages; };
+with { inherit (settings.interface) attrs extensions; };
 
 with lib;
 

modules/kernels/octave/module.nix

@@ -1,4 +1,4 @@
-{ config, options, lib, pkgs, nixosOptionsToSettingsSchema, ... }:
+{ config, options, lib, pkgs, nixosOptionsToSettingsSchema, boilerplate, ... }:
 
 with lib;
 
@@ -17,12 +17,15 @@ with lib;
         default = [];
       };
 
-      attrs = mkOption {
+      interface.attrs = mkOption {
+        example = boilerplate.attrsTitle;
+        description = boilerplate.attrsDescription;
         type = types.listOf types.str;
         default = ["octave"];
       };
-
-      extensions = mkOption {
+      interface.extensions = mkOption {
+        example = boilerplate.extensionsTitle;
+        description = boilerplate.extensionsDescription;
         type = types.listOf types.str;
         default = ["m"];
       };

modules/kernels/postgres/default.nix

@@ -8,7 +8,8 @@
 , settingsSchema
 }:
 
-with { inherit (settings) packages attrs extensions; };
+with { inherit (settings) packages; };
+with { inherit (settings.interface) attrs extensions; };
 
 let
   common = callPackage ../common.nix {};

modules/kernels/postgres/module.nix

@@ -1,4 +1,4 @@
-{ config, options, lib, pkgs, nixosOptionsToSettingsSchema, ... }:
+{ config, options, lib, pkgs, nixosOptionsToSettingsSchema, boilerplate, ... }:
 
 with lib;
 
@@ -15,12 +15,15 @@ with lib;
         default = [];
       };
 
-      attrs = mkOption {
+      interface.attrs = mkOption {
+        example = boilerplate.attrsTitle;
+        description = boilerplate.attrsDescription;
         type = types.listOf types.str;
         default = ["postgres"];
       };
-
-      extensions = mkOption {
+      interface.extensions = mkOption {
+        example = boilerplate.extensionsTitle;
+        description = boilerplate.extensionsDescription;
         type = types.listOf types.str;
         default = ["sql"];
       };

modules/kernels/r/default.nix

@@ -11,7 +11,8 @@
 , settingsSchema
 }:
 
-with { inherit (settings) packages attrs extensions; };
+with { inherit (settings) packages; };
+with { inherit (settings.interface) attrs extensions; };
 
 with lib;
 

modules/kernels/r/module.nix

@@ -1,4 +1,4 @@
-{ config, options, lib, pkgs, nixosOptionsToSettingsSchema, ... }:
+{ config, options, lib, pkgs, nixosOptionsToSettingsSchema, boilerplate, ... }:
 
 with lib;
 
@@ -17,12 +17,15 @@ with lib;
         default = [];
       };
 
-      attrs = mkOption {
+      interface.attrs = mkOption {
+        example = boilerplate.attrsTitle;
+        description = boilerplate.attrsDescription;
         type = types.listOf types.str;
         default = ["r" "R"];
       };
-
-      extensions = mkOption {
+      interface.extensions = mkOption {
+        example = boilerplate.extensionsTitle;
+        description = boilerplate.extensionsDescription;
         type = types.listOf types.str;
         default = ["r"];
       };

modules/kernels/ruby/default.nix

@@ -12,7 +12,8 @@
 , settingsSchema
 }:
 
-with { inherit (settings) packages attrs extensions; };
+with { inherit (settings) packages; };
+with { inherit (settings.interface) attrs extensions; };
 
 with lib;
 

modules/kernels/ruby/module.nix

@@ -1,4 +1,4 @@
-{ config, options, lib, nixosOptionsToSettingsSchema, ... }:
+{ config, options, lib, nixosOptionsToSettingsSchema, boilerplate, ... }:
 
 with lib;
 
@@ -31,20 +31,23 @@ in
         default = "ruby";
       };
 
-      attrs = mkOption {
+      interface.attrs = mkOption {
+        example = boilerplate.attrsTitle;
+        description = boilerplate.attrsDescription;
         type = types.listOf types.str;
         default = ["ruby"];
       };
-
-      extensions = mkOption {
+      interface.extensions = mkOption {
+        example = boilerplate.extensionsTitle;
+        description = boilerplate.extensionsDescription;
         type = types.listOf types.str;
         default = ["rb"];
       };
 
       lsp.solargraph.enable = mkOption {
+        example = "Enable Solargraph language server";
         type = types.bool;
         default = true;
-        description = "Enable Solargraph language server";
       };
     };
   };

modules/kernels/rust/default.nix

@@ -13,7 +13,8 @@
 , settingsSchema
 }:
 
-with { inherit (settings) packages attrs extensions; };
+with { inherit (settings) packages; };
+with { inherit (settings.interface) attrs extensions; };
 
 with lib;