spacemacs/layers/+tools/terraform/README.org

#+TITLE: Terraform layer

#+TAGS: layer|tool

[[file:img/terraform.png]]

* Table of Contents                     :TOC_5_gh:noexport:
- [[#description][Description]]
  - [[#features][Features:]]
- [[#install][Install]]
- [[#configuration][Configuration]]
  - [[#auto-format-on-save][Auto-format on save]]
  - [[#lsp][LSP]]

* Description
This layer provides basic support for Terraform =.tf= files.

** Features:
- Basic syntax highlighting via [[https://github.com/syohex/emacs-terraform-mode][terraform-mode]]
- Auto formatting on save via =terraform fmt=
- LSP support for terraform-lsp via =terraform-backend=

* Install
To use this configuration layer, add it to your =~/.spacemacs=. You will need to
add =terraform= to the existing =dotspacemacs-configuration-layers= list in this
file.

You will also need a working native =terraform= installation on your system.

* Configuration
** Auto-format on save
If you want =terraform fmt= to be applied automatically on save then set the
layer variable =terraform-auto-format-on-save= to =t=:

#+BEGIN_SRC emacs-lisp
  (terraform :variables terraform-auto-format-on-save t)
#+END_SRC

** LSP
To enable LSP, install [[https://github.com/juliosueiras/terraform-lsp][terraform-lsp]].
Then set the layer variable =terraform-backend= to ='lsp= like shown below:

#+BEGIN_SRC emacs-lisp
  (terraform :variables terraform-backend 'lsp)
#+END_SRC

Alternatively you can also keep the variable on nil, then lsp will be used if lsp
layer is loaded.
Fix some documentation bugs - CSS links - GIFS in published version - Unify layer doc titles - Change emoji layer emojis to an image 2015-12-02 14:23:39 +00:00			`#+TITLE: Terraform layer`
Update terraform layer 2015-07-23 23:57:45 +00:00
Add more tags 2019-05-02 21:49:30 +00:00			`#+TAGS: layer\|tool`

Update terraform layer 2015-07-23 23:57:45 +00:00			`[[file:img/terraform.png]]`

Switch to the new layers generator 2019-05-07 20:05:06 +00:00			`* Table of Contents :TOC_5_gh:noexport:`
update docs to the new toc-org format 2017-05-22 14:16:12 +00:00			`- [[#description][Description]]`
Fix doc for terraform, perforce, elfeed and evil-snipe layer 2018-01-06 20:14:35 +00:00			`- [[#features][Features:]]`
update docs to the new toc-org format 2017-05-22 14:16:12 +00:00			`- [[#install][Install]]`
			`- [[#configuration][Configuration]]`
			`- [[#auto-format-on-save][Auto-format on save]]`
[terraform] Add LSP support for terraform-lsp 2020-06-20 07:00:02 +00:00			`- [[#lsp][LSP]]`
Update terraform layer 2015-07-23 23:57:45 +00:00
			`* Description`
Fix doc for terraform, perforce, elfeed and evil-snipe layer 2018-01-06 20:14:35 +00:00			`This layer provides basic support for Terraform =.tf= files.`

			`** Features:`
			`- Basic syntax highlighting via [[https://github.com/syohex/emacs-terraform-mode][terraform-mode]]`
			`- Auto formatting on save via =terraform fmt=`
[terraform] Add LSP support for terraform-lsp 2020-06-20 07:00:02 +00:00			`- LSP support for terraform-lsp via =terraform-backend=`
Update terraform layer 2015-07-23 23:57:45 +00:00
			`* Install`
Update install layer section in REAMDE.org files 2016-01-06 05:21:55 +00:00			`To use this configuration layer, add it to your =~/.spacemacs=. You will need to`
			`add =terraform= to the existing =dotspacemacs-configuration-layers= list in this`
			`file.`
Use terraform fmt by default in the terraform layer 2017-03-13 21:55:31 +00:00
Fix doc for terraform, perforce, elfeed and evil-snipe layer 2018-01-06 20:14:35 +00:00			`You will also need a working native =terraform= installation on your system.`

Use terraform fmt by default in the terraform layer 2017-03-13 21:55:31 +00:00			`* Configuration`
terraform: rename layer var. to terraform-auto-format-on-save, set it to nil Set it to nil by default. 2017-04-12 04:04:38 +00:00			`** Auto-format on save`
			`If you want =terraform fmt= to be applied automatically on save then set the`
			`layer variable =terraform-auto-format-on-save= to =t=:`
Use terraform fmt by default in the terraform layer 2017-03-13 21:55:31 +00:00
Reformat documentation 2018-09-19 03:54:47 +00:00			`#+BEGIN_SRC emacs-lisp`
terraform: rename layer var. to terraform-auto-format-on-save, set it to nil Set it to nil by default. 2017-04-12 04:04:38 +00:00			`(terraform :variables terraform-auto-format-on-save t)`
Reformat documentation 2018-09-19 03:54:47 +00:00			`#+END_SRC`
[terraform] Add LSP support for terraform-lsp 2020-06-20 07:00:02 +00:00
			`** LSP`
			`To enable LSP, install [[https://github.com/juliosueiras/terraform-lsp][terraform-lsp]].`
[terraform] Revise terraform lsp support Made lsp support for terraform follow the convention that if not explicitly set the backend shall be inferred from the loaded layers in the dotfile. 2020-06-22 18:57:05 +00:00			`Then set the layer variable =terraform-backend= to ='lsp= like shown below:`
[terraform] Add LSP support for terraform-lsp 2020-06-20 07:00:02 +00:00
			`#+BEGIN_SRC emacs-lisp`
			`(terraform :variables terraform-backend 'lsp)`
			`#+END_SRC`

[terraform] Revise terraform lsp support Made lsp support for terraform follow the convention that if not explicitly set the backend shall be inferred from the loaded layers in the dotfile. 2020-06-22 18:57:05 +00:00			`Alternatively you can also keep the variable on nil, then lsp will be used if lsp`
			`layer is loaded.`