Visual Studio Code plugin for VHDL-Tool

VHDL Tool da8301933b version 0.0.9 4 months ago
.vscode 071339aa6a update deps 2 years ago
images 2b77207566 update screenshots 1 year ago
src efb802c511 make more similar to reference example 4 months ago
.gitignore bf70a8aad8 Initial Visual Studio Code plugin 5 years ago
.vscodeignore bf70a8aad8 Initial Visual Studio Code plugin 5 years ago
README.md da8301933b version 0.0.9 4 months ago
development.md 79b3428441 dev notes 4 months ago
package.json da8301933b version 0.0.9 4 months ago
tsconfig.json bf70a8aad8 Initial Visual Studio Code plugin 5 years ago

README.md

VHDL-Tool

VHDL-Tool provides a language server for the VHDL hardware description language. This plugin makes VHDL-Tool's language server interface available from within VSCode.

This is beta quality code. Report bugs here: https://git.vhdltool.com/vhdl-tool/vhdl-tool/issues.

To use this plugin, you must first download VHDL-Tool. See the requirements section.

Features

  • Syntax checking
  • Go to definition
  • Find references
  • Browse file symbols
  • Basic autocompletion
  • Type information on hover

Screenshots

Syntax check and autocompletion File symbols and hover

Usage

  • F12 - go to definition
  • Ctrl-Shift-F10 - peek definition
  • Shift-F12 - find references
  • Ctrl-Shift-o - find symbol in current file
  • Syntax checking occurs on save and the first time a file is opened
  • Autocompletion happens automatically when you type
  • Mouse over an identifier for type information

Requirements

Before using this plugin, you must ensure that the vhdl-tool binary is installed on your system. To install vhdl-tool and setup your environment, do the following:

  1. Install this plugin.
  2. Download vhdl-tool from here. If you are using the Linux version, make sure it has execute permissions, and put it somewhere in your $PATH.
  3. Create a vhdltool-config.yaml configuration file for your project by following the instructions here.
  4. Install one of the other VHDL plugins available in the marketplace for syntax highlighting. Search for VHDL in the extensions sidebar. This step is compulsory as these plugins define the VHDL language and if VSCode does not know about VHDL it cannot launch the language server.
  5. Launch VSCode and open the folder containing the configuration file created in the previous step.

Known Limitations

  • The go to definition and find references commands are not accurate in the presence of overloading. In the case of multiple overloaded identifiers with the same name, the type correct one may not be chosen.

Release Notes

0.0.9

Incorporate changes in reference example

0.0.8

Upgrade plugin dependencies so that it works with the latest VSCode

0.0.7

Display initialization progress

0.0.6

Windows support

0.0.1

Initial beta release of VHDL-Tool.