doomemacs/modules/tools/terraform
Henrik Lissner 037b018cdd
feat: add .doommodule files
These optional dotfiles indicate the root of a module or module
group (:lang), and will later contain module metadata. They will also
serve as an alternative to packages.el and doctor.el, and will aide the
parts of the v3.0 module API concerned with resolving the current module
from a path (`doom-module-from-path`), which currently rely too heavily
on parsing path strings.

For now, however, they're simply placeholders.
2024-09-14 20:47:39 -04:00
..
.doommodule feat: add .doommodule files 2024-09-14 20:47:39 -04:00
config.el refactor: deprecate featurep! for modulep! 2022-08-14 20:43:35 +02:00
doctor.el tools/terraform: add doctor dependency check 2019-11-21 16:10:43 -05:00
packages.el bump: :tools 2024-08-19 16:21:45 -04:00
README.org docs(terraform): mention +lsp flag 2023-11-24 18:39:01 -05:00

:tools terraform

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

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?