This page documents the Views added to VS Code by the Sigasi extension.
Project View
The Project 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.
The project view also offers a lot of custom Sigasi functionality e.g. library mapping, version setting, preference view, …
Linked Libraries
Any (external) libraries and files, that are not within the folder of the opened project, can be added using the Project View.
In the Project 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 (e.g. the unisim
primitives), make sure to exclude the folder (Right-click > Set Library > Exclude from Build) from being build and only include the required files.
Or just put the library files in a folder called Common Libraries
.
Then they will only be indexed and not analyzed for errors.
Buttons in the Project View
These buttons are available in the Project View.
-
Create a new file
-
Create a new folder
-
Refresh the Project View
-
Toggle linking the Project View with the editor
-
Collapse all folders in the Project View
Hierarchy 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
To open the Preferences View, right-click the resource you want to configure in the Project View. This View allows to configure all preferences for your entire project, a folder, or a file.
- You can change the severity of linting rules for your project.
- 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, also if they are using Sigasi Studio for Eclipse.