Setting up a Development Environment¶
If you would like to review the code and make some changes, follow these steps to setup the development environment.
Dependencies¶
VSG uses PyYAML to parse JSON and YAML files. Ensure at least version 5.1 is installed in your python site-packages directory.
Clone the repo¶
Clone the repo with the following command:
git clone https://github.com/jeremiah-c-leary/vhdl-style-guide.git
Setup alias¶
Set an alias to VSG as follows:
set alias vsg='python3 <path_to_clone_directory>/bin/vsg'
This allows you to execute VSG without installing it.
Running Unit Tests¶
To run the unit tests use the following command:
python -m unittest
After issuing the command the tests will be executed.
vhdl-style-guide$ python -m unittest discover
.................................................
.................................................
.................................................
.................................................
.................................................
.................................................
.................................................
.................................................
.................................................
.................................................
.................................................
.................................................
.................................................
.................................................
.................................................
.................................................
.................................................
.................................................
.................................................
.................................................
.................................................
.................................................
.................................................
...........................................
-------------------------------------------------
Ran 1170 tests in 6.424s
OK