doomemacs/modules/tools/terraform/README.org

tools/terraform

• Description
  • Module Flags
  • Plugins
• Prerequisites
• Features
  • Syntax highlighting
  • Code formatting
  • Code navigation
  • Code completion
  • Documentation
  • Executing Terraform commands
• Appendix
  • Keybindings
    • :localleader

Description

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

Module Flags

This module provides no flags.

Plugins

• terraform-mode
• company-terraform*

Prerequisites

The terraform executable must be installed and accessible from your PATH.

Features

Syntax highlighting

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

Code formatting

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

Code navigation

Code navigation is supported through imenu from terraform-mode.

Code completion

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

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

Documentation

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

Executing Terraform commands

:tools terraform provides commands under the localleader to run the most common Terraform operations (see Keybindings below).

Appendix

Keybindings

:localleader

key	description
i	Run terraform init
p	Run terraform plan
a	Run terraform apply