Introduction

This repository contains scripts and tools to automatically reformat and lint SystemVerilog and Verilog code using the Verible Toolchain.

These scripts include:

• A Git Pre-Commit hook: auto-lint-format-pre-commit
• A Unix shell script for UNIX-like shells: auto-lint-format-unix
• A Powershell script for Windows users: auto-lint-format-windows

External Requirements

Verible SystemVerilog Tools

• Install the Verible Toolchain for your operating system
  • Releases
• Make sure the following Verible tools are exposed to PATH
  • verible-verilog-lint
  • verible-verilog-format

System-Specific guides to modifying the PATH variable:

• UNIX
• WINDOWS

# Prints "found" if required tools are exposed to PATH

# Powershell
if(Get-Command verible-verilog-lint && Get-Command verible-verilog-format){"found"}

# Bash
[[ -n $(type -P verible-verilog-format) && -n $(type -P verible-verilog-lint) ]] && echo "found"

Script Configuration

Important Note

verible.filelist

Running any of the provided scripts will automatically create or update the verible.filelist file. This contains a line-separated list of every *.v and *.sv file relative to the project's base directory.

# Powershell/Bash
$ cat verible.filelist
./DE1_SoC.sv
./test.sv
./othertest.sv
./file.v

The scripts rely on this file to apply formatting and linting suggestions: do not remove this file!

The verible-verilog-ls Language Server also uses this list to parse files for symbol searching. This tool is optional and not used by the scripts.

Linting

Default options are defined in the official documentation, and the full command list is available at the verible lint options page.

User-defined linting preferences are placed in .rules.verible_lint in the base directory of the repository. This file contains a line-separated list of linter options to be added or removed from the linter defaults.

Linter commands to be added to the defaults have a '+' as a prefix, while linter commands to be removed have a '-' as a prefix.

Example:

# Powershell/Bash
$ cat .rules.verible_lint
-explicit-parameter-storage-type
+line-length=length:80
+endif-comment
-generate-label-prefix

Formatting

The full list of formatting options is available at the official Formatter Documentation page.

User-defined formatter options are placed in .rules.verible_format in the base directory of the repository. This file contains a line-separated list of formatter commands to be applied when reformatting code.

Example:

# Powershell/Bash
$ cat .rules.verible_format
--column_limit 80
--indentation_spaces 4

Ignoring Specific Files

verible.filelist.ignore

To prevent the formatting/linting of a specific set of files, one can optionally create the verible.filelist.ignore file in the project's base directory. The format of this file (similar to verible.filelist) is a line-separated list of the paths of each desired 'ignored' file relative to the project base directory.

Example verible.filelist.ignore:

# Powershell/Bash
$ cat verible.filelist.ignore
./test.sv
./othertest.sv

Provided Scripts

Pre-Commit

Filename: auto-lint-format-pre-commit

This repository contains a pre-commit hook that runs automatically before the user adds a commit message. The script will attempt to reformat and lint all Verilog and SystemVerilog files in the current repository, preventing a commit if any errors are encountered.

To allow the hook to run automatically, create a hard link to the appropriate directory.

From the base directory of the git repository:

# Powershell
cmd /c mklink /h .\.git\hooks\pre-commit .\auto-lint-format-pre-commit

# Bash
ln ./auto-lint-format-pre-commit ./.git/hooks/pre-commit

If there are linter/formatter warnings that can be overlooked or ignored, the pre-commit hook can be overwritten with:

# Powershell/Bash
git commit --no-verify

Additional Resources: More About Git Hooks

UNIX

Filename: auto-lint-format-unix.sh

This script runs the automated linting and formatting in a UNIX compliant shell. If an error occurs while reformatting or linting, the output will be sent to autolint_errors.txt

PowerShell

Filename: auto-lint-format-windows.ps1

This script runs the automated linting and formatting in Powershell. If an error occurs while reformatting or linting, the output will be sent to autolint_errors.txt