https://github.com/hashivim/vim-terraform

basic vim/terraform integration
https://github.com/hashivim/vim-terraform

hashivim hcl indentation terraform vim vim-terraform

Last synced: 5 days ago
JSON representation

basic vim/terraform integration

• Host: GitHub
• URL: https://github.com/hashivim/vim-terraform
• Owner: hashivim
• License: isc
• Created: 2014-12-10T18:06:36.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2024-05-07T14:05:34.000Z (7 months ago)
• Last Synced: 2024-11-20T18:49:49.812Z (22 days ago)
• Topics: hashivim, hcl, indentation, terraform, vim, vim-terraform
• Language: Vim Script
• Homepage: http://hashivim.github.io/vim-terraform
• Size: 375 KB
• Stars: 1,079
• Watchers: 19
• Forks: 111
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-terraform - Vim-Terraform
• awesome-list - vim-terraform
• awesome-tf - Vim-Terraform

README

        
[![](https://img.shields.io/badge/Supports%20Terraform%20Version-%3E%3D1.0.0-blue.svg)](https://github.com/hashicorp/terraform/blob/v1.0.0/CHANGELOG.md)

## Call For Maintainers

This plugin, along with others like it, is now maintained by the

[HashiVim](http://hashivim.github.io/) organization, which is looking for

additional maintainers and contributors.

See the HashiVim home page for further information.

---

## Overview: vim-terraform

This plugin adds a `:Terraform` command that runs terraform, with tab completion

of subcommands.

It also provides syntax highlighting, indentation and more for HCL and

Terraform-related files.

---

## Installation

With [Vim packages](http://vimhelp.appspot.com/repeat.txt.html#packages):

    git clone https://github.com/hashivim/vim-terraform.git ~/.vim/pack/plugins/start/vim-terraform

If you prefer to use a plugin manager, go ahead.

---

## Usage

Settings are documented in the [help](doc).

---

## Updating vim-terraform

Note, this is only for maintainers of the `vim-terraform` project.

When a new version of Terraform drops, you can run the following where x.x.x is

a version such as 0.11.11

    ./update_automagic.sh x.x.x

At this point, add the modified files to a git branch and open a pull request.

    git checkout -b "feature/update-to-terraform-$VERSION"

    git add $FILE

    git commit -m "Message about update"

    git push

Add another maintainer to the pull request and await confirmation.

---

## Running tests

To run the test suite and verify functionality

    make

---

## Credits

Syntax highlighting and indentation by Kevin Le (@bkad) based on prior work by

Larry Gilbert (@L2G).

The rest originally written by Mark Cornick  and

contributors listed below.

Licensed under the ISC license.

Thanks to the following contributors:

- michael j talarczyk (@mijit)

- Koji Nakayama (@knakayama)

- Kris (@kostecky)

- Okumura Takahiro (@hfm)

- Paul Forman (@pforman)

- Lowe Schmidt (@lsc)

- Mario Kozjak (@mkozjak)

The `:TerraformFmt` command is adapted from

[vim-hclfmt](https://github.com/fatih/vim-hclfmt/blob/master/autoload/fmt.vim).

This project is intended to be a safe, welcoming space for collaboration, and

contributors are expected to adhere to the [Contributor

Covenant](http://contributor-covenant.org) code of conduct.