History

Henrik Lissner 15d7353946 bump: :tools andras-simonyi/citeproc-el@c61c98b9d2 -> andras-simonyi/citeproc-el@44f90cb296 editorconfig/editorconfig-emacs@c3666c093f -> editorconfig/editorconfig-emacs@d73b6392de emacs-citar/citar-org-roam@7d67dccf80 -> emacs-citar/citar-org-roam@82d47b5df1 emacs-tree-sitter/tree-sitter-langs@c56cb51104 -> emacs-tree-sitter/tree-sitter-langs@b7895ca759 emacsorphanage/quickrun@248149b026 -> emacsorphanage/quickrun@373634cf51 hcl-emacs/terraform-mode@e8b57df8c2 -> hcl-emacs/terraform-mode@a645c32a8f k1LoW/emacs-ansible@d89ac0ee57 -> k1LoW/emacs-ansible@1d7de8d3dd krzysztof-magosa/company-ansible@79dd421b16 -> krzysztof-magosa/company-ansible@338922601c nicolaisingh/saveplace-pdf-view@abfb5e1f46 -> nicolaisingh/saveplace-pdf-view@ee95460cd9 purcell/envrc@1385e72a73 -> purcell/envrc@8eb7401700 spotify/dockerfile-mode@52c6c00da1 -> spotify/dockerfile-mode@39a012a27f tmalsburg/helm-bibtex@bf184cc311 -> tmalsburg/helm-bibtex@8b71b4f5ce vedang/pdf-tools@c69e7656a4 -> vedang/pdf-tools@93e7492451 xuchunyang/osx-dictionary.el@1f5a74f3e5 -> xuchunyang/osx-dictionary.el@6abfd6908b yoshiki/yaml-mode@5b58248ab2 -> yoshiki/yaml-mode@7b5ce294fb		2024-05-21 17:17:09 +02:00
..
config.el	refactor: deprecate featurep! for modulep!	2022-08-14 20:43:35 +02:00
doctor.el
packages.el	bump: :tools	2024-05-21 17:17:09 +02:00
README.org	docs(terraform): mention +lsp flag	2024-05-21 17:16:24 +02:00

README.org

:tools terraform

Description
- Maintainers
- Module flags
- Packages
- Hacks
- Changelog
Installation
Usage
Configuration
Troubleshooting
Frequently asked questions
Appendix

Description unfold

This module adds support for working with Terraform files within Emacs. This includes syntax highlighting, intelligent code completion, and the ability to run Terraform commands directly from Emacs.

Maintainers

This module has no dedicated maintainers. Become a maintainer?

Module flags

+lsp: Enable LSP support for terraform-mode. Requires doom-module::tools lsp and a langserver (supports terraform-ls or terraform-lsp).

Packages

doom-package:company-terraform if doom-package::completion company
doom-package:terraform-mode

Hacks

No hacks documented for this module.

TODO Changelog

This module does not have a changelog yet.

Installation

Enable this module in your doom! block.

This module requires the terraform executable to be installed and in your $PATH.

Usage

Syntax highlighting

Syntax highlighting is provided from terraform-mode and hcl-mode.

Code formatting

doom-module::tools terraform does not provide code formatting directly, but doom-module::editor format works with Terraform files.

Code navigation

Code navigation is supported through doom-package:imenu from doom-package:terraform-mode.

Code completion

Code completion of Terraform builtins is provided from doom-package:company-terraform and generally works well despite being generated through a static (outdated) file.

doom-package:company-terraform also provides code completion of resources within your project.

Documentation

Documentation is accessible through the normal doom-package:company show documentation functionality, thanks to doom-package:company-terraform.

Executing Terraform commands

doom-module::tools terraform provides commands under <localleader> to run the most common Terraform operations:

key	description
<localleader> i	Runs `$ terraform init`
<localleader> p	Runs `$ terraform plan`
<localleader> a	Runs `$ terraform apply`

TODO Configuration

󱌣 This module has no configuration documentation yet. Write some?

Troubleshooting

There are no known problems with this module. Report one?

Frequently asked questions

This module has no FAQs yet. Ask one?

TODO Appendix

󱌣 This module has no appendix yet. Write one?