VS Code Integration¶

TerraTidy provides a VS Code extension for seamless integration with your editor.

Installation¶

From Marketplace¶

1. Open VS Code
2. Go to Extensions (Ctrl+Shift+X / Cmd+Shift+X)
3. Search for "TerraTidy"
4. Click Install

From VSIX¶

# Download the extension
wget https://github.com/santosr2/TerraTidy/releases/latest/download/terratidy.vsix

# Install
code --install-extension terratidy.vsix

Requirements¶

• TerraTidy CLI must be installed and in your PATH
• VS Code 1.110.0 or higher

Features¶

Real-time Diagnostics¶

Issues are highlighted as you type using push diagnostics. The LSP server automatically sends diagnostics when you open, edit, or save a file:

• Errors shown with red squiggly underlines
• Warnings with yellow underlines
• Info with blue underlines

The server runs lint and style engines to produce diagnostics. Rule overrides from .terratidy.yaml are respected (see Configuration).

Document Formatting¶

Format Terraform and HCL files using hclwrite:

{
  "[terraform]": {
    "editor.defaultFormatter": "santosr2.terratidy",
    "editor.formatOnSave": true
  }
}

Quick Fixes¶

Click the lightbulb icon or press Ctrl+. / Cmd+. to apply formatting fixes for diagnostics. When a file has formatting issues, code actions offer to reformat the document.

Commands¶

Access via Command Palette (Ctrl+Shift+P / Cmd+Shift+P):

Settings¶

Configure in VS Code settings (Ctrl+, / Cmd+,):

{
  // Path to terratidy executable (if not in PATH)
  "terratidy.executablePath": "",

  // Path to configuration file
  "terratidy.configPath": "",

  // Configuration profile to use
  "terratidy.profile": "",

  // Run checks on save (default: false)
  "terratidy.runOnSave": false,

  // Format on save (default: false)
  "terratidy.formatOnSave": false,

  // Auto-fix on save
  "terratidy.fixOnSave": false,

  // Enable/disable engines
  "terratidy.engines.fmt": true,
  "terratidy.engines.style": true,
  "terratidy.engines.lint": true,
  "terratidy.engines.policy": false,

  // Minimum severity to show
  "terratidy.severityThreshold": "warning"
}

Workspace Settings¶

Create .vscode/settings.json for project-specific settings:

{
  "terratidy.profile": "development",
  "terratidy.engines.policy": true,
  "terratidy.configPath": ".terratidy.yaml"
}

Keyboard Shortcuts¶

Default shortcuts:

Customize in Keyboard Shortcuts (Ctrl+K Ctrl+S):

{
  "key": "ctrl+alt+t",
  "command": "terratidy.restartServer",
  "when": "editorLangId == terraform"
}

Troubleshooting¶

TerraTidy Not Found¶

Check the output channel for errors:

1. Open Command Palette
2. Run "TerraTidy: Show Output"

Verify installation:

which terratidy
terratidy --version

Set explicit path:

{
  "terratidy.executablePath": "/usr/local/bin/terratidy"
}

No Diagnostics Appearing¶

1. Check file is recognized as Terraform (.tf) or HCL (.hcl)
2. Verify configuration file is valid
3. Check severity threshold setting
4. Look at output channel for errors

Performance Issues¶

For large projects:

{
  "terratidy.runOnSave": false,
  "terratidy.engines.lint": false
}

Run checks manually when needed.

Limitations¶

Engine Selection for Diagnostics¶

Document formatting (Format Document command, Ctrl+Shift+F) works regardless of engine settings. However, for real-time diagnostics (squiggly underlines), the LSP server only runs the lint and style engines. The engines.fmt and engines.policy toggles are accepted but do not yet control which engines produce diagnostics. Policy engine diagnostics are planned for a future release.

Multi-root Workspaces¶

The LSP server currently uses only the first workspace folder's root. Diagnostics and configuration are scoped to that folder. Multi-root workspace support is planned for a future release.

Remote Development¶

The extension sets extensionKind: ["workspace"] so it runs on the remote side when using Remote Development (SSH, Containers, WSL). Ensure TerraTidy is installed in the remote environment.

terraform-vars Language¶

The extension activates on the terraform-vars language, which is provided by the HashiCorp Terraform extension. Install it for .tfvars file support.