Skip to content

Commit c548fb3

Browse files
thomasjmthomasjm
committed
Settings schema test passing; all items have defaultValue + title
1 parent a1da134 commit c548fb3

File tree

12 files changed

+52
-36
lines changed

12 files changed

+52
-36
lines changed

‎modules/kernels/bash/module.nix

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ with lib;
66
options = {
77
kernels.bash = {
88
enable = mkOption {
9-
description = "Enable Bash kernel";
9+
example = "Enable Bash kernel";
1010
type = types.bool;
1111
default = false;
1212
visible = false;
@@ -26,9 +26,9 @@ with lib;
2626
};
2727

2828
lsp.bash-language-server.enable = mkOption {
29+
example = "Enable Bash language server";
2930
type = types.bool;
3031
default = true;
31-
description = "Enable Bash language server";
3232
};
3333
};
3434
};

‎modules/kernels/clojure/module.nix

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ with lib;
66
options = {
77
kernels.clojure = {
88
enable = mkOption {
9-
description = "Enable Clojure kernel";
9+
example = "Enable Clojure kernel";
1010
type = types.bool;
1111
default = false;
1212
visible = false;
@@ -26,9 +26,9 @@ with lib;
2626
};
2727

2828
lsp.clojure-lsp.enable = mkOption {
29+
example = "Enable clojure-lsp language server";
2930
type = types.bool;
3031
default = true;
31-
description = "Enable clojure-lsp language server";
3232
};
3333
};
3434
};

‎modules/kernels/cpp/module.nix

+3-1
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,20 @@ with lib;
66
options = {
77
kernels.cpp = {
88
enable = mkOption {
9-
description = "Enable C++ kernel";
9+
example = "Enable C++ kernel";
1010
type = types.bool;
1111
default = false;
1212
visible = false;
1313
};
1414

1515
packages = mkOption {
16+
example = "List of packages";
1617
type = types.listOf (types.either types.str types.attrs);
1718
default = [];
1819
};
1920

2021
flavor = mkOption {
22+
example = "C++ flavor";
2123
type = types.enum [
2224
"c++11"
2325
"c++14"

‎modules/kernels/go/module.nix

+5-3
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,20 @@ with lib;
66
options = {
77
kernels.go = {
88
enable = mkOption {
9-
description = "Enable Go kernel";
9+
example = "Enable Go kernel";
1010
type = types.bool;
1111
default = false;
1212
visible = false;
1313
};
1414

1515
packages = mkOption {
16+
example = "List of packages";
1617
type = types.listOf (types.either types.str types.attrs);
1718
default = [];
1819
};
1920

2021
goPackage = mkOption {
22+
example = "Go version";
2123
type = types.enum (
2224
["go"]
2325
++ (builtins.filter (name: builtins.substring 0 (builtins.stringLength "go_") name == "go_")
@@ -40,14 +42,14 @@ with lib;
4042
};
4143

4244
lsp.gopls.enable = mkOption {
45+
example = "Enable gopls language server";
4346
type = types.bool;
44-
description = "Enable gopls language server";
4547
default = true;
4648
};
4749

4850
go.gocache = mkOption {
51+
example = "Value of GOCACHE environment variable";
4952
type = types.str;
50-
description = "Value of GOCACHE environment variable";
5153
default = "/home/.gocache";
5254
};
5355
};

‎modules/kernels/haskell/module.nix

+7-5
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,19 @@ with lib;
66
options = {
77
kernels.haskell = {
88
enable = mkOption {
9-
description = "Enable Haskell kernel";
9+
example = "Enable Haskell kernel";
1010
type = types.bool;
1111
default = false;
1212
visible = false;
1313
};
1414

1515
packages = mkOption {
16+
example = "List of packages";
1617
type = types.listOf (types.either types.str types.attrs);
1718
default = [];
1819
};
1920
ghcPackage = mkOption {
21+
example = "GHC version";
2022
type = types.enum ["ghc92" "ghc94" "ghc96" "ghc98"];
2123
default = "ghc92";
2224
};
@@ -35,23 +37,23 @@ with lib;
3537
};
3638

3739
lsp.haskell-language-server.enable = mkOption {
38-
description = "Enable haskell-language-server";
40+
example = "Enable haskell-language-server";
3941
type = types.bool;
4042
default = true;
4143
};
4244
lsp.haskell-language-server.debug = mkOption {
43-
description = "Haskell-language-server: enable debug output";
45+
example = "Haskell-language-server: enable debug output";
4446
type = types.bool;
4547
default = false;
4648
};
4749
lsp.haskell-language-server.super-debug = mkOption {
48-
description = "Haskell-language-server: enable verbose debug output";
50+
example = "Haskell-language-server: enable verbose debug output";
4951
type = types.bool;
5052
default = false;
5153
};
5254

5355
enableHlintOutput = mkOption {
54-
description = "Enable hlint warnings in Jupyter kernel output. Normally you don't want this because it is provided by haskell-language-server.";
56+
example = "Enable hlint warnings in Jupyter kernel output. Normally you don't want this because it is provided by haskell-language-server.";
5557
type = types.bool;
5658
default = false;
5759
};

‎modules/kernels/julia/module.nix

+8-5
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,20 @@ with lib;
66
options = {
77
kernels.julia = {
88
enable = mkOption {
9-
description = "Enable Haskell kernel";
9+
example = "Enable Haskell kernel";
1010
type = types.bool;
1111
default = false;
1212
visible = false;
1313
};
1414

1515
packages = mkOption {
16+
example = "List of packages";
1617
type = types.listOf (types.either types.str types.attrs);
1718
default = [];
1819
};
1920

2021
juliaPackage = mkOption {
22+
example = "Julia version";
2123
type = types.enum (
2224
["julia"]
2325
++ (builtins.filter (n:
@@ -43,23 +45,24 @@ with lib;
4345
};
4446

4547
precompile = mkOption {
46-
description = "Precompile Julia environment for faster imports. In some cases, precompilation can make the build fail, so turning this off can help.";
48+
example = "Precompile Julia environment for faster imports";
49+
description = "In some cases, precompilation can make the build fail, so turning this off can help.";
4750
type = types.bool;
4851
default = true;
4952
};
5053

5154
lsp.LanguageServer.enable = mkOption {
52-
description = "Enable LanguageServer language server";
55+
example = "Enable LanguageServer language server";
5356
type = types.bool;
5457
default = true;
5558
};
5659
lsp.LanguageServer.index = mkOption {
57-
description = "LanguageServer: auto-index packages when building environment";
60+
example = "Auto-index packages when building environment";
5861
type = types.bool;
5962
default = true;
6063
};
6164
lsp.LanguageServer.debug = mkOption {
62-
description = "LanguageServer: log debug messages to stderr";
65+
example = "Log debug messages to stderr";
6366
type = types.bool;
6467
default = false;
6568
};

‎modules/kernels/octave/module.nix

+3-2
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,14 @@ with lib;
66
options = {
77
kernels.octave = {
88
enable = mkOption {
9-
description = "Enable Octave kernel";
9+
example = "Enable Octave kernel";
1010
type = types.bool;
1111
default = false;
1212
visible = false;
1313
};
1414

1515
packages = mkOption {
16+
example = "List of packages";
1617
type = types.listOf (types.either types.str types.attrs);
1718
default = [];
1819
};
@@ -31,9 +32,9 @@ with lib;
3132
};
3233

3334
extraJupyterConfig = mkOption {
35+
example = "Extra Jupyter configuration";
3436
type = types.str;
3537
default = "";
36-
description = "Extra Jupyter configuration.";
3738
};
3839
};
3940
};

‎modules/kernels/postgres/module.nix

+2
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,13 @@ with lib;
66
options = {
77
kernels.postgres = {
88
enable = mkOption {
9+
example = "Enable PostgreSQL kernel";
910
type = types.bool;
1011
default = false;
1112
};
1213

1314
packages = mkOption {
15+
example = "List of packages";
1416
type = types.listOf (types.either types.str types.attrs);
1517
default = [];
1618
};

‎modules/kernels/python/module.nix

+8-8
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@ let
66
mkOptions = packageOption: {
77
enable = mkOption {
88
example = "Enable Python 3 kernel";
9-
description = "Enable Python 3 kernel";
109
type = types.bool;
1110
default = false;
1211
visible = false;
1312
};
1413

1514
packages = mkOption {
15+
example = "List of packages";
1616
type = types.listOf (types.either types.str types.attrs);
1717
default = [];
1818
};
@@ -38,37 +38,37 @@ let
3838
default = true;
3939
};
4040
lsp.pyright.enable = mkOption {
41-
description = "Enable Pyright language server";
41+
example = "Enable Pyright language server";
4242
type = types.bool;
4343
default = false;
4444
};
4545
lsp.pylint.enable = mkOption {
46-
description = "Enable Pylint language server";
46+
example = "Enable Pylint language server";
4747
type = types.bool;
4848
default = false;
4949
};
5050
lsp.flake8.enable = mkOption {
51-
description = "Enable Flake8 language server";
51+
example = "Enable Flake8 language server";
5252
type = types.bool;
5353
default = false;
5454
};
5555
lsp.pycodestyle.enable = mkOption {
56-
description = "Enable pycodestyle language server";
56+
example = "Enable pycodestyle language server";
5757
type = types.bool;
5858
default = false;
5959
};
6060
lsp.microsoft.enable = mkOption {
61-
description = "Enable Microsoft Python language server";
61+
example = "Enable Microsoft Python language server";
6262
type = types.bool;
6363
default = false;
6464
};
6565
lsp.python-lsp-server.enable = mkOption {
66-
description = "Enable python-lsp-server language server";
66+
example = "Enable python-lsp-server language server";
6767
type = types.bool;
6868
default = false;
6969
};
7070
lsp.python-language-server.enable = mkOption {
71-
description = "Enable python-language-server language server";
71+
example = "Enable python-language-server language server";
7272
type = types.bool;
7373
default = false;
7474
};

‎modules/kernels/r/module.nix

+3-2
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,14 @@ with lib;
66
options = {
77
kernels.R = {
88
enable = mkOption {
9-
description = "Enable R kernel";
9+
example = "Enable R kernel";
1010
type = types.bool;
1111
default = false;
1212
visible = false;
1313
};
1414

1515
packages = mkOption {
16+
example = "List of packages";
1617
type = types.listOf (types.either types.str types.attrs);
1718
default = [];
1819
};
@@ -31,9 +32,9 @@ with lib;
3132
};
3233

3334
lsp.languageserver.enable = mkOption {
35+
example = "Enable languageserver";
3436
type = types.bool;
3537
default = true;
36-
description = "Enable languageserver";
3738
};
3839
};
3940
};

‎modules/kernels/ruby/module.nix

+3-1
Original file line numberDiff line numberDiff line change
@@ -11,18 +11,20 @@ in
1111
options = {
1212
kernels.ruby = {
1313
enable = mkOption {
14-
description = "Enable Ruby kernel";
14+
example = "Enable Ruby kernel";
1515
type = types.bool;
1616
default = false;
1717
visible = false;
1818
};
1919

2020
packages = mkOption {
21+
example = "List of packages";
2122
type = types.listOf (types.either types.str types.attrs);
2223
default = [];
2324
};
2425

2526
rubyPackage = mkOption {
27+
example = "Ruby version";
2628
type = types.enum (
2729
["ruby"]
2830
++ (builtins.filter (name: builtins.substring 0 (builtins.stringLength "ruby_") name == "ruby_")

‎modules/kernels/rust/module.nix

+6-5
Original file line numberDiff line numberDiff line change
@@ -13,22 +13,24 @@ with lib;
1313
};
1414

1515
packages = mkOption {
16+
example = "List of packages";
1617
type = types.listOf (types.either types.str (types.submodule {
1718
options = {
1819
name = mkOption rec {
19-
type = types.str;
2020
description = "Package name";
21+
type = types.str;
2122
};
2223
features = mkOption rec {
24+
example = "Features to enable for the package";
2325
type = types.listOf types.str;
24-
description = "Features to enable for the package";
2526
};
2627
};
2728
}));
2829
default = [];
2930
};
3031

3132
rustPackage = mkOption {
33+
example = "Rust version";
3234
type = types.enum (
3335
["rust"]
3436
++ (builtins.filter (name: builtins.substring 0 (builtins.stringLength "rust_") name == "rust_")
@@ -51,14 +53,13 @@ with lib;
5153
};
5254

5355
lsp.rust-analyzer.enable = mkOption {
56+
example = "Rust-analyzer: enable";
5457
type = types.bool;
55-
description = "Rust-analyzer: enable";
5658
default = true;
5759
};
58-
5960
lsp.rust-analyzer.debug = mkOption {
61+
example = "Rust-analyzer: debug output";
6062
type = types.bool;
61-
description = "Rust-analyzer: debug output";
6263
default = false;
6364
};
6465
};

0 commit comments

Comments
 (0)