Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update usage doc supported filetypes and neovim docs #999

Merged
merged 4 commits into from
Jul 27, 2022
Merged

Update usage doc supported filetypes and neovim docs #999

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fb7f62a
feat: Update usage doc about support filetypes
teddylear Jul 9, 2022
feee0e5
feat: Update neovim configuration with lua only option
teddylear Jul 9, 2022
620f85a
fix: add setting *.tfvars for vim and lua configuration for neovim
teddylear Jul 12, 2022
3476ead
further clarify language IDs situation
radeksimko Jul 27, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 21 additions & 2 deletions docs/USAGE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,16 @@ This guide assumes you have installed the server by following instructions
in the [README.md](../README.md) if that is applicable to your client
(i.e. if the client doesn't download the server itself).

The following filetypes are supported by the Terraform Language Server:

- `terraform` - standard `*.tf` config files
- `terraform-vars` - variable files (`*.tfvars`)

*NOTE* Clients specifically should **not** send `*.tf.json`, `*.tfvars.json` nor
Packer HCL config nor any other HCL config files as the server is not
equipped to handle these file types.


Instructions for popular IDEs are below and pull requests
for updates or addition of more IDEs are welcomed.

Expand Down Expand Up @@ -126,13 +136,22 @@ let g:LanguageClient_serverCommands = {
### Neovim v0.5.0+

- Install the [nvim-lspconfig plugin](https://github.com/neovim/nvim-lspconfig)
- Add the following to your `.vimrc`:
- Add the following to your `.vimrc` or `init.vim`:

```vim
lua <<EOF
require'lspconfig'.terraformls.setup{}
require'lspconfig'.terraformls.setup{}
EOF
autocmd BufWritePre *.tfvars lua vim.lsp.buf.formatting_sync()
autocmd BufWritePre *.tf lua vim.lsp.buf.formatting_sync()
```
- If you are using `init.lua`:
```lua
require'lspconfig'.terraformls.setup{}
vim.api.nvim_create_autocmd({"BufWritePre"}, {
pattern = {"*.tf", "*.tfvars"},
callback = vim.lsp.buf.formatting_sync,
})
```

Make sure to read through to [server_configurations.md#terraformls](https://github.com/neovim/nvim-lspconfig/blob/master/doc/server_configurations.md#terraformls) if you need more detailed settings.
Expand Down