# vscode-terraform

**Repository Path**: mirrors_apparentlymart/vscode-terraform

## Basic Information

- **Project Name**: vscode-terraform
- **Description**: A Visual Studio Code plugin which contributes syntax highlighting, linting, formatting, and validation for Hashicorp's Terraform
- **Primary Language**: Unknown
- **License**: BSD-3-Clause
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-09-24
- **Last Updated**: 2025-12-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<!-- markdownlint-disable -->
<h1 align="center">
  <br>
    <img src="https://raw.githubusercontent.com/mauve/vscode-terraform/master/terraform.png" alt="logo" width="200">
  <br>
  vscode-terraform
  <br>
  <br>
</h1>

<h4 align="center">Adds syntax highlighting and other editing features for <a href="https://www.terraform.io/">Terraform</a> files</h4>

<p align="center">
  <a href="https://travis-ci.org/mauve/vscode-terraform">
    <img src="https://travis-ci.org/mauve/vscode-terraform.svg?branch=master">
  </a>
  <a href="https://github.com/mauve/vscode-terraform/releases">
    <img src="https://img.shields.io/github/release/mauve/vscode-terraform.svg" alt="Release">
  </a>
</p>
<!-- markdownlint-enable -->
<!-- markdownlint-disable MD002 MD013 MD041 -->

## Features at a glance

- Auto-completion support
  1. `Terraform` high level types `(variable, resource, data, module ...)` auto completion support.
  2. `resource` types `(aws_dynamodb_table ...)` auto completion support for `aws, azure & google`
  3. `resource | data | module | output | variable` property types auto completion support
  4. `resource | data` 1-level nested block property types auto completion support
- Syntax highlighting for `.tf` and `.tfvars` files (and `.hcl`)
- Automatic formatting using `terraform fmt`
- Automatically closes braces and quotes
- Adds a command for running `terraform validate`
- Linting support with the help of [tflint](https://github.com/wata727/tflint)
- Browse document symbols
- Browse workspace symbols
- Peek definition
- Goto definition
- Find references
- Completion for variables and outputs
- Rename variables, resource, and data types and all references
- Show variable values on hover
- CodeLens shows if a section is referenced

## News in 1.0.0

- Indexing support is no longer experimental
- Indexing support no longer requires a separate tool (HCL parsing is now built directly into the plugin)
- *Rename refactoring* now supports all types
- Hovering a variable shows the default value
- A code lens shows how often a resource (or variable, or data) is referenced
- Terraform now works with *Visual Studio LiveShare* (thanks to [@lostintangent](https://github.com/lostintangent))

## Syntax Highlighting

![Syntax Highlighting](https://raw.githubusercontent.com/mauve/vscode-terraform/master/images/screenshot.png)

## Auto-completion support

![Auto completion](https://raw.githubusercontent.com/mauve/vscode-terraform/master/images/terraform-auto-completion.gif)

## Formatting support

The plugin also ships a formatter integration which uses `terraform fmt` for
formatting files. Formatting can be enabled or disabled by setting `editor.formatOnSave` or `[terraform]editor.formatOnSave`
to `true` or `false`.

## Linting

![Linting support](https://raw.githubusercontent.com/mauve/vscode-terraform/master/images/screenshot-tflint.png)

You can lint your terraform templates by invoking the command `Terraform: Lint` from within VSCode.

Linting is supported with the help of [tflint](https://github.com/wata727/tflint), either download it and add it
to your path or can configure `terraform.lintPath` to point to your tflint executable. `tflint` will be executed
with the workspace directory as the current working directory so you can configure `tflint` by dropping a `.tflint.hcl`
file in your workspace root.
You can change the configuration file path by supplying the configuration option `terraform.lintConfig`.

## Validation

You can `terraform validate` your project by invoking the command `Terraform: Validate` from within VSCode.

`terraform validate` is invoked with the workspace root as current working directory and with the setting
`terraform.templateDirectory` as template directory, by default this setting is "templates" (relative to
workspace root).

Because the output of `terraform validate` is not parseable the output is just dumped into the output tab.

### Indexing support

The plugin indexes all the terraform files in the workspace by default and enables some advanced features,
like *Goto Definition* and *Show references* based on information gathered during indexing.

Indexing is enabled by default but can be disabled using `terraform.indexing.enable`.

### Browse Document Symbols

Press `Ctrl+Shift+O` or `⇧⌘O` to browse symbols in the current file.

![Browse Document Symbols](https://raw.githubusercontent.com/mauve/vscode-terraform/master/images/terraform-browse-document-symbols.png)

### Browse Workspace Symbols

Press `Ctrl+T` or `⌘T` to quickly jump to any symbol.

![Browse Workspace Symbols](https://raw.githubusercontent.com/mauve/vscode-terraform/master/images/terraform-browse-workspace-symbols.png)

### Peek and Go To definition

Press `Alt+F12` or `⌥F12` to peek definition (currently only some types supported).

![Peek definition](https://raw.githubusercontent.com/mauve/vscode-terraform/master/images/terraform-peek-definition.png)

### Find All References

Press `Shift+F12` or `⇧F12` to find all references (currently only variables).

![Find all references](https://raw.githubusercontent.com/mauve/vscode-terraform/master/images/terraform-find-references.png)

### Code completion

Press `Ctrl+Space` (also triggered automatically after `.` and `"`) for simple code completion (currently only variables and outputs).

![Complete variables and outputs](https://raw.githubusercontent.com/mauve/vscode-terraform/master/images/terraform-complete-variables-and-outputs.png)

![Complete variables](https://raw.githubusercontent.com/mauve/vscode-terraform/master/images/terraform-complete-variables.png)

### Rename variables, resources and its references

Press `F2` to automatically rename a variable and its usages.

![Rename variable (before)](https://raw.githubusercontent.com/mauve/vscode-terraform/master/images/terraform-rename-variable-before.png)
![Rename variable (after)](https://raw.githubusercontent.com/mauve/vscode-terraform/master/images/terraform-rename-variable-after.png)

### Show variable default on hover

![Hover over variable](https://raw.githubusercontent.com/mauve/vscode-terraform/master/images/terraform-hover-variable.png)

### CodeLens support

![CodeLens shows number of references](https://raw.githubusercontent.com/mauve/vscode-terraform/master/images/terraform-codelens-references.png)

### Document Link support

![Click on resource type to go to documentation](https://raw.githubusercontent.com/mauve/vscode-terraform/master/images/terraform-document-link-2.png)

### Outline View support

![An outline of the currently open document is automatically showed](https://raw.githubusercontent.com/mauve/vscode-terraform/master/images/terraform-outline-view.png)

### Module Overview

![A custom view is contributed which shows an overview of all modules](https://raw.githubusercontent.com/mauve/vscode-terraform/master/images/terraform-module-overview.png)