Vim-Terraform-Completion
A Vim/Neovim plugin providing autocompletion and linting for Terraform configurations with version-aware provider support.
What is Vim-Terraform-Completion?
vim-terraform-completion is a Vim and Neovim plugin that provides autocompletion and linting capabilities specifically for Terraform configuration files. It solves the problem of writing Terraform code manually by offering intelligent suggestions and real-time error checking directly within the editor, improving developer productivity and code quality.
Vim and Neovim users who regularly write and maintain Terraform configurations for infrastructure-as-code projects, particularly DevOps engineers and platform developers.
Developers choose this plugin because it offers version-aware completion for Terraform providers, deep integration with Vim's editing workflow, and a lightweight alternative to full IDEs, making Terraform development faster and more accurate.
Overview
A (Neo)Vim Autocompletion and linter for Terraform, a HashiCorp tool
Use Cases
Best For
- Writing Terraform configurations with accurate provider-specific completions
- Real-time linting of HCL files within Vim/Neovim
- Managing multiple Terraform provider versions in a single project
- Viewing Terraform documentation without switching contexts
- Using community Terraform providers with editor support
- Integrating Terraform development into a terminal-based workflow
Not Ideal For
- Teams using Visual Studio Code or JetBrains IDEs with built-in Terraform extensions
- Developers who prefer zero-configuration tools and avoid managing multiple Vim plugins
- Projects requiring real-time collaborative editing or cloud-based development environments
- Users with Vim configurations lacking Ruby support or unwilling to install additional gems
Pros & Cons
Pros
Supports specific provider versions via a .tfcompleterc config file, ensuring accurate suggestions for different Terraform releases, as demonstrated in the provider versions documentation.
Provides intelligent suggestions for blocks, resources, and functions with optional/required indicators, shown in the block completion screenshots and README examples.
Integrates with syntastic and neomake to run terraform validate and tflint, displaying errors directly in the editor, as detailed in the dependencies and minimal configuration section.
Allows viewing Terraform documentation without leaving Vim using key mappings like Ctrl-K, mentioned in the todo list and features overview.
Cons
Relies on multiple external plugins like vim-terraform, syntastic, and deoplete, making setup and maintenance more involved, as noted in the installation dependencies.
The README includes extensive todo lists with many items marked as WIP, such as better linter and full snippets, indicating ongoing development and potential functionality gaps.
Enabling deep checks for tflint can be slow, affecting editor responsiveness, as warned in the general todo section of the README.
Frequently Asked Questions
Related Projects
Terraform-lsTerraform Language Server
Vim-Terraformbasic vim/terraform integration
Terraform-lspLanguage Server Protocol for Terraform
Emacs terraform-modeMajor mode of Terraform configuration file
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.