Zig Extension Pack for Vscode

Essential Zig development environment for VSCode - comprehensive tooling for modern systems programming

📦 What's Included

This extension pack includes 3 carefully selected extensions to enhance your zig development experience in vscode.

✅ Core Extensions (2)

These extensions are essential for zig development:

• Zig Language - Official Zig language support with ZLS integration for IntelliSense and code completion
• CodeLLDB - Native debugger based on LLDB for debugging Zig applications

💡 Additional Extensions (1)

These extensions provide extra functionality and convenience:

• Error Lens - Inline error and warning messages for better visibility

🚀 Installation

Method 1: Install from Marketplace

1. Open Vscode
2. Go to Extensions view (Ctrl+Shift+X / Cmd+Shift+X)
3. Search for "Zig Extension Pack for Vscode"
4. Click "Install"

Method 2: Install via Command Line

code --install-extension @templ-project/zig-extension-pack

Method 3: Install from VSIX

1. Download the latest .vsix file from Releases
2. Open Vscode
3. Run Extensions: Install from VSIX... command
4. Select the downloaded file

⚙️ Configuration

After installation, you may want to configure some settings for optimal zig development:

zig.path

{
  "zig.path": "zig"
}

Path to Zig executable (install with: https://ziglang.org/download/)

zig.zls.enabled

{
  "zig.zls.enabled": true
}

Enable Zig Language Server (ZLS) for IntelliSense and completions

zig.zls.path

{
  "zig.zls.path": "zls"
}

Path to ZLS executable (install from: https://github.com/zigtools/zls/releases)

zig.buildOnSave

{
  "zig.buildOnSave": false
}

Run zig build on save

zig.buildOption

{
  "zig.buildOption": "build"
}

Build option for zig build command

zig.buildArgs

{
  "zig.buildArgs": []
}

Additional arguments for zig build

zig.initialSetupDone

{
  "zig.initialSetupDone": false
}

Whether initial setup is complete

zig.zls.debugLog

{
  "zig.zls.debugLog": false
}

Enable debug logging for ZLS

zig.zls.enableSnippets

{
  "zig.zls.enableSnippets": true
}

Enable code snippets

zig.zls.enableArgumentPlaceholders

{
  "zig.zls.enableArgumentPlaceholders": true
}

Enable placeholder arguments for function completions

zig.zls.enableBuildOnSave

{
  "zig.zls.enableBuildOnSave": false
}

Run zig build on save

zig.zls.buildOnSaveStep

{
  "zig.zls.buildOnSaveStep": "install"
}

Build step to run on save (e.g., install, test)

zig.zls.enableAutofix

{
  "zig.zls.enableAutofix": true
}

Enable automatic fixes for common issues

zig.zls.semanticTokens

{
  "zig.zls.semanticTokens": "full"
}

Enable semantic tokens for better syntax highlighting

zig.zls.enableInlayHints

{
  "zig.zls.enableInlayHints": true
}

Enable inlay hints for types and parameters

zig.zls.inlayHintsShowVariableTypeHints

{
  "zig.zls.inlayHintsShowVariableTypeHints": true
}

Show type hints for variables

zig.zls.inlayHintsShowParameterName

{
  "zig.zls.inlayHintsShowParameterName": true
}

Show parameter names in function calls

zig.zls.inlayHintsHideRedundantParamNames

{
  "zig.zls.inlayHintsHideRedundantParamNames": true
}

Hide parameter names when they match the argument

zig.zls.warnStyle

{
  "zig.zls.warnStyle": true
}

Enable style warnings

zig.zls.highlightGlobalVarDeclarations

{
  "zig.zls.highlightGlobalVarDeclarations": true
}

Highlight global variable declarations

[zig]

{
  "[zig]": {"editor.defaultFormatter":"ziglang.vscode-zig","editor.formatOnSave":true,"editor.tabSize":4,"editor.insertSpaces":true,"editor.detectIndentation":false,"editor.rulers":[100],"editor.semanticHighlighting.enabled":true,"editor.inlayHints.enabled":"on"}
}

Editor configuration for Zig files

files.associations

{
  "files.associations": {"*.zig":"zig","*.zon":"zig"}
}

File associations for Zig files

lldb.library

{
  "lldb.library": null
}

Path to LLDB library (auto-detected if not set)

lldb.displayFormat

{
  "lldb.displayFormat": "auto"
}

Default format for variable display

lldb.showDisassembly

{
  "lldb.showDisassembly": "auto"
}

When to show disassembly

lldb.dereferencePointers

{
  "lldb.dereferencePointers": true
}

Automatically dereference pointers in variables view

errorLens.enabled

{
  "errorLens.enabled": true
}

Enable Error Lens for inline error display

errorLens.enabledDiagnosticLevels

{
  "errorLens.enabledDiagnosticLevels": ["error","warning","info"]
}

Diagnostic levels to display inline

⌨️ Recommended Keybindings

• Build Zig project: ctrl+shift+b
• Run Zig tests: ctrl+shift+t
• Start debugging: f5
• Open Zig documentation: ctrl+shift+d

📝 Extension Details

Extension	Publisher	Description
Zig Language	ziglang	Official Zig language support with ZLS integration for IntelliSense and code completion
CodeLLDB	vadimcn	Native debugger based on LLDB for debugging Zig applications
Error Lens	Alexander	Inline error and warning messages for better visibility

🏷️ Categories

zig zls development systems-programming debugging build

📄 License

Extension Pack License

This extension pack is licensed under the MIT License - see LICENSE.md for details.

Third-Party Extension Licenses

Important: Each extension included in this pack has its own license terms. templ-project is not responsible for the licensing, functionality, or security of third-party extensions.

Extension	Publisher	License	Description
Zig Language	ziglang	MIT	Official Zig language support with ZLS integration for IntelliSense and code completion
CodeLLDB	vadimcn	MIT	Native debugger based on LLDB for debugging Zig applications
Error Lens	Alexander	MIT	Inline error and warning messages for better visibility

Disclaimer

• We do not guarantee the functionality, security, or compatibility of included extensions
• We are not responsible for any issues caused by third-party extensions
• Users install and use extensions at their own risk
• Please review each extension's license and privacy policy before use

🤝 Contributing

Found an issue or want to suggest an extension? Please open an issue or submit a pull request.

📊 Extension Pack Stats

• Total Extensions: 3
• Required Extensions: 2
• Optional Extensions: 1
• Target IDE: vscode
• Language Focus: zig

---

This extension pack is maintained by templ-project and updated regularly to include the most useful zig development extensions.