BTA Design Services TB_LINT VS Code Extension

Version: 0.0.21

BTA Design Design Verification open-source initiative projects:

• TB_LINT
• VS Code Extension

Overview

This extension brings powerful linting capabilities directly into your IDE, integrating NaturalDocs and Verible linters through the TB_LINT framework. It provides real-time feedback, inline diagnostics, and workspace-wide validation to ensure your design and verification code meets high-quality standards.

Features

• Real-time Linting: Automatically lint SystemVerilog/Verilog files on open, save, or as you type.
• Multiple Linting Engines: Harnesses the power of NaturalDocs and Verible.
• Inline Diagnostics: Violations displayed as inline diagnostics (squiggles) in the editor.
• Setup Verification: Built-in command to verify your environment configuration.
• Output Channel: Detailed linting output with timestamps and rule information.
• Workspace Linting: Lint all SystemVerilog/Verilog files in the workspace at once.
• Configurable: Support for custom TB_LINT configuration files and flexible extension settings.
• Cross-Platform: Works seamlessly on Windows, macOS, and Linux.

Installation

Prerequisites

1. VS Code: Version 1.75.0 or later.
2. Python 3.6+: Required to run the TB_LINT framework.
3. TB_LINT Framework:

   git clone https://github.com/BTA-design-services/tb_lint.git
   

Quick Start

1. Install the Extension:

   • Download the .vsix file or build from source.
   • Run code --install-extension tb-lint-0.1.0.vsix.

2. Configure Paths: Add the following to your .vscode/settings.json:

   {
     "tb_lint.tbLintPath": "${workspaceFolder}/tb_lint/tb_lint.py",
     "tb_lint.configFile": "${workspaceFolder}/tb_lint/configs/lint_config.json"
   }
   

3. Verify Setup:

   • Open the Command Palette (Ctrl+Shift+P).
   • Run TB_LINT: Verify Setup.

Configuration

Configure TB_LINT in VS Code settings (Ctrl+,) or directly in .vscode/settings.json.

Essential Settings

Behavior Settings

Example Configuration (Production)

{
  "tb_lint.pythonPath": "python3",
  "tb_lint.tbLintPath": "${workspaceFolder}/tb_lint/tb_lint.py",
  "tb_lint.configFile": "${workspaceFolder}/configs/lint_config.json",
  "tb_lint.enableOnOpen": true,
  "tb_lint.enableOnSave": true,
  "tb_lint.enableOnChange": false,
  "tb_lint.autoShowOutput": false
}

Usage

Manual Linting

• Lint Current File:
  • Command: TB_LINT: Lint Current File
  • Shortcut: Ctrl+Shift+L (Windows/Linux) or Cmd+Shift+L (macOS)
• Lint Workspace:
  • Command: TB_LINT: Lint Workspace
  • Lints all .sv, .svh, .v, .vh files.
• Clear Diagnostics:
  • Command: TB_LINT: Clear Diagnostics

Viewing Results

1. Problems Panel (Ctrl+Shift+M): Shows all violations with file, line, column, and severity. Click to jump to the location.
2. Inline Squiggles: Red (Error), Yellow (Warning), Blue (Info). Hover to see the full message.
3. Output Channel: View -> Output -> TB_LINT. Shows detailed logs and execution status.

Troubleshooting

Common Issues

Verify Setup Command

Use the built-in verification command to diagnose issues:

1. Open Command Palette (Ctrl+Shift+P).
2. Run TB_LINT: Verify Setup.
3. Check the notification or Output channel for details.

Development

Building from Source

# Clone repository
git clone https://github.com/BTA-design-services/vscode-tb-lint.git
cd vscode-tb-lint

# Install dependencies
npm install

# Compile
npm run compile

# Package
vsce package

License

MIT License - Copyright (c) BTA Design Services

Support

• TB_LINT Framework: GitHub Repository
• VS Code Extension: GitHub Repository
• Issues: Report a Bug

About BTA Design Services

BTA Design Services Inc specializes in ASIC and FPGA design and verification services, custom IP development, embedded software, and DevOps capabilities creation. We are able to do turnkey design, augment or enhance existing design teams, or deliver complete and verified IP blocks to spec. There are no limits to how we engage with our customers, and we are proud of our ability to adapt.