diff --git a/configuration.nix b/configuration.nix index f09dbfa0..a65c508e 100644 --- a/configuration.nix +++ b/configuration.nix @@ -79,6 +79,7 @@ isMaximal: { toml.enable = isMaximal; xml.enable = isMaximal; tex.enable = isMaximal; + docker.enable = isMaximal; # Language modules that are not as common. openscad.enable = false; diff --git a/docs/manual/release-notes/rl-0.9.md b/docs/manual/release-notes/rl-0.9.md index 77af9825..f3b9a59b 100644 --- a/docs/manual/release-notes/rl-0.9.md +++ b/docs/manual/release-notes/rl-0.9.md @@ -309,13 +309,15 @@ more flexibility in nvf and reuse of LSPs across languages. Dropped `deprecatedSingleOrListOf` in favor of `listOf` for the affected LSP options. +- Added {option}`vim.lsp.presets.docker-language-server.enable` for Docker + support. + - Added {option}`vim.lsp.presets.angular-language-server.enable` for Angular Template support. - Added {option}`vim.lsp.presets.vtsls.enable` for Vue TypeScript support. - Added {option}`vim.lsp.presets.vue-language-server.enable` for Vue Template - support. - Added {option}`vim.lsp.presets.some-sass-language-server.enable`. @@ -333,6 +335,10 @@ - Added [Selenen](https://github.com/kampfkarren/selene) for more diagnostics in `languages.lua`. +- Added `languages.docker` for Docker and Docker-Compose support. Thanks to + [poseidon-rises](https://github.com/poseidon-rises) for creating most of it in + [!1104](https://github.com/NotAShelf/nvf/pull/1104). + - Added [`mdformat`](https://mdformat.rtfd.io/) support to `languages.markdown` with the extensions for [GFM](https://github.github.com/gfm/), [front matter](https://www.markdownlang.com/advanced/frontmatter.html) and diff --git a/modules/plugins/languages/default.nix b/modules/plugins/languages/default.nix index 368287a7..1d51af51 100644 --- a/modules/plugins/languages/default.nix +++ b/modules/plugins/languages/default.nix @@ -66,6 +66,7 @@ in { ./fluent.nix ./openscad.nix ./jq.nix + ./docker.nix # This is now a hard deprecation. (mkRenamedOptionModule ["vim" "languages" "enableLSP"] ["vim" "lsp" "enable"]) diff --git a/modules/plugins/languages/docker.nix b/modules/plugins/languages/docker.nix new file mode 100644 index 00000000..306072e3 --- /dev/null +++ b/modules/plugins/languages/docker.nix @@ -0,0 +1,166 @@ +{ + config, + pkgs, + lib, + ... +}: let + inherit (builtins) attrNames; + inherit (lib) genAttrs; + inherit (lib.meta) getExe; + inherit (lib.options) mkEnableOption mkOption literalExpression; + inherit (lib.modules) mkIf mkMerge; + inherit (lib.types) enum listOf; + inherit (lib.nvim.types) mkGrammarOption diagnostics; + inherit (lib.nvim.attrsets) mapListToAttrs; + inherit (lib.generators) mkLuaInline; + + cfg = config.vim.languages.docker; + + defaultServers = ["docker-language-server"]; + servers = ["docker-language-server"]; + + defaultFormat = ["dockerfmt"]; + formats = { + dockerfmt = { + command = getExe pkgs.dockerfmt; + }; + }; + + defaultDiagnosticsProvider = ["hadolint"]; + diagnosticsProviders = { + hadolint = { + config.cmd = getExe ( + pkgs.writeShellApplication { + name = "hadolint"; + runtimeInputs = [pkgs.hadolint]; + text = "hadolint -"; + } + ); + }; + }; +in { + options.vim.languages.docker = { + enable = mkEnableOption "Docker language support"; + treesitter = { + enable = + mkEnableOption "Docker treesitter support" + // { + default = config.vim.languages.enableTreesitter; + defaultText = literalExpression "config.vim.languages.enableTreesitter"; + }; + package = mkGrammarOption pkgs "dockerfile"; + }; + + lsp = { + enable = + mkEnableOption "Docker LSP support" + // { + default = config.vim.lsp.enable; + defaultText = literalExpression "config.vim.lsp.enable"; + }; + servers = mkOption { + type = listOf (enum servers); + default = defaultServers; + description = "Docker LSP server to use"; + }; + }; + + format = { + enable = + mkEnableOption "Dockerfile formatting" + // { + default = config.vim.languages.enableFormat; + defaultText = literalExpression "config.vim.languages.enableFormat"; + }; + + type = mkOption { + type = listOf (enum (attrNames formats)); + default = defaultFormat; + description = "Dockerfile formatter to use"; + }; + }; + + extraDiagnostics = { + enable = + mkEnableOption "extra Dockerfile diagnostics" + // { + default = config.vim.languages.enableExtraDiagnostics; + }; + + types = diagnostics { + langDesc = "Dockerfile"; + inherit diagnosticsProviders; + inherit defaultDiagnosticsProvider; + }; + }; + }; + + config = mkMerge [ + { + vim.autocmds = [ + # Without this the LSP doesn't understand them correctly + # and there are conflicts with the YAML LSP + { + desc = "Set Docker Compose filetype"; + event = ["BufRead" "BufNewFile"]; + pattern = [ + "compose.yml" + "compose.yaml" + "docker-compose.yml" + "docker-compose.yaml" + ]; + callback = mkLuaInline '' + vim.bo.filetype = "dockercompose" + ''; + } + ]; + } + + (mkIf cfg.treesitter.enable { + vim.treesitter = { + enable = true; + grammars = [cfg.treesitter.package]; + }; + }) + + (mkIf cfg.lsp.enable { + vim.lsp = { + presets = genAttrs cfg.lsp.servers (_: {enable = true;}); + servers = genAttrs cfg.lsp.servers (_: { + filetypes = [ + "dockerfile" + "dockercompose" + ]; + }); + }; + }) + + (mkIf cfg.format.enable { + vim.formatter.conform-nvim = { + enable = true; + setupOpts = { + formatters_by_ft.dockerfile = cfg.format.type; + formatters = + mapListToAttrs (name: { + inherit name; + value = formats.${name}; + }) + cfg.format.type; + }; + }; + }) + + (mkIf cfg.extraDiagnostics.enable { + vim.diagnostics.nvim-lint = { + enable = true; + linters_by_ft.dockerfile = cfg.extraDiagnostics.types; + linters = mkMerge ( + map (name: { + ${name} = diagnosticsProviders.${name}.config; + }) + cfg.extraDiagnostics.types + ); + }; + }) + ]; +} diff --git a/modules/plugins/languages/hcl.nix b/modules/plugins/languages/hcl.nix index 32f4945d..b6209dac 100644 --- a/modules/plugins/languages/hcl.nix +++ b/modules/plugins/languages/hcl.nix @@ -16,7 +16,7 @@ cfg = config.vim.languages.hcl; defaultServers = ["tofu-ls"]; - servers = ["terraform-ls" "tofu-ls"]; + servers = ["terraform-ls" "tofu-ls" "docker-language-server"]; defaultFormat = ["hclfmt"]; formats = { diff --git a/modules/plugins/lsp/presets/default.nix b/modules/plugins/lsp/presets/default.nix index f5f71c35..b7a7e7f5 100644 --- a/modules/plugins/lsp/presets/default.nix +++ b/modules/plugins/lsp/presets/default.nix @@ -13,6 +13,7 @@ ./cue.nix ./dart.nix ./deno.nix + ./docker-language-server.nix ./elixir-ls.nix ./elm-language-server.nix ./emmet-ls.nix diff --git a/modules/plugins/lsp/presets/docker-language-server.nix b/modules/plugins/lsp/presets/docker-language-server.nix new file mode 100644 index 00000000..fdaab427 --- /dev/null +++ b/modules/plugins/lsp/presets/docker-language-server.nix @@ -0,0 +1,33 @@ +{ + config, + lib, + pkgs, + ... +}: let + inherit (lib.meta) getExe; + inherit (lib.modules) mkIf; + inherit (lib.nvim.types) mkLspPresetEnableOption; + + cfg = config.vim.lsp.presets.docker-language-server; +in { + options.vim.lsp.presets.docker-language-server = { + enable = mkLspPresetEnableOption "docker-language-server" "Docker" []; + }; + + config = mkIf cfg.enable { + vim.lsp.servers.docker-language-server = { + enable = true; + cmd = [(getExe pkgs.docker-language-server) "start" "--stdio"]; + root_markers = [ + ".git" + "Dockerfile" + "docker-compose.yaml" + "docker-compose.yml" + "compose.yaml" + "compose.yml" + "docker-bake.json" + "docker-bake.hcl" + ]; + }; + }; +}