Linter

Lint check is executed at veryl check or veryl build. Alternatively, language server checks lint in real time.

The available configurations are below. These can be specified in [lint] section of Veryl.toml.

[lint.naming]
case_enum = "snake"

The `[lint.naming]` section

This section contains configurations of naming conventions.

Configuration	Value	Description
case_enum	case type¹	case style of `enum`
case_function	case type¹	case style of `function`
case_instance	case type¹	case style of instance
case_interface	case type¹	case style of `interface`
case_modport	case type¹	case style of `modport`
case_module	case type¹	case style of `module`
case_package	case type¹	case style of `package`
case_parameter	case type¹	case style of `parameter`
case_port_inout	case type¹	case style of `inout` port
case_port_input	case type¹	case style of `input` port
case_port_modport	case type¹	case style of `modport` port
case_port_output	case type¹	case style of `output` port
case_reg	case type¹	case style of register type variable²
case_struct	case type¹	case style of `struct`
case_wire	case type¹	case style of wire type variable³
prefix_enum	string	prefix of `enum`
prefix_function	string	prefix of `function`
prefix_instance	string	prefix of instance
prefix_interface	string	prefix of `interface`
prefix_modport	string	prefix of `modport`
prefix_module	string	prefix of `module`
prefix_package	string	prefix of `package`
prefix_parameter	string	prefix of `parameter`
prefix_port_inout	string	prefix of `inout` port
prefix_port_input	string	prefix of `input` port
prefix_port_modport	string	prefix of `modport` port
prefix_port_output	string	prefix of `output` port
prefix_reg	string	prefix of register type variable²
prefix_struct	string	prefix of `struct`
prefix_wire	string	prefix of wire type variable³
re_forbidden_enum	regex⁴	regex forbidden of `enum`
re_forbidden_function	regex⁴	regex forbidden of `function`
re_forbidden_instance	regex⁴	regex forbidden of instance
re_forbidden_interface	regex⁴	regex forbidden of `interface`
re_forbidden_modport	regex⁴	regex forbidden of `modport`
re_forbidden_module	regex⁴	regex forbidden of `module`
re_forbidden_package	regex⁴	regex forbidden of `package`
re_forbidden_parameter	regex⁴	regex forbidden of `parameter`
re_forbidden_port_inout	regex⁴	regex forbidden of `inout` port
re_forbidden_port_input	regex⁴	regex forbidden of `input` port
re_forbidden_port_modport	regex⁴	regex forbidden of `modport` port
re_forbidden_port_output	regex⁴	regex forbidden of `output` port
re_forbidden_reg	regex⁴	regex forbidden of register type variable²
re_forbidden_struct	regex⁴	regex forbidden of `struct`
re_forbidden_wire	regex⁴	regex forbidden of wire type variable³
re_required_enum	regex⁴	regex required of `enum`
re_required_function	regex⁴	regex required of `function`
re_required_instance	regex⁴	regex required of instance
re_required_interface	regex⁴	regex required of `interface`
re_required_modport	regex⁴	regex required of `modport`
re_required_module	regex⁴	regex required of `module`
re_required_package	regex⁴	regex required of `package`
re_required_parameter	regex⁴	regex required of `parameter`
re_required_port_inout	regex⁴	regex required of `inout` port
re_required_port_input	regex⁴	regex required of `input` port
re_required_port_modport	regex⁴	regex required of `modport` port
re_required_port_output	regex⁴	regex required of `output` port
re_required_reg	regex⁴	regex required of register type variable²
re_required_struct	regex⁴	regex required of `struct`
re_required_wire	regex⁴	regex required of wire type variable³

The available values are

"snake" – snake_case
"screaming_snake" – SCREAMING_SNAKE_CASE
"lower_camel" – lowerCamelCase
"upper_camel" – UpperCamelCase

⁴

Regular expression string like ".*". The available syntax is here.

Wire type means that the variable is assigned in always_comb. It will be mapped to wire in synthesis phase.

The Veryl Hardware Description Language

Linter

The [lint.naming] section

The `[lint.naming]` section