plugins: clean up module descriptions

Only for the `enable` option though.
This commit is contained in:
Gabriel Arazas 2024-01-26 22:05:52 +08:00 committed by Gaétan Lepage
parent 56b1082525
commit 6b0f03e4a1
10 changed files with 77 additions and 82 deletions

View file

@ -17,7 +17,6 @@ in
mkVimPlugin {inherit lib config pkgs;} { mkVimPlugin {inherit lib config pkgs;} {
inherit name; inherit name;
extraPlugins = extraPlugins ++ (lists.optional useDefaultPackage pkgs.vimPlugins.${name}); extraPlugins = extraPlugins ++ (lists.optional useDefaultPackage pkgs.vimPlugins.${name});
description = "Enable ${name}";
}; };
pluginAndSourceNames = { pluginAndSourceNames = {

View file

@ -9,7 +9,7 @@ in
with lib; with lib;
mkVimPlugin attrs { mkVimPlugin attrs {
name = "fugitive"; name = "fugitive";
description = "Enable vim-fugitive"; description = "vim-fugitive";
package = pkgs.vimPlugins.vim-fugitive; package = pkgs.vimPlugins.vim-fugitive;
extraPackages = [pkgs.git]; extraPackages = [pkgs.git];

View file

@ -9,7 +9,7 @@ in
with lib; with lib;
mkVimPlugin attrs { mkVimPlugin attrs {
name = "nix"; name = "nix";
description = "Enable nix"; description = "vim-nix";
package = pkgs.vimPlugins.vim-nix; package = pkgs.vimPlugins.vim-nix;
# Possibly add option to disable Treesitter highlighting if this is installed # Possibly add option to disable Treesitter highlighting if this is installed

View file

@ -9,7 +9,7 @@ in
with lib; with lib;
mkVimPlugin attrs { mkVimPlugin attrs {
name = "zig"; name = "zig";
description = "Enable zig"; description = "zig.vim";
package = pkgs.vimPlugins.zig-vim; package = pkgs.vimPlugins.zig-vim;
globalPrefix = "zig_"; globalPrefix = "zig_";

View file

@ -11,70 +11,70 @@ with lib; let
servers = [ servers = [
{ {
name = "ansiblels"; name = "ansiblels";
description = "Enable ansiblels, for Ansible"; description = "ansiblels for Ansible";
package = pkgs.ansible-language-server; package = pkgs.ansible-language-server;
cmd = cfg: ["${cfg.package}/bin/ansible-language-server" "--stdio"]; cmd = cfg: ["${cfg.package}/bin/ansible-language-server" "--stdio"];
} }
{ {
name = "astro"; name = "astro";
description = "Enable astrols, for Astro"; description = "astrols for Astro";
package = pkgs.nodePackages."@astrojs/language-server"; package = pkgs.nodePackages."@astrojs/language-server";
cmd = cfg: ["${cfg.package}/bin/astro-ls" "--stdio"]; cmd = cfg: ["${cfg.package}/bin/astro-ls" "--stdio"];
} }
{ {
name = "bashls"; name = "bashls";
description = "Enable bashls, for bash."; description = "bashls for bash";
package = pkgs.nodePackages.bash-language-server; package = pkgs.nodePackages.bash-language-server;
} }
{ {
name = "beancount"; name = "beancount";
description = "Enable beancount-language-server"; description = "beancount-language-server";
package = pkgs.beancount-language-server; package = pkgs.beancount-language-server;
} }
{ {
name = "biome"; name = "biome";
description = "Enable Biome, Toolchain of the Web"; description = "Biome, Toolchain of the Web";
} }
{ {
name = "ccls"; name = "ccls";
description = "Enable ccls, for C/C++."; description = "ccls for C/C++";
} }
{ {
name = "clangd"; name = "clangd";
description = "Enable clangd LSP, for C/C++."; description = "clangd LSP for C/C++";
package = pkgs.clang-tools; package = pkgs.clang-tools;
} }
{ {
name = "clojure-lsp"; name = "clojure-lsp";
description = "Enable clojure-lsp, for clojure."; description = "clojure-lsp for Clojure";
serverName = "clojure_lsp"; serverName = "clojure_lsp";
package = pkgs.clojure-lsp; package = pkgs.clojure-lsp;
} }
{ {
name = "cmake"; name = "cmake";
description = "Enable cmake language server, for cmake files."; description = "cmake language server";
package = pkgs.cmake-language-server; package = pkgs.cmake-language-server;
} }
{ {
name = "csharp-ls"; name = "csharp-ls";
description = "Enable csharp-ls, for C#."; description = "csharp-ls for C#";
package = pkgs.csharp-ls; package = pkgs.csharp-ls;
serverName = "csharp_ls"; serverName = "csharp_ls";
} }
{ {
name = "cssls"; name = "cssls";
description = "Enable cssls, for CSS"; description = "cssls for CSS";
package = pkgs.vscode-langservers-extracted; package = pkgs.vscode-langservers-extracted;
cmd = cfg: ["${cfg.package}/bin/vscode-css-language-server" "--stdio"]; cmd = cfg: ["${cfg.package}/bin/vscode-css-language-server" "--stdio"];
} }
{ {
name = "dagger"; name = "dagger";
description = "Enable dagger, for Cuelang"; description = "dagger for Cuelang";
package = pkgs.cuelsp; package = pkgs.cuelsp;
} }
{ {
name = "dartls"; name = "dartls";
description = "Enable dart language-server, for dart"; description = "dart language-server";
package = pkgs.dart; package = pkgs.dart;
settingsOptions = { settingsOptions = {
analysisExcludedFolders = mkOption { analysisExcludedFolders = mkOption {
@ -165,147 +165,145 @@ with lib; let
} }
{ {
name = "denols"; name = "denols";
description = "Enable denols, for Deno"; description = "denols for Deno";
package = pkgs.deno; package = pkgs.deno;
} }
{ {
name = "dhall-lsp-server"; name = "dhall-lsp-server";
description = "Enable dhall-lsp-server, for Dhall"; description = "dhall-lsp-server for Dhall";
serverName = "dhall_lsp_server"; serverName = "dhall_lsp_server";
} }
{ {
name = "digestif"; name = "digestif";
description = "Enable digestif, for LaTeX"; description = "digestif for LaTeX";
# luaPackages.digestif is currently broken, using lua54Packages instead # luaPackages.digestif is currently broken, using lua54Packages instead
package = pkgs.lua54Packages.digestif; package = pkgs.lua54Packages.digestif;
} }
{ {
name = "dockerls"; name = "dockerls";
description = "Enable dockerls, for Dockerfile"; description = "dockerls for Dockerfile";
package = pkgs.dockerfile-language-server-nodejs; package = pkgs.dockerfile-language-server-nodejs;
cmd = cfg: ["${cfg.package}/bin/docker-langserver" "--stdio"]; cmd = cfg: ["${cfg.package}/bin/docker-langserver" "--stdio"];
} }
{ {
name = "efm"; name = "efm";
description = "Enable efm-langserver, for misc tools"; description = "efm-langserver for misc tools";
package = pkgs.efm-langserver; package = pkgs.efm-langserver;
} }
{ {
name = "elmls"; name = "elmls";
description = "Enable elmls, for Elm."; description = "elmls for Elm";
package = pkgs.elmPackages.elm-language-server; package = pkgs.elmPackages.elm-language-server;
} }
{ {
name = "emmet_ls"; name = "emmet_ls";
description = "Enable emmet_ls, emmet support based on LSP"; description = "emmet_ls, emmet support based on LSP";
package = pkgs.emmet-ls; package = pkgs.emmet-ls;
} }
{ {
name = "eslint"; name = "eslint";
description = "Enable eslint";
package = pkgs.vscode-langservers-extracted; package = pkgs.vscode-langservers-extracted;
cmd = cfg: ["${cfg.package}/bin/vscode-eslint-language-server" "--stdio"]; cmd = cfg: ["${cfg.package}/bin/vscode-eslint-language-server" "--stdio"];
} }
{ {
name = "elixirls"; name = "elixirls";
description = "Enable elixirls";
package = pkgs.elixir_ls; package = pkgs.elixir_ls;
cmd = cfg: ["${cfg.package}/bin/elixir-ls"]; cmd = cfg: ["${cfg.package}/bin/elixir-ls"];
} }
{ {
name = "fsautocomplete"; name = "fsautocomplete";
description = "Enable fsautocomplete, for F#"; description = "fsautocomplete for F#";
package = pkgs.fsautocomplete; package = pkgs.fsautocomplete;
} }
{ {
name = "futhark-lsp"; name = "futhark-lsp";
description = "Enable Futhark lsp, for Futhark"; description = "futhark-lsp for Futhark";
package = pkgs.futhark; package = pkgs.futhark;
serverName = "futhark_lsp"; serverName = "futhark_lsp";
} }
{ {
name = "gdscript"; name = "gdscript";
description = "Enable gdscript, for Godot"; description = "gdscript for Godot";
package = null; package = null;
} }
{ {
name = "gleam"; name = "gleam";
description = "Enable gleam, for gleam."; description = "gleam for gleam";
} }
{ {
name = "gopls"; name = "gopls";
description = "Enable gopls, for Go."; description = "gopls for Go";
} }
{ {
name = "graphql"; name = "graphql";
description = "Enable graphql, for GraphQL."; description = "graphql for GraphQL";
package = pkgs.nodePackages.graphql-language-service-cli; package = pkgs.nodePackages.graphql-language-service-cli;
} }
{ {
name = "hls"; name = "hls";
description = "Enable haskell language server"; description = "haskell language server";
package = pkgs.haskell-language-server; package = pkgs.haskell-language-server;
cmd = cfg: ["haskell-language-server-wrapper" "--lsp"]; cmd = cfg: ["haskell-language-server-wrapper" "--lsp"];
} }
{ {
name = "html"; name = "html";
description = "Enable html, for HTML"; description = "HTML language server from `vscode-langservers-extracted`";
package = pkgs.vscode-langservers-extracted; package = pkgs.vscode-langservers-extracted;
cmd = cfg: ["${cfg.package}/bin/vscode-html-language-server" "--stdio"]; cmd = cfg: ["${cfg.package}/bin/vscode-html-language-server" "--stdio"];
} }
{ {
name = "htmx"; name = "htmx";
description = "Enable htmx, for HTMX"; description = "htmx for HTMX";
package = pkgs.htmx-lsp; package = pkgs.htmx-lsp;
} }
{ {
name = "intelephense"; name = "intelephense";
description = "Enable intelephense, for PHP"; description = "intelephense for PHP";
package = pkgs.nodePackages.intelephense; package = pkgs.nodePackages.intelephense;
} }
{ {
name = "java-language-server"; name = "java-language-server";
description = "Enable java language server"; description = "Java language server";
serverName = "java_language_server"; serverName = "java_language_server";
cmd = cfg: ["${cfg.package}/bin/java-language-server"]; cmd = cfg: ["${cfg.package}/bin/java-language-server"];
} }
{ {
name = "jsonls"; name = "jsonls";
description = "Enable jsonls, for JSON"; description = "jsonls for JSON";
package = pkgs.vscode-langservers-extracted; package = pkgs.vscode-langservers-extracted;
cmd = cfg: ["${cfg.package}/bin/vscode-json-language-server" "--stdio"]; cmd = cfg: ["${cfg.package}/bin/vscode-json-language-server" "--stdio"];
} }
{ {
name = "julials"; name = "julials";
description = "Enable julials, for Julia"; description = "julials for Julia";
# The julia language server has to be installed from julia and thus is not packaged "as is" in # The julia language server has to be installed from julia and thus is not packaged "as is" in
# nixpkgs. # nixpkgs.
package = null; package = null;
} }
{ {
name = "kotlin-language-server"; name = "kotlin-language-server";
description = "Enable kotlin language server"; description = "Kotlin language server";
serverName = "kotlin_language_server"; serverName = "kotlin_language_server";
} }
{ {
name = "leanls"; name = "leanls";
description = "Enable leanls, for Lean"; description = "leanls for Lean";
package = pkgs.lean4; package = pkgs.lean4;
} }
{ {
name = "lemminx"; name = "lemminx";
description = "Enable lemminx, for XML"; description = "lemminx for XML";
} }
{ {
name = "ltex"; name = "ltex";
description = "Enable ltex-ls, for LanguageTool"; description = "ltex-ls for LanguageTool";
package = pkgs.ltex-ls; package = pkgs.ltex-ls;
settingsOptions = import ./ltex-settings.nix {inherit lib;}; settingsOptions = import ./ltex-settings.nix {inherit lib;};
settings = cfg: {ltex = cfg;}; settings = cfg: {ltex = cfg;};
} }
{ {
name = "lua-ls"; name = "lua-ls";
description = "Enable lua LS, for lua"; description = "lua-ls for Lua";
# Use the old name of the lua LS if the user is on a stable branch of nixpkgs # Use the old name of the lua LS if the user is on a stable branch of nixpkgs
# Rename occurred here: https://github.com/NixOS/nixpkgs/pull/215057 # Rename occurred here: https://github.com/NixOS/nixpkgs/pull/215057
package = package =
@ -373,16 +371,16 @@ with lib; let
} }
{ {
name = "marksman"; name = "marksman";
description = "Enable marksman, for Markdown"; description = "marksman for Markdown";
package = pkgs.marksman; package = pkgs.marksman;
} }
{ {
name = "metals"; name = "metals";
description = "Enable metals, for Scala"; description = "metals for Scala";
} }
{ {
name = "nil_ls"; name = "nil_ls";
description = "Enable nil, for Nix"; description = "nil for Nix";
package = pkgs.nil; package = pkgs.nil;
settingsOptions = { settingsOptions = {
formatting.command = mkOption { formatting.command = mkOption {
@ -418,23 +416,23 @@ with lib; let
} }
{ {
name = "nixd"; name = "nixd";
description = "Enable nixd, for Nix"; description = "nixd for Nix";
package = pkgs.nixd; package = pkgs.nixd;
settings = cfg: {nixd = cfg;}; settings = cfg: {nixd = cfg;};
} }
{ {
name = "nushell"; name = "nushell";
description = "Enable nushell language server"; description = "Nushell language server";
cmd = cfg: ["${cfg.package}/bin/nu" "--lsp"]; cmd = cfg: ["${cfg.package}/bin/nu" "--lsp"];
} }
{ {
name = "ols"; name = "ols";
description = "Enable ols, for the odin programming language"; description = "ols for the Odin programming language";
package = pkgs.ols; package = pkgs.ols;
} }
{ {
name = "omnisharp"; name = "omnisharp";
description = "Enable omnisharp language server, for C#"; description = "OmniSharp language server for C#";
package = pkgs.omnisharp-roslyn; package = pkgs.omnisharp-roslyn;
cmd = cfg: ["${cfg.package}/bin/OmniSharp"]; cmd = cfg: ["${cfg.package}/bin/OmniSharp"];
settings = cfg: {omnisharp = cfg;}; settings = cfg: {omnisharp = cfg;};
@ -488,58 +486,58 @@ with lib; let
} }
{ {
name = "perlpls"; name = "perlpls";
description = "Enable PLS, for Perl"; description = "PLS for Perl";
package = pkgs.perlPackages.PLS; package = pkgs.perlPackages.PLS;
} }
{ {
name = "pest_ls"; name = "pest_ls";
description = "Enable pest_ls, for pest"; description = "pest_ls for pest";
package = pkgs.pest-ide-tools; package = pkgs.pest-ide-tools;
} }
{ {
name = "phpactor"; name = "phpactor";
description = "Enable phpactor, for PHP"; description = "phpactor for PHP";
package = pkgs.phpactor; package = pkgs.phpactor;
} }
{ {
name = "prismals"; name = "prismals";
description = "Enable prismals, for Prisma"; description = "prismals for Prisma";
package = pkgs.nodePackages."@prisma/language-server"; package = pkgs.nodePackages."@prisma/language-server";
} }
{ {
name = "prolog-ls"; name = "prolog-ls";
description = "enable prolog_ls, for SWI-Prolog"; description = "prolog_ls for SWI-Prolog";
serverName = "prolog_ls"; serverName = "prolog_ls";
package = pkgs.swiProlog; package = pkgs.swiProlog;
} }
{ {
name = "pylsp"; name = "pylsp";
description = "Enable pylsp, for Python."; description = "pylsp for Python";
package = pkgs.python3Packages.python-lsp-server; package = pkgs.python3Packages.python-lsp-server;
settings = cfg: {pylsp = cfg;}; settings = cfg: {pylsp = cfg;};
} }
{ {
name = "pylyzer"; name = "pylyzer";
description = "Enable pylyzer, for Python."; description = "pylyzer for Python";
} }
{ {
name = "pyright"; name = "pyright";
description = "Enable pyright, for Python."; description = "pyright for Python";
} }
{ {
name = "rnix-lsp"; name = "rnix-lsp";
description = "Enable rnix LSP, for Nix"; description = "rnix LSP for Nix";
serverName = "rnix"; serverName = "rnix";
} }
{ {
name = "ruff-lsp"; name = "ruff-lsp";
description = "Enable ruff-lsp, for Python."; description = "ruff-lsp, for Python";
package = pkgs.python3Packages.ruff-lsp; package = pkgs.python3Packages.ruff-lsp;
serverName = "ruff_lsp"; serverName = "ruff_lsp";
} }
{ {
name = "rust-analyzer"; name = "rust-analyzer";
description = "Enable rust-analyzer, for Rust."; description = "rust-analyzer for Rust";
serverName = "rust_analyzer"; serverName = "rust_analyzer";
settingsOptions = import ./rust-analyzer-config.nix lib pkgs; settingsOptions = import ./rust-analyzer-config.nix lib pkgs;
@ -547,78 +545,78 @@ with lib; let
} }
{ {
name = "solargraph"; name = "solargraph";
description = "Enable solargraph, for Ruby"; description = "solargraph for Ruby";
package = pkgs.rubyPackages.solargraph; package = pkgs.rubyPackages.solargraph;
} }
{ {
name = "sourcekit"; name = "sourcekit";
description = "Enable the sourcekit language server, for Swift and C/C++/Objective-C"; description = "sourcekit language server for Swift and C/C++/Objective-C";
package = pkgs.sourcekit-lsp; package = pkgs.sourcekit-lsp;
} }
{ {
name = "svelte"; name = "svelte";
description = "Enable the svelte language server, for Svelte"; description = "svelte language server for Svelte";
package = pkgs.nodePackages.svelte-language-server; package = pkgs.nodePackages.svelte-language-server;
} }
{ {
name = "tailwindcss"; name = "tailwindcss";
description = "Enable tailwindcss language server, for tailwindcss"; description = "tailwindcss language server for tailwindcss";
package = pkgs.nodePackages."@tailwindcss/language-server"; package = pkgs.nodePackages."@tailwindcss/language-server";
} }
{ {
name = "taplo"; name = "taplo";
description = "Enable taplo, for TOML"; description = "taplo for TOML";
package = pkgs.taplo; package = pkgs.taplo;
} }
{ {
name = "templ"; name = "templ";
description = "Enable the templ language server for the templ HTML templating language"; description = "templ language server for the templ HTML templating language";
} }
{ {
name = "terraformls"; name = "terraformls";
description = "Enable terraform-ls, for terraform"; description = "terraform-ls for terraform";
package = pkgs.terraform-ls; package = pkgs.terraform-ls;
} }
{ {
name = "texlab"; name = "texlab";
description = "Enable texlab language server, for LaTeX"; description = "texlab language server for LaTeX";
} }
{ {
name = "tsserver"; name = "tsserver";
description = "Enable tsserver for typescript"; description = "tsserver for TypeScript";
package = pkgs.nodePackages.typescript-language-server; package = pkgs.nodePackages.typescript-language-server;
} }
{ {
name = "typst-lsp"; name = "typst-lsp";
serverName = "typst_lsp"; serverName = "typst_lsp";
description = "Enable typst-lsp for typst"; description = "typst-lsp for typst";
package = pkgs.typst-lsp; package = pkgs.typst-lsp;
} }
{ {
name = "vls"; name = "vls";
description = "Enable vls for v"; description = "vls for V";
# The v language server has to be installed from v and thus is not packaged "as is" in # The v language server has to be installed from v and thus is not packaged "as is" in
# nixpkgs. # nixpkgs.
package = null; package = null;
} }
{ {
name = "vuels"; name = "vuels";
description = "Enable vuels, for Vue"; description = "vuels for Vue";
package = pkgs.nodePackages.vls; package = pkgs.nodePackages.vls;
} }
{ {
name = "volar"; name = "volar";
description = "Enable @volar/vue-language-server, for Vue"; description = "@volar/vue-language-server for Vue";
package = pkgs.nodePackages."@volar/vue-language-server"; package = pkgs.nodePackages."@volar/vue-language-server";
} }
{ {
name = "yamlls"; name = "yamlls";
description = "Enable yamlls, for yaml"; description = "yamlls for YAML";
package = pkgs.yaml-language-server; package = pkgs.yaml-language-server;
} }
{ {
name = "zls"; name = "zls";
description = "Enable zls, for Zig."; description = "zls for Zig";
} }
]; ];
in { in {

View file

@ -14,7 +14,6 @@ in
with helpers.vim-plugin; with helpers.vim-plugin;
mkVimPlugin attrs { mkVimPlugin attrs {
name = "emmet"; name = "emmet";
description = "Enable emmet";
package = pkgs.vimPlugins.emmet-vim; package = pkgs.vimPlugins.emmet-vim;
globalPrefix = "user_emmet_"; globalPrefix = "user_emmet_";

View file

@ -9,7 +9,7 @@ in
with lib; with lib;
mkVimPlugin attrs { mkVimPlugin attrs {
name = "endwise"; name = "endwise";
description = "Enable vim-endwise"; description = "vim-endwise";
package = pkgs.vimPlugins.vim-endwise; package = pkgs.vimPlugins.vim-endwise;
# Yes it's really not configurable # Yes it's really not configurable

View file

@ -9,7 +9,7 @@ in
with lib; with lib;
mkVimPlugin attrs { mkVimPlugin attrs {
name = "goyo"; name = "goyo";
description = "Enable goyo.vim"; description = "goyo.vim";
package = pkgs.vimPlugins.goyo-vim; package = pkgs.vimPlugins.goyo-vim;
globalPrefix = "goyo_"; globalPrefix = "goyo_";

View file

@ -9,7 +9,6 @@ in
with helpers.vim-plugin; with helpers.vim-plugin;
mkVimPlugin args { mkVimPlugin args {
name = "startify"; name = "startify";
description = "Enable startify";
package = pkgs.vimPlugins.vim-startify; package = pkgs.vimPlugins.vim-startify;
globalPrefix = "startify_"; globalPrefix = "startify_";

View file

@ -9,7 +9,7 @@ in
with lib; with lib;
mkVimPlugin attrs { mkVimPlugin attrs {
name = "surround"; name = "surround";
description = "Enable surround.vim"; description = "surround.vim";
package = pkgs.vimPlugins.surround; package = pkgs.vimPlugins.surround;
options = {}; options = {};