Sigasi checks your code for common errors and style violations as you type. This process is called linting. Many linting rule violations also offer a Quick Fix, allowing you to fix the issue with a simple click.

Problems view

The Problems view in Sigasi provides a centralized list of all linting issues found in your project. Each entry includes a description of the issue, filename, and line number where it was detected.

You can open the Problems view from the status bar or by using the View > Problems menu.

Clicking on a problem in the list will automatically open the corresponding file and navigate to the line where the issue was found. When right-clicking on a problem, Sigasi often offers quick-fixes that can automatically resolve the problem.

Naming conventions and header comment checks

Sigasi can check whether all sorts of names in the design (entities, instances, modules, signals, variables, etc.) follow particular patterns. This may help designers follow their company’s or team’s coding rules. For example, coding rules may prescribe that signal names must have a s_ prefix, that generic names must be written in capitals, or that variable names must use CamelCase. A naming convention rule is empty by default, which means that the particular rule is not checked.

In addition, Sigasi can also check for header comments of files, design units, subprograms, etc. This could, for instance, be used to check whether a copyright notice or disclaimer has been included in a file header comment.

Naming conventions configuration can be found in the Style Validation rule category.

At the top-right, you can set the severity of naming convention non-conformities. Below the severity settings, you can enter validation patterns. Patterns use the RE2/J  regular expression syntax.

Note that names are not validated if the corresponding validation pattern is empty.

You can add two patterns per name: a valid pattern that the name must match (a marker will appear if it does not match) and an invalid pattern that the name must not match (a marker will appear if it does). You can set either or both patterns per name.

Similarly, you can also find header comment configuration in the Style Validation rule category.