https://github.com/terramate-io/vscode-terramate

Terramate VSCode Extension
https://github.com/terramate-io/vscode-terramate

iac mineiros

Last synced: 2 months ago
JSON representation

Terramate VSCode Extension

• Host: GitHub
• URL: https://github.com/terramate-io/vscode-terramate
• Owner: terramate-io
• License: apache-2.0
• Created: 2022-04-04T23:59:39.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-05-14T13:54:28.000Z (5 months ago)
• Last Synced: 2024-06-25T04:33:48.838Z (3 months ago)
• Topics: iac, mineiros
• Language: TypeScript
• Homepage:
• Size: 42 KB
• Stars: 10
• Watchers: 6
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Terramate VSCode Extension

![CI Status](https://github.com/terramate-io/vscode-terramate/actions/workflows/ci.yml/badge.svg)

[![Join Discord](https://img.shields.io/discord/1088753599951151154?label=Discord&logo=discord&logoColor=white)](https://terramate.io/discord)

This is the official [Terramate](https://github.com/terramate-io/terramate)

extension for [Visual Studio Code](https://code.visualstudio.com/) editor.

If you are new to Terramate, [this article](https://blog.terramate.io/introducing-terramate-an-orchestrator-and-code-generator-for-terraform-5e538c9ee055)

provides an overview of the project and how it improves the Terraform workflow.

## Getting started

* **Step 1**: Install the [Terramate Language Server](https://terramate.io/docs/cli/installation).

* **Step 2**: Install the [Terramate Extension for VSCode](https://marketplace.visualstudio.com/items?itemName=Mineiros.terramate) or search for `Terramate` in

the VSCode Extensions Panel (**CTRL+SHIFT+X**).

If you have installed the `terramate-ls` in an arbitrary path (not in `PATH` env)

you can configure where the extension should look up for the binary using the

setting `terramate.languageServer.binPath` in

[settings.json](https://code.visualstudio.com/docs/getstarted/settings).

* **Step 3**: To activate the extension, open any folder or VS Code workspace

containing Terramate files. Any `.tm` or `.tm.hcl` file open will have the

"Language mode" set to `Terramate`.

If you have `*.hcl` associated with other extension (eg.: terraform) you can

add a specific file association for terramate in the `Settings -> Text Editor -> Files -> Associations`

or directly updating/adding the `files.associations` in the `settings.json`:

```

"files.associations": {

	"*.tm.hcl": "terramate"

}

```

## Contributing

In order to contribute to this project, first have a look in the

 [Terramate Contributing Guide](https://github.com/terramate-io/terramate/blob/main/CONTRIBUTING.md) as the same workflow applies here.

 For a technical contributing guide specific to this extension, check the

 [CONTRIBUTING.md](https://github.com/terramate-io/vscode-terramate/blob/main/CONTRIBUTING.md) documentation.