terraform/hcl: improve options, fix terraform-cli error, add tofu-ls

[ppenguin]

• 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)

Sanity Checking

• I have updated the changelog as per my changes
• I have tested, and self-reviewed my code
• My changes fit guidelines found in hacking nvf
• Style and consistency
  • I ran Alejandra to format my code (nix fmt)
  • My code conforms to the editorconfig configuration of the project
  • My changes are consistent with the rest of the codebase
• If new changes are particularly complex:
  • My code includes comments in particularly complex areas
  • I have added a section in the manual
  • (For breaking changes) I have included a migration guide
• Package(s) built:
  • .#nix (default package)
  • .#maximal
  • .#docs-html (manual, must build)
  • .#docs-linkcheck (optional, please build if adding links)
• Tested on platform(s)
  • x86_64-linux
  • aarch64-linux
  • x86_64-darwin
  • aarch64-darwin

---

Add a 👍 reaction to pull requests you find important.

[github-actions]

🚀 Live preview deployed from c07410f

View it here:

Debug Information

Triggered by: ppenguin

HEAD at: improve-terraformls

Reruns: 2196

[sjcobb2022]

Looks good overall other than a few comments.

In addition, if a user enables both HCL and terraform modules, the lsp configs may overwrite each other.

I know you have tried to combat this by using mkDefault, but I think a more reasonable solution may be to "tag" the LSPs with something like: terraformls-hcl, or opentofu-tf, this way we can have the configs fully separate.

Alternatively, if the configs are identical other than the filetypes, then there is no need to use mkDefault as nix should merge the two arrays anyway.

[sjcobb2022]

Would definitely want @NotAShelf and @horriblename to take a look at this impl

[ppenguin]

@NotAShelf BTW, there seems to be a regression on main (introduced sometime since 7 days ago), that breaks nix build .#docs-html:

error: Cannot build '/nix/store/ar4ndivdlidqp8glnbvag5fq2hvxsjdz-nvf-docs-html.drv'.
       Reason: builder failed with exit code 1.
       Output paths:
         /nix/store/3ixr2az6w2dqxzz745qn1zsxjz86gmmg-nvf-docs-html
...
       > Error:
       >    0: Configuration error: No config file provided. Use --config-file to specify a config file.
       >
       > Location:
       >    ndg/src/main.rs:106

This affected this issue as well since I did a rebase.

[NotAShelf]

Ah damn I forgot to test the config module before NDG's 2.6.0 refactor. I'll try to take a look today after work or tomorrow during the day.