VHDL-Tool support for Atom

VHDL Tool 3fa6bc2c64 fix homepage 1 year ago
images 6347aa5d21 remove vscode references 1 year ago
lib 3932a50f32 Initial commit 1 year ago
CHANGELOG.md 3932a50f32 Initial commit 1 year ago
LICENSE.md 3932a50f32 Initial commit 1 year ago
README.md 91d62360b3 readme tweaks 1 year ago
package.json 3fa6bc2c64 fix homepage 1 year ago

README.md

VHDL-Tool

VHDL-Tool provides a language server for the VHDL hardware description language. Using atom-languageclient, this plugin makes VHDL-Tool's language server interface available from within Atom.

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.

For now, only Linux is supported.

Features

  • Syntax checking
  • Go to definition
  • Find references
  • Browse file symbols
  • Basic autocompletion

Screenshots

Syntax check and hover

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 the vhdl-tool binary from here, 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 the language-vhdl Atom plugin.
  5. (Optionally) install nuclide. This package depends on Nuclide for a lot of its functionality and it should be installed for the best experience.
  6. Launch Atom and open the folder containing the configuration file created in the previous step.

See also the instructions here.

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.
  • No VHDL 2008 support yet.

Release Notes

0.1.0

Initial beta release of VHDL-Tool.