NotAShelf/nvf
2
1
Fork 0
mirror of https://github.com/NotAShelf/nvf.git synced 2025-09-06 02:11:33 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

docs: fix mkEnableOption usage for autogenerated documentation

Browse source
This commit is contained in:
NotAShelf 2023-06-05 23:10:25 +03:00
commit a2b58e17af
No known key found for this signature in database
GPG key ID: F0D14CCB5ED5AA22
55 changed files with 225 additions and 333 deletions
Download patch file Download diff file Expand all files Collapse all files

15
modules/languages/clang.nix
View file

@ -47,31 +47,26 @@ in {
};
treesitter = {
enable = mkOption {
description = "Enable C/C++ treesitter";
type = types.bool;
default = config.vim.languages.enableTreesitter;
};
enable = mkEnableOption "C/C++ treesitter" // {default = config.vim.languages.enableTreesitter;};
cPackage = nvim.types.mkGrammarOption pkgs "c";
cppPackage = nvim.types.mkGrammarOption pkgs "cpp";
};
lsp = {
enable = mkOption {
description = "Enable clang LSP support";
type = types.bool;
default = config.vim.languages.enableLSP;
};
enable = mkEnableOption "Enable clang LSP support" // {default = config.vim.languages.enableLSP;};
server = mkOption {
description = "The clang LSP server to use";
type = with types; enum (attrNames servers);
default = defaultServer;
};
package = mkOption {
description = "clang LSP server package";
type = types.package;
default = servers.${cfg.lsp.server}.package;
};
opts = mkOption {
description = "Options to pass to clang LSP server";
type = with types; nullOr str;

8
modules/languages/dart/dart.nix
View file

@ -26,16 +26,12 @@ in {
enable = mkEnableOption "Dart language support";
treesitter = {
enable = mkOption {
description = "Enable Dart treesitter";
type = types.bool;
default = config.vim.languages.enableTreesitter;
};
enable = mkEnableOption "Enable Dart treesitter" // {default = config.vim.languages.enableTreesitter;};
package = nvim.types.mkGrammarOption pkgs "dart";
};
lsp = {
enable = mkEnableOption "Enable Dart LSP support";
enable = mkEnableOption "Dart LSP support";
server = mkOption {
description = "The Dart LSP server to use";
type = with types; enum (attrNames servers);

2
modules/languages/elixir/elixir-tools.nix
View file

@ -6,6 +6,6 @@
with lib;
with builtins; {
options.vim.languages.elixir = {
enable = mkEnableOption "elixir support";
enable = mkEnableOption "Elixir language support";
};
}

15
modules/languages/go.nix
View file

@ -26,25 +26,20 @@ in {
enable = mkEnableOption "Go language support";
treesitter = {
enable = mkOption {
description = "Enable Go treesitter";
type = types.bool;
default = config.vim.languages.enableTreesitter;
};
enable = mkEnableOption "Enable Go treesitter" // {default = config.vim.languages.enableTreesitter;};
package = nvim.types.mkGrammarOption pkgs "go";
};
lsp = {
enable = mkOption {
description = "Enable Go LSP support";
type = types.bool;
default = config.vim.languages.enableLSP;
};
enable = mkEnableOption "Enable Go LSP support" // {default = config.vim.languages.enableLSP;};
server = mkOption {
description = "Go LSP server to use";
type = with types; enum (attrNames servers);
default = defaultServer;
};
package = mkOption {
description = "Go LSP server package";
type = types.package;

2
modules/languages/markdown/markdown.nix
View file

@ -9,7 +9,7 @@ with builtins; let
cfg = config.vim.languages.markdown;
in {
options.vim.languages.markdown = {
enable = mkEnableOption "Markdown language support";
enable = mkEnableOption "Markdown markup language support";
glow.enable = mkOption {
type = types.bool;

14
modules/languages/nix.nix
View file

@ -96,11 +96,8 @@ in {
};
lsp = {
enable = mkOption {
description = "Enable Nix LSP support";
type = types.bool;
default = config.vim.languages.enableLSP;
};
enable = mkEnableOption "Enable Nix LSP support" // {default = config.vim.languages.enableLSP;};
server = mkOption {
description = "Nix LSP server to use";
type = types.str;
@ -114,11 +111,8 @@ in {
};
format = {
enable = mkOption {
description = "Enable Nix formatting";
type = types.bool;
default = config.vim.languages.enableFormat;
};
enable = mkEnableOption "Enable Nix formatting" // {default = config.vim.languages.enableFormat;};
type = mkOption {
description = "Nix formatter to use";
type = with types; enum (attrNames formats);

22
modules/languages/python.nix
View file

@ -41,11 +41,7 @@ in {
enable = mkEnableOption "Python language support";
treesitter = {
enable = mkOption {
description = "Enable Python treesitter";
type = types.bool;
default = config.vim.languages.enableTreesitter;
};
enable = mkEnableOption "Enable Python treesitter" // {default = config.vim.languages.enableTreesitter;};
package = mkOption {
description = "Python treesitter grammar to use";
type = types.package;
@ -54,16 +50,14 @@ in {
};
lsp = {
enable = mkOption {
description = "Enable Python LSP support";
type = types.bool;
default = config.vim.languages.enableLSP;
};
enable = mkEnableOption "Enable Python LSP support" // {default = config.vim.languages.enableLSP;};
server = mkOption {
description = "Python LSP server to use";
type = with types; enum (attrNames servers);
default = defaultServer;
};
package = mkOption {
description = "python LSP server package";
type = types.package;
@ -72,16 +66,14 @@ in {
};
format = {
enable = mkOption {
description = "Enable Python formatting";
type = types.bool;
default = config.vim.languages.enableFormat;
};
enable = mkEnableOption "Enable Python formatting" // {default = config.vim.languages.enableFormat;};
type = mkOption {
description = "Python formatter to use";
type = with types; enum (attrNames formats);
default = defaultFormat;
};
package = mkOption {
description = "Python formatter package";
type = types.package;

14
modules/languages/rust.nix
View file

@ -12,11 +12,7 @@ in {
enable = mkEnableOption "Rust language support";
treesitter = {
enable = mkOption {
description = "Enable Rust treesitter";
type = types.bool;
default = config.vim.languages.enableTreesitter;
};
enable = mkEnableOption "Enable Rust treesitter" // {default = config.vim.languages.enableTreesitter;};
package = nvim.types.mkGrammarOption pkgs "rust";
};
@ -30,16 +26,14 @@ in {
};
lsp = {
enable = mkOption {
description = "Rust LSP support (rust-analyzer with extra tools)";
type = types.bool;
default = config.vim.languages.enableLSP;
};
enable = mkEnableOption "Rust LSP support (rust-analyzer with extra tools)" // {default = config.vim.languages.enableLSP;};
package = mkOption {
description = "rust-analyzer package";
type = types.package;
default = pkgs.rust-analyzer;
};
opts = mkOption {
description = "Options to pass to rust analyzer";
type = types.str;

30
modules/languages/sql.nix
View file

@ -68,11 +68,8 @@ in {
};
treesitter = {
enable = mkOption {
description = "Enable SQL treesitter";
type = types.bool;
default = config.vim.languages.enableTreesitter;
};
enable = mkEnableOption "Enable SQL treesitter" // {default = config.vim.languages.enableTreesitter;};
package = mkOption {
description = "SQL treesitter grammar to use";
type = types.package;
@ -81,16 +78,14 @@ in {
};
lsp = {
enable = mkOption {
description = "Enable SQL LSP support";
type = types.bool;
default = config.vim.languages.enableLSP;
};
enable = mkEnableOption "Enable SQL LSP support" // {default = config.vim.languages.enableLSP;};
server = mkOption {
description = "SQL LSP server to use";
type = with types; enum (attrNames servers);
default = defaultServer;
};
package = mkOption {
description = "SQL LSP server package";
type = types.package;
@ -99,16 +94,14 @@ in {
};
format = {
enable = mkOption {
description = "Enable SQL formatting";
type = types.bool;
default = config.vim.languages.enableFormat;
};
enable = mkEnableOption "Enable SQL formatting" // {default = config.vim.languages.enableFormat;};
type = mkOption {
description = "SQL formatter to use";
type = with types; enum (attrNames formats);
default = defaultFormat;
};
package = mkOption {
description = "SQL formatter package";
type = types.package;
@ -117,11 +110,8 @@ in {
};
extraDiagnostics = {
enable = mkOption {
description = "Enable extra SQL diagnostics";
type = types.bool;
default = config.vim.languages.enableExtraDiagnostics;
};
enable = mkEnableOption "Enable extra SQL diagnostics" // {default = config.vim.languages.enableExtraDiagnostics;};
types = lib.nvim.types.diagnostics {
langDesc = "SQL";
inherit diagnostics;

30
modules/languages/svelte.nix
View file

@ -58,25 +58,20 @@ in {
enable = mkEnableOption "Svelte language support";
treesitter = {
enable = mkOption {
description = "Enable Svelte treesitter";
type = types.bool;
default = config.vim.languages.enableTreesitter;
};
enable = mkEnableOption "Enable Svelte treesitter" // {default = config.vim.languages.enableTreesitter;};
sveltePackage = nvim.types.mkGrammarOption pkgs "svelte";
};
lsp = {
enable = mkOption {
description = "Enable Svelte LSP support";
type = types.bool;
default = config.vim.languages.enableLSP;
};
enable = mkEnableOption "Enable Svelte LSP support" // {default = config.vim.languages.enableLSP;};
server = mkOption {
description = "Svelte LSP server to use";
type = with types; enum (attrNames servers);
default = defaultServer;
};
package = mkOption {
description = "Svelte LSP server package";
type = types.package;
@ -85,16 +80,14 @@ in {
};
format = {
enable = mkOption {
description = "Enable Svelte formatting";
type = types.bool;
default = config.vim.languages.enableFormat;
};
enable = mkEnableOption "Enable Svelte formatting" // {default = config.vim.languages.enableFormat;};
type = mkOption {
description = "Svelte formatter to use";
type = with types; enum (attrNames formats);
default = defaultFormat;
};
package = mkOption {
description = "Svelte formatter package";
type = types.package;
@ -103,11 +96,8 @@ in {
};
extraDiagnostics = {
enable = mkOption {
description = "Enable extra Svelte diagnostics";
type = types.bool;
default = config.vim.languages.enableExtraDiagnostics;
};
enable = mkEnableOption "Enable extra Svelte diagnostics" // {default = config.vim.languages.enableExtraDiagnostics;};
types = lib.nvim.types.diagnostics {
langDesc = "Svelte";
inherit diagnostics;

2
modules/languages/tidal/tidal.nix
View file

@ -6,7 +6,7 @@
with lib;
with builtins; {
options.vim.tidal = {
enable = mkEnableOption "Enable tidalcycles tools and plugins";
enable = mkEnableOption "tidalcycles tools and plugins";
flash = mkOption {
description = ''When sending a paragraph or a single line, vim-tidal will "flash" the selection for some milliseconds'';

29
modules/languages/ts.nix
View file

@ -58,26 +58,20 @@ in {
enable = mkEnableOption "Typescript/Javascript language support";
treesitter = {
enable = mkOption {
description = "Enable Typescript/Javascript treesitter";
type = types.bool;
default = config.vim.languages.enableTreesitter;
};
enable = mkEnableOption "Enable Typescript/Javascript treesitter" // {default = config.vim.languages.enableTreesitter;};
tsPackage = nvim.types.mkGrammarOption pkgs "tsx";
jsPackage = nvim.types.mkGrammarOption pkgs "javascript";
};
lsp = {
enable = mkOption {
description = "Enable Typescript/Javascript LSP support";
type = types.bool;
default = config.vim.languages.enableLSP;
};
enable = mkEnableOption "Enable Typescript/Javascript LSP support" // {default = config.vim.languages.enableLSP;};
server = mkOption {
description = "Typescript/Javascript LSP server to use";
type = with types; enum (attrNames servers);
default = defaultServer;
};
package = mkOption {
description = "Typescript/Javascript LSP server package";
type = types.package;
@ -86,16 +80,14 @@ in {
};
format = {
enable = mkOption {
description = "Enable Typescript/Javascript formatting";
type = types.bool;
default = config.vim.languages.enableFormat;
};
enable = mkEnableOption "Enable Typescript/Javascript formatting" // {default = config.vim.languages.enableFormat;};
type = mkOption {
description = "Typescript/Javascript formatter to use";
type = with types; enum (attrNames formats);
default = defaultFormat;
};
package = mkOption {
description = "Typescript/Javascript formatter package";
type = types.package;
@ -104,11 +96,8 @@ in {
};
extraDiagnostics = {
enable = mkOption {
description = "Enable extra Typescript/Javascript diagnostics";
type = types.bool;
default = config.vim.languages.enableExtraDiagnostics;
};
enable = mkEnableOption "Enable extra Typescript/Javascript diagnostics" // {default = config.vim.languages.enableExtraDiagnostics;};
types = lib.nvim.types.diagnostics {
langDesc = "Typescript/Javascript";
inherit diagnostics;

15
modules/languages/zig.nix
View file

@ -12,24 +12,19 @@ in {
enable = mkEnableOption "SQL language support";
treesitter = {
enable = mkOption {
description = "Enable Zig treesitter";
type = types.bool;
default = config.vim.languages.enableTreesitter;
};
enable = mkEnableOption "Enable Zig treesitter" // {default = config.vim.languages.enableTreesitter;};
package = nvim.types.mkGrammarOption pkgs "zig";
};
lsp = {
enable = mkOption {
description = "Zig LSP support (zls)";
type = types.bool;
default = config.vim.languages.enableLSP;
};
enable = mkEnableOption "Zig LSP support (zls)" // {default = config.vim.languages.enableLSP;};
package = mkOption {
description = "ZLS package";
type = types.package;
default = pkgs.zls;
};
zigPackage = mkOption {
description = "Zig package used by ZLS";
type = types.package;