aboutsummaryrefslogtreecommitdiffstats
path: root/lsp/terraformls.lua
blob: 64fb46acf1207934d8c6984e369351019686a26a (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
---@brief
---
-- https://github.com/hashicorp/terraform-ls
--
-- Terraform language server
-- Download a released binary from https://github.com/hashicorp/terraform-ls/releases.
--
-- From https://github.com/hashicorp/terraform-ls#terraform-ls-vs-terraform-lsp:
--
-- Both HashiCorp and the maintainer of terraform-lsp expressed interest in
-- collaborating on a language server and are working towards a _long-term_
-- goal of a single stable and feature-complete implementation.
--
-- For the time being both projects continue to exist, giving users the
-- choice:
--
-- - `terraform-ls` providing
--   - overall stability (by relying only on public APIs)
--   - compatibility with any provider and any Terraform >=0.12.0 currently
--     less features
--   - due to project being younger and relying on public APIs which may
--     not offer the same functionality yet
--
-- - `terraform-lsp` providing
--   - currently more features
--   - compatibility with a single particular Terraform (0.12.20 at time of writing)
--     - configs designed for other 0.12 versions may work, but interpretation may be inaccurate
--   - less stability (due to reliance on Terraform's own internal packages)
--
-- Note, that the `settings` configuration option uses the `workspace/didChangeConfiguration` event,
-- [which is not supported by terraform-ls](https://github.com/hashicorp/terraform-ls/blob/main/docs/features.md).
-- Instead you should use `init_options` which passes the settings as part of the LSP initialize call
-- [as is required by terraform-ls](https://github.com/hashicorp/terraform-ls/blob/main/docs/SETTINGS.md#how-to-pass-settings).
return {
  cmd = { 'terraform-ls', 'serve' },
  filetypes = { 'terraform', 'terraform-vars' },
  root_markers = { '.terraform', '.git' },
}