Emacs terraform-mode
An Emacs major mode for editing Terraform configuration files with syntax highlighting, indentation, and formatting.
What is Emacs terraform-mode?
terraform-mode.el is an Emacs major mode for editing Terraform configuration files. It provides syntax highlighting, indentation, block folding, and integration with Terraform's formatting tool to streamline Infrastructure as Code development within Emacs.
Emacs users who work with Terraform for infrastructure provisioning and management, particularly DevOps engineers and system administrators who prefer Emacs as their primary editor.
It offers a specialized, feature-rich editing environment for Terraform within Emacs, reducing the need to switch to external tools and enhancing productivity with built-in formatting, documentation access, and navigation features.
Overview
Major mode of Terraform configuration file
Use Cases
Best For
- Editing Terraform configuration files in Emacs
- Automatically formatting Terraform code on save
- Navigating large Terraform projects with imenu
- Folding and unfolding resource blocks for better code organization
- Quickly accessing Terraform resource documentation
- Customizing indentation levels for Terraform code
Not Ideal For
- Projects where developers use IDEs like VSCode or IntelliJ with dedicated Terraform plugins
- Teams requiring graphical user interfaces for Terraform visualization or integrated debugging tools
- Environments where Terraform CLI is not installed or network access for `terraform providers` is restricted
- Users who prefer editors with minimal configuration and no need to set up Emacs hooks or modes
Pros & Cons
Pros
Provides rich syntax highlighting for Terraform keywords, strings, and blocks, inheriting from hcl-mode for accurate parsing and improved readability.
Integrates with `terraform fmt` to automatically format code, with an option to enable formatting on save via `terraform-format-on-save` for consistent styling.
Offers keyboard shortcuts to open Terraform resource documentation in a browser or copy URLs, speeding up development with direct access to official docs.
Supports folding resource blocks using outline-mode, allowing for focused editing and better code organization, though it requires manual setup in hooks.
Enables easy navigation through Terraform files using imenu, making it simple to jump between resources and data blocks for large projects.
Cons
Features like documentation access require a working `terraform providers` command, which can fail without proper tokens or network access, adding external dependencies.
Exclusively for Emacs users, offering no cross-editor compatibility and limiting collaboration in mixed-tool environments where others use different IDEs.
Requires manual configuration, such as enabling outline-minor-mode in hooks for block folding, which can be cumbersome and non-intuitive for new Emacs users.
Lacks modern IDE features like LSP support, autocompletion, or real-time error checking, making it less feature-rich compared to dedicated Terraform extensions in other editors.
Frequently Asked Questions
Related Projects
Terraform-lsTerraform Language Server
Vim-Terraformbasic vim/terraform integration
Terraform-lspLanguage Server Protocol for Terraform
Vim-Terraform-CompletionA (Neo)Vim Autocompletion and linter for Terraform, a HashiCorp tool
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.