From 6db298cb3f4628c7df5a75e9e6e39080b33bd6d1 Mon Sep 17 00:00:00 2001 From: ppenguin Date: Wed, 24 Dec 2025 11:32:04 +0100 Subject: [PATCH 1/6] terraform/hcl: improve options, fix terraform-cli error, add tofu-ls (free) as alternative option - Add tofu(ls) as free terraform alternative for terraform and hcl - Harmonize with other format/LSP implementation (also with conform) - Add/fix terraform formatter - Add `nomad fmt` as alternative hcl formatter Note: for (nomad) hcl tofu/terraform ls are ineffective (don't support e.g. jobspec schema) -> TODO: nomad-lsp (package and add, even though it seems abandoned it's probably better for nomad/hcl) --- modules/plugins/languages/hcl.nix | 48 ++++++++++---- modules/plugins/languages/terraform.nix | 86 ++++++++++++++++++++----- 2 files changed, 105 insertions(+), 29 deletions(-) diff --git a/modules/plugins/languages/hcl.nix b/modules/plugins/languages/hcl.nix index e32719b9..db24b116 100644 --- a/modules/plugins/languages/hcl.nix +++ b/modules/plugins/languages/hcl.nix @@ -4,24 +4,31 @@ lib, ... }: let - inherit (builtins) attrNames; + inherit (builtins) attrNames elem; inherit (lib.options) mkEnableOption mkOption; inherit (lib.meta) getExe; - inherit (lib.modules) mkIf mkMerge; + inherit (lib.modules) mkIf mkMerge mkDefault; inherit (lib.types) bool enum listOf; inherit (lib.nvim.types) mkGrammarOption deprecatedSingleOrListOf; inherit (lib.nvim.attrsets) mapListToAttrs; cfg = config.vim.languages.hcl; - defaultServers = ["terraform-ls"]; + defaultServers = ["tofuls"]; servers = { - terraform-ls = { + terraformls = { enable = true; - cmd = [(getExe pkgs.terraform-ls) "serve"]; - filetypes = ["terraform" "terraform-vars"]; + cmd = mkDefault [(getExe pkgs.terraform-ls) "serve"]; # NOTE: mkDefault to avoid clashes with terraform defs + filetypes = ["hcl"]; + root_markers = [".git"]; + }; + tofuls = { + enable = true; + cmd = mkDefault [(getExe pkgs.tofu-ls) "serve"]; # NOTE: mkDefault to avoid clashes with terraform defs + filetypes = ["hcl"]; root_markers = [".terraform" ".git"]; }; + # TODO: package nomad-lsp and offer as an option here too }; defaultFormat = ["hclfmt"]; @@ -29,18 +36,25 @@ hclfmt = { command = getExe pkgs.hclfmt; }; + nomad-fmt = { + command = getExe pkgs.nomad; + args = ["fmt" "$FILENAME"]; + stdin = false; + }; }; in { options.vim.languages.hcl = { enable = mkEnableOption "HCL support"; treesitter = { - enable = mkEnableOption "HCL treesitter" // {default = config.vim.languages.enableTreesitter;}; + enable = + mkEnableOption "HCL treesitter" // {default = config.vim.languages.enableTreesitter;}; package = mkGrammarOption pkgs "hcl"; }; lsp = { - enable = mkEnableOption "HCL LSP support" // {default = config.vim.lsp.enable;}; + enable = + mkEnableOption "HCL LSP support" // {default = config.vim.lsp.enable;}; servers = mkOption { type = listOf (enum (attrNames servers)); default = defaultServers; @@ -81,18 +95,24 @@ in { .set('hcl', '#%s') ''; } + (mkIf cfg.treesitter.enable { vim.treesitter.enable = true; vim.treesitter.grammars = [cfg.treesitter.package]; }) (mkIf cfg.lsp.enable { - vim.lsp.servers = - mapListToAttrs (n: { - name = n; - value = servers.${n}; - }) - cfg.lsp.servers; + vim = { + lsp.servers = + mapListToAttrs (n: { + name = n; + value = servers.${n}; + }) + cfg.lsp.servers; + extraPackages = + (lib.optionals (elem "terraformls" cfg.lsp.servers) [pkgs.terraform]) + ++ (lib.optionals (elem "tofuls" cfg.lsp.servers) [pkgs.opentofu]); + }; }) (mkIf cfg.format.enable { diff --git a/modules/plugins/languages/terraform.nix b/modules/plugins/languages/terraform.nix index 5f3952df..28cc2617 100644 --- a/modules/plugins/languages/terraform.nix +++ b/modules/plugins/languages/terraform.nix @@ -4,44 +4,80 @@ lib, ... }: let - inherit (builtins) attrNames; + inherit (builtins) attrNames concatStringsSep elem; inherit (lib.options) mkEnableOption mkOption; inherit (lib.modules) mkIf mkMerge; inherit (lib.meta) getExe; - inherit (lib.types) enum listOf; - inherit (lib.nvim.types) mkGrammarOption; + inherit (lib.types) bool enum listOf; + inherit (lib.nvim.types) mkGrammarOption deprecatedSingleOrListOf; inherit (lib.nvim.attrsets) mapListToAttrs; cfg = config.vim.languages.terraform; - defaultServers = ["terraformls"]; + defaultServers = ["tofuls"]; servers = { terraformls = { enable = true; cmd = [(getExe pkgs.terraform-ls) "serve"]; - filetypes = ["terraform" "terraform-vars"]; + filetypes = ["terraform" "terraform-vars" "tf"]; root_markers = [".terraform" ".git"]; }; + tofuls = { + enable = true; + cmd = [(getExe pkgs.tofu-ls) "serve"]; + filetypes = ["terraform" "terraform-vars" "tf"]; + root_markers = [".terraform" ".git"]; + }; + }; + + defaultFormat = ["tofu-fmt"]; + formats = { + tofu-fmt = { + command = "${getExe pkgs.opentofu}"; + args = ["fmt" "$FILENAME"]; + stdin = false; + }; + terraform-fmt = { + command = "${getExe pkgs.terraform}"; + args = ["fmt" "$FILENAME"]; + stdin = false; + }; }; in { options.vim.languages.terraform = { - enable = mkEnableOption "Terraform/HCL support"; + enable = mkEnableOption "Terraform support"; treesitter = { - enable = mkEnableOption "Terraform treesitter" // {default = config.vim.languages.enableTreesitter;}; + enable = + mkEnableOption "Terraform treesitter" // {default = config.vim.languages.enableTreesitter;}; package = mkGrammarOption pkgs "terraform"; }; lsp = { - enable = mkEnableOption "Terraform LSP support (terraform-ls)" // {default = config.vim.lsp.enable;}; + enable = + mkEnableOption "Terraform LSP support (terraform-ls)" // {default = config.vim.lsp.enable;}; servers = mkOption { type = listOf (enum (attrNames servers)); default = defaultServers; - description = "Terraform LSP server to use"; + description = "Terraform LSP server to use (one or more of [${concatStringsSep " " (attrNames servers)}])"; + }; + }; + + format = { + enable = mkOption { + type = bool; + default = config.vim.languages.enableFormat; + description = "Enable Terraform formatting"; + }; + type = mkOption { + type = deprecatedSingleOrListOf "vim.language.terraform.format.type" (enum (attrNames formats)); + default = defaultFormat; + description = "Terraform formatter to use"; }; }; }; + config = mkIf cfg.enable (mkMerge [ (mkIf cfg.treesitter.enable { vim.treesitter.enable = true; @@ -49,12 +85,32 @@ in { }) (mkIf cfg.lsp.enable { - vim.lsp.servers = - mapListToAttrs (n: { - name = n; - value = servers.${n}; - }) - cfg.lsp.servers; + vim = { + lsp.servers = + mapListToAttrs (n: { + name = n; + value = servers.${n}; + }) + cfg.lsp.servers; + extraPackages = + (lib.optionals (elem "terraformls" cfg.lsp.servers) [pkgs.terraform]) + ++ (lib.optionals (elem "tofuls" cfg.lsp.servers) [pkgs.opentofu]); + }; + }) + + (mkIf cfg.format.enable { + vim.formatter.conform-nvim = { + enable = true; + setupOpts = { + formatters_by_ft.terraform = cfg.format.type; + formatters = + mapListToAttrs (name: { + inherit name; + value = formats.${name}; + }) + cfg.format.type; + }; + }; }) ]); } From d28ebedc52284c27ec71df674559dd04ef23226e Mon Sep 17 00:00:00 2001 From: ppenguin Date: Wed, 7 Jan 2026 18:41:35 +0100 Subject: [PATCH 2/6] update release notes --- docs/manual/release-notes/rl-0.9.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/manual/release-notes/rl-0.9.md b/docs/manual/release-notes/rl-0.9.md index 612e473d..2f282326 100644 --- a/docs/manual/release-notes/rl-0.9.md +++ b/docs/manual/release-notes/rl-0.9.md @@ -36,3 +36,11 @@ [Libadoxon](https://github.com/Libadoxon): - `toggleterm` open map now also works when in terminal mode + +[ppenguin](https://github.com/Libadoxon): + +- Improved/harmonized for `terraform` and `hcl`: + - formatting (use `terraform fmt` or `tofu fmt` for `tf` files) + - LSP config + - Added `tofu` and `tofu-ls` as (free) alternative to `terrraform` and + `terraform-ls` From 6a8325639fe2f63cae1cda76506495d951dac65b Mon Sep 17 00:00:00 2001 From: ppenguin Date: Fri, 9 Jan 2026 10:05:53 +0100 Subject: [PATCH 3/6] changes from review --- modules/plugins/languages/hcl.nix | 19 +++++++------------ modules/plugins/languages/terraform.nix | 16 +++++----------- 2 files changed, 12 insertions(+), 23 deletions(-) diff --git a/modules/plugins/languages/hcl.nix b/modules/plugins/languages/hcl.nix index db24b116..529cc44e 100644 --- a/modules/plugins/languages/hcl.nix +++ b/modules/plugins/languages/hcl.nix @@ -14,17 +14,17 @@ cfg = config.vim.languages.hcl; - defaultServers = ["tofuls"]; + defaultServers = ["tofuls-hcl"]; servers = { - terraformls = { + terraformls-hcl = { enable = true; - cmd = mkDefault [(getExe pkgs.terraform-ls) "serve"]; # NOTE: mkDefault to avoid clashes with terraform defs + cmd = [(getExe pkgs.terraform-ls) "serve"]; # NOTE: mkDefault to avoid clashes with terraform defs filetypes = ["hcl"]; root_markers = [".git"]; }; - tofuls = { + tofuls-hcl = { enable = true; - cmd = mkDefault [(getExe pkgs.tofu-ls) "serve"]; # NOTE: mkDefault to avoid clashes with terraform defs + cmd = [(getExe pkgs.tofu-ls) "serve"]; # NOTE: mkDefault to avoid clashes with terraform defs filetypes = ["hcl"]; root_markers = [".terraform" ".git"]; }; @@ -47,14 +47,12 @@ in { enable = mkEnableOption "HCL support"; treesitter = { - enable = - mkEnableOption "HCL treesitter" // {default = config.vim.languages.enableTreesitter;}; + enable = mkEnableOption "HCL treesitter" // {default = config.vim.languages.enableTreesitter;}; package = mkGrammarOption pkgs "hcl"; }; lsp = { - enable = - mkEnableOption "HCL LSP support" // {default = config.vim.lsp.enable;}; + enable = mkEnableOption "HCL LSP support" // {default = config.vim.lsp.enable;}; servers = mkOption { type = listOf (enum (attrNames servers)); default = defaultServers; @@ -109,9 +107,6 @@ in { value = servers.${n}; }) cfg.lsp.servers; - extraPackages = - (lib.optionals (elem "terraformls" cfg.lsp.servers) [pkgs.terraform]) - ++ (lib.optionals (elem "tofuls" cfg.lsp.servers) [pkgs.opentofu]); }; }) diff --git a/modules/plugins/languages/terraform.nix b/modules/plugins/languages/terraform.nix index 28cc2617..4d91cf12 100644 --- a/modules/plugins/languages/terraform.nix +++ b/modules/plugins/languages/terraform.nix @@ -14,15 +14,15 @@ cfg = config.vim.languages.terraform; - defaultServers = ["tofuls"]; + defaultServers = ["tofuls-tf"]; servers = { - terraformls = { + terraformls-tf = { enable = true; cmd = [(getExe pkgs.terraform-ls) "serve"]; filetypes = ["terraform" "terraform-vars" "tf"]; root_markers = [".terraform" ".git"]; }; - tofuls = { + tofuls-tf = { enable = true; cmd = [(getExe pkgs.tofu-ls) "serve"]; filetypes = ["terraform" "terraform-vars" "tf"]; @@ -48,15 +48,12 @@ in { enable = mkEnableOption "Terraform support"; treesitter = { - enable = - mkEnableOption "Terraform treesitter" // {default = config.vim.languages.enableTreesitter;}; + enable = mkEnableOption "Terraform treesitter" // {default = config.vim.languages.enableTreesitter;}; package = mkGrammarOption pkgs "terraform"; }; lsp = { - enable = - mkEnableOption "Terraform LSP support (terraform-ls)" // {default = config.vim.lsp.enable;}; - + enable = mkEnableOption "Terraform LSP support (terraform-ls)" // {default = config.vim.lsp.enable;}; servers = mkOption { type = listOf (enum (attrNames servers)); default = defaultServers; @@ -92,9 +89,6 @@ in { value = servers.${n}; }) cfg.lsp.servers; - extraPackages = - (lib.optionals (elem "terraformls" cfg.lsp.servers) [pkgs.terraform]) - ++ (lib.optionals (elem "tofuls" cfg.lsp.servers) [pkgs.opentofu]); }; }) From 02369b06b80b79bbfd0f41ab651f2de097987cb3 Mon Sep 17 00:00:00 2001 From: ppenguin Date: Fri, 9 Jan 2026 10:23:20 +0100 Subject: [PATCH 4/6] remove obsolete comments and unused functions --- modules/plugins/languages/hcl.nix | 8 ++++---- modules/plugins/languages/terraform.nix | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/modules/plugins/languages/hcl.nix b/modules/plugins/languages/hcl.nix index 529cc44e..567e1630 100644 --- a/modules/plugins/languages/hcl.nix +++ b/modules/plugins/languages/hcl.nix @@ -4,10 +4,10 @@ lib, ... }: let - inherit (builtins) attrNames elem; + inherit (builtins) attrNames; inherit (lib.options) mkEnableOption mkOption; inherit (lib.meta) getExe; - inherit (lib.modules) mkIf mkMerge mkDefault; + inherit (lib.modules) mkIf mkMerge; inherit (lib.types) bool enum listOf; inherit (lib.nvim.types) mkGrammarOption deprecatedSingleOrListOf; inherit (lib.nvim.attrsets) mapListToAttrs; @@ -18,13 +18,13 @@ servers = { terraformls-hcl = { enable = true; - cmd = [(getExe pkgs.terraform-ls) "serve"]; # NOTE: mkDefault to avoid clashes with terraform defs + cmd = [(getExe pkgs.terraform-ls) "serve"]; filetypes = ["hcl"]; root_markers = [".git"]; }; tofuls-hcl = { enable = true; - cmd = [(getExe pkgs.tofu-ls) "serve"]; # NOTE: mkDefault to avoid clashes with terraform defs + cmd = [(getExe pkgs.tofu-ls) "serve"]; filetypes = ["hcl"]; root_markers = [".terraform" ".git"]; }; diff --git a/modules/plugins/languages/terraform.nix b/modules/plugins/languages/terraform.nix index 4d91cf12..8d3d50a3 100644 --- a/modules/plugins/languages/terraform.nix +++ b/modules/plugins/languages/terraform.nix @@ -4,7 +4,7 @@ lib, ... }: let - inherit (builtins) attrNames concatStringsSep elem; + inherit (builtins) attrNames concatStringsSep; inherit (lib.options) mkEnableOption mkOption; inherit (lib.modules) mkIf mkMerge; inherit (lib.meta) getExe; From c7afc0c766a8270e815b11ec4ab3734ef975aa2f Mon Sep 17 00:00:00 2001 From: ppenguin Date: Fri, 16 Jan 2026 15:57:01 +0100 Subject: [PATCH 5/6] review mods --- modules/plugins/languages/hcl.nix | 8 ++------ modules/plugins/languages/terraform.nix | 12 ++++-------- 2 files changed, 6 insertions(+), 14 deletions(-) diff --git a/modules/plugins/languages/hcl.nix b/modules/plugins/languages/hcl.nix index 567e1630..9e672396 100644 --- a/modules/plugins/languages/hcl.nix +++ b/modules/plugins/languages/hcl.nix @@ -8,7 +8,7 @@ inherit (lib.options) mkEnableOption mkOption; inherit (lib.meta) getExe; inherit (lib.modules) mkIf mkMerge; - inherit (lib.types) bool enum listOf; + inherit (lib.types) enum listOf; inherit (lib.nvim.types) mkGrammarOption deprecatedSingleOrListOf; inherit (lib.nvim.attrsets) mapListToAttrs; @@ -61,11 +61,7 @@ in { }; format = { - enable = mkOption { - type = bool; - default = config.vim.languages.enableFormat; - description = "Enable HCL formatting"; - }; + enable = mkEnableOption "Enable HCL formatting" // {default = config.vim.languages.enableFormat;}; type = mkOption { type = deprecatedSingleOrListOf "vim.language.hcl.format.type" (enum (attrNames formats)); default = defaultFormat; diff --git a/modules/plugins/languages/terraform.nix b/modules/plugins/languages/terraform.nix index 8d3d50a3..0056456a 100644 --- a/modules/plugins/languages/terraform.nix +++ b/modules/plugins/languages/terraform.nix @@ -4,11 +4,11 @@ lib, ... }: let - inherit (builtins) attrNames concatStringsSep; + inherit (builtins) attrNames; inherit (lib.options) mkEnableOption mkOption; inherit (lib.modules) mkIf mkMerge; inherit (lib.meta) getExe; - inherit (lib.types) bool enum listOf; + inherit (lib.types) enum listOf; inherit (lib.nvim.types) mkGrammarOption deprecatedSingleOrListOf; inherit (lib.nvim.attrsets) mapListToAttrs; @@ -57,16 +57,12 @@ in { servers = mkOption { type = listOf (enum (attrNames servers)); default = defaultServers; - description = "Terraform LSP server to use (one or more of [${concatStringsSep " " (attrNames servers)}])"; + description = "Terraform LSP server to use"; }; }; format = { - enable = mkOption { - type = bool; - default = config.vim.languages.enableFormat; - description = "Enable Terraform formatting"; - }; + enable = mkEnableOption "Enable Terraform formatting" // {default = config.vim.languages.enableFormat;}; type = mkOption { type = deprecatedSingleOrListOf "vim.language.terraform.format.type" (enum (attrNames formats)); default = defaultFormat; From fd2827d79044c66e5efc4b0ebfd94aa341b0f473 Mon Sep 17 00:00:00 2001 From: ppenguin Date: Sat, 24 Jan 2026 12:17:15 +0100 Subject: [PATCH 6/6] Add default LSP change for terraform and hcl to breaking changes in rl. --- docs/manual/release-notes/rl-0.9.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/docs/manual/release-notes/rl-0.9.md b/docs/manual/release-notes/rl-0.9.md index 9de10149..e5c8833d 100644 --- a/docs/manual/release-notes/rl-0.9.md +++ b/docs/manual/release-notes/rl-0.9.md @@ -19,11 +19,14 @@ ]; } ``` +- `languages.{terraform,hcl}`: LSP servers now default to `tofu-ls`. While this + is unlikely to cause any noticeable change in behavior or breakage, it's + mentioned just in case. - Some other settings and commands are now deprecated but are still supported. +Some other settings and commands are now deprecated but are still supported. - - The `setupOpts.mappings` options were also removed. Use the built-in Neovim - settings (nvf's {option}`vim.keymaps`) +- The `setupOpts.mappings` options were also removed. Use the built-in Neovim + settings (nvf's {option}`vim.keymaps`) ## Changelog {#sec-release-0-9-changelog} @@ -67,7 +70,7 @@ - `toggleterm` open map now also works when in terminal mode -[ppenguin](https://github.com/Libadoxon): +[ppenguin](https://github.com/ppenguin): - Improved/harmonized for `terraform` and `hcl`: - formatting (use `terraform fmt` or `tofu fmt` for `tf` files)