Terraform LSP#
Server#
For more information about the LSP server, check terraform-ls.
Installation#
For more instructions on how to install manually, check here.
Debugger: Not available#
author: psibi template: comment.html root_file: docs/manual-language-docs/lsp-terraform-ls.md
Server note#
This page documents the official language server for Terraform by Hashicorp.
Note that currently lsp-mode supports two terraform language servers. This FAQ entry shows how to choose a specific one. If you would want to go with the official Hashicorp's language server, set this:
(setq lsp-disabled-clients '(tfls))
terraform-ls#
Commands#
lsp-terraform-ls-validate#
Runs terraform validate on project root. All the violations are published back in the buffer.
lsp-terraform-ls-init#
Runs terraform init using terraform available from $PATH. You have
to make sure that that proper credentials are there.
Note that this is a synchronous action and will timeout after a certain amount of time.
lsp-terraform-ls-version#
This feature is only available on terraform-ls version >= 0.29.0.
Provides information about the terraform binary version for the current workspace. This is how it will look like in the minibuffer:
Required: 1.1.9, Current: 1.0.5
Note that if you have changed the version in your $PATH meanwhile,
you would have to restart the lsp session using
lsp-workspace-restart for it to pick up the newer version.
Code Lens#
This is an experimental feature which can be enabled via the option
lsp-terraform-ls-enable-show-reference:
(setq lsp-terraform-ls-enable-show-reference t)
This gif demonstrates how this feature is used:
Semantic token support#
Make sure to enable these two variables to ensure that you have semantic token support for terraform mode:
(setq lsp-semantic-tokens-enable t)
(setq lsp-semantic-tokens-honor-refresh-requests t)
This is how the code looks without semantic tokens support:
And with semantic token support you get more contextual information via different faces:
Link to Documentation#
Link to documentation from module sources for registry modules is available. Make sure you have this enabled:
(setq lsp-enable-links t)
Note that the default value of lsp-enable-links is t. So enabling
it isn't strictly required, but you would require this feature for it
to properly work.
This gif demonstrates on how to use it:
There are two ways to open the link:
- Key binding: Alt + Enter
- Clicking the middle button of your mouse
Prefill required fields#
This is an experimental feature which can be enabled via the option
lsp-terraform-ls-prefill-required-fields:
(setq lsp-terraform-ls-prefill-required-fields t)
This gif demonstrates how this feature is used:
Treeview controls#
For this feature to work, make sure that you have lsp-treemacs installed.
Providers widget#
This widget can be invoked by lsp-terraform-ls-providers.
Module calls widget#
This widget can be invoked by lsp-terraform-ls-module-calls.
If the modules data is empty, you might need to do terraform init
for the project.
The widget has a minor mode named
lsp-terraform-modules-mode. Following keybinding are available
within the mode:
g: Refresh modules view
Available configurations#
lsp-terraform-ls-enable-show-reference#
Type: boolean
Default: nil
Enable reference counts.
Display reference counts above top level blocks and attributes. This is an experimental feature provided by the language server.
lsp-terraform-ls-module-calls-position-params#
Type: list
Default: nil
The optional module calls tree position params. Defaults to side following treemacs default.
lsp-terraform-ls-prefill-required-fields#
Type: boolean
Default: nil
Enable completion of required fields.
Enable autocompletion for required fields when completing Terraform blocks. This is an experimental feature provided by the language server.
lsp-terraform-ls-providers-position-params#
Type: list
Default: nil
The optional providers tree position params. Defaults to side following treemacs default.
lsp-terraform-ls-server#
Type: (choice (file :tag File) (repeat string))
Default: terraform-ls
Path to the terraform-ls binary.
lsp-terraform-ls-validate-on-save#
Type: boolean
Default: nil
Enable validating the current open file on save.
This is an experimental feature provided by the language server.