VS Code Views

This page documents the Views added to VS Code by the Sigasi extension.

Sigasi Projects View

The Sigasi Projects View offers a file browser for your projects in which external folders that are not physically part of your project can exist. This can be useful for including external IP in your projects.

Sigasi Projects View

The Projects View also offers a lot of custom Sigasi functionality, such as library mapping, version setting, and displaying the Preference View.

Linked Libraries

Any (external) libraries and files not within the folder of the opened project can be added using the Sigasi Projects View. In the Sigasi Projects View, right-click any file or folder and select the New Linked File… or New Linked Folder… option to add files and folders from outside the project location. The configuration of the external files and folders will be kept in the .project file in the project root.

External files and folders can be added anywhere in the project. If you add a large folder, for example, the unisim primitives, make sure to exclude the folder (Right-click > Set Library > Exclude from Build) from being built and only include the required files. Alternatively, you can put the library files in a folder called Common Libraries. Then, they will only be indexed but not analyzed for errors.

Buttons in the Sigasi Projects View

These buttons are available in the Sigasi Projects View.

  • Create a new file
  • Create a new folder
  • Refresh
  • Toggle linking the Sigasi Projects View with the editor
  • Collapse all folders in the Sigasi Projects View

Hierarchy View

Sigasi Projects View

Initially, the Hierarchy View will be empty. To use the Hierarchy View, right-click an entity, architecture, or module name in the editor and select Set as Top Level from the pop-up menu. This will populate the Hierarchy View with the structure of the top level.

As you make changes to the design, the Hierarchy View will not automatically refresh. To refresh the Hierarchy View, use the refresh button ( ).

If you want the selection in the Hierarchy View to follow your position in the editor, make sure to enable the link with editor button ( ).

Buttons in the Hierarchy View

These buttons are available in the Hierarchy View.

  • Expand the full hierarchy
  • Toggle link with the editor
  • Toggle showing only instantiations
  • Refresh the Hierarchy View
  • Collapse the hierarchy

Preferences View

Sigasi Preferences View

To open the Preferences View, right-click the project, folder, or file you want to configure in the Sigasi Projects View. This view allows you to configure all preferences for the selected project, folder, or file.

  • You can change the severity of linting rules for your project.
  • You can tweak validation parameters.
  • You can modify conditional variables for VHDL 2019 projects.
  • You can configure include paths and initial defines for the SystemVerilog Preprocessor.

Make sure to click the APPLY button at the top right after making your changes.

Changes you make here will be stored in the .settings/ folder within your project. This way, if you commit the settings with your project, they will be available for your fellow team members, even if they use Sigasi Studio for Eclipse.

Configuring the Linting Rules

Linting is largely shared between our products. This page only covers VS Code specific use cases. Refer to the common documentation to learn more.

Linting rules can be configured per project, folder, or file by right-clicking a project, folder, or file > Open Preference View in the Projects View and then selecting Verilog Errors/Warnings or VHDL Errors/Warnings. In the middle of the page, Click here to enable to activate the rule configuration.

Sigasi Preferences View

Graphical Views

Refer to the Common Documentation to learn more about the Block Diagram-, State Machines-, and Dependencies Views.