Lint
[lint]
section specifies the configuration for linter like below:
[lint.naming]
case_enum = "snake"
Available configurations
The [lint.naming]
section
This section contains configurations of naming conventions.
Configuration | Value | Description |
---|---|---|
case_enum | case type1 | case style of enum |
case_function | case type1 | case style of function |
case_function_inout | case type1 | case style of inout argument |
case_function_input | case type1 | case style of input argument |
case_function_output | case type1 | case style of output argument |
case_function_ref | case type1 | case style of ref argument |
case_instance | case type1 | case style of instance |
case_interface | case type1 | case style of interface |
case_modport | case type1 | case style of modport |
case_module | case type1 | case style of module |
case_package | case type1 | case style of package |
case_parameter | case type1 | case style of parameter |
case_port_inout | case type1 | case style of inout port |
case_port_input | case type1 | case style of input port |
case_port_modport | case type1 | case style of modport port |
case_port_output | case type1 | case style of output port |
case_reg | case type1 | case style of register type variable2 |
case_struct | case type1 | case style of struct |
case_union | case type1 | case style of union |
case_var | case type1 | case style of variable |
case_wire | case type1 | case style of wire type variable3 |
prefix_enum | string | prefix of enum |
prefix_function | string | prefix of function |
prefix_function_inout | string | prefix of inout argument |
prefix_function_input | string | prefix of input argument |
prefix_function_output | string | prefix of output argument |
prefix_function_ref | string | prefix of ref argument |
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 variable2 |
prefix_struct | string | prefix of struct |
prefix_union | string | prefix of union |
prefix_var | string | prefix of variable |
prefix_wire | string | prefix of wire type variable3 |
suffix_enum | string | suffix of enum |
suffix_function | string | suffix of function |
suffix_function_inout | string | suffix of inout argument |
suffix_function_input | string | suffix of input argument |
suffix_function_output | string | suffix of output argument |
suffix_function_ref | string | suffix of ref argument |
suffix_instance | string | suffix of instance |
suffix_interface | string | suffix of interface |
suffix_modport | string | suffix of modport |
suffix_module | string | suffix of module |
suffix_package | string | suffix of package |
suffix_parameter | string | suffix of parameter |
suffix_port_inout | string | suffix of inout port |
suffix_port_input | string | suffix of input port |
suffix_port_modport | string | suffix of modport port |
suffix_port_output | string | suffix of output port |
suffix_reg | string | suffix of register type variable2 |
suffix_struct | string | suffix of struct |
suffix_union | string | suffix of union |
suffix_var | string | suffix of variable |
suffix_wire | string | suffix of wire type variable3 |
re_forbidden_enum | regex4 | regex forbidden of enum |
re_forbidden_function | regex4 | regex forbidden of function |
re_forbidden_function_inout | regex4 | regex forbidden of inout argument |
re_forbidden_function_input | regex4 | regex forbidden of input argument |
re_forbidden_function_output | regex4 | regex forbidden of output argument |
re_forbidden_function_ref | regex4 | regex forbidden of ref argument |
re_forbidden_instance | regex4 | regex forbidden of instance |
re_forbidden_interface | regex4 | regex forbidden of interface |
re_forbidden_modport | regex4 | regex forbidden of modport |
re_forbidden_module | regex4 | regex forbidden of module |
re_forbidden_package | regex4 | regex forbidden of package |
re_forbidden_parameter | regex4 | regex forbidden of parameter |
re_forbidden_port_inout | regex4 | regex forbidden of inout port |
re_forbidden_port_input | regex4 | regex forbidden of input port |
re_forbidden_port_modport | regex4 | regex forbidden of modport port |
re_forbidden_port_output | regex4 | regex forbidden of output port |
re_forbidden_reg | regex4 | regex forbidden of register type variable2 |
re_forbidden_struct | regex4 | regex forbidden of struct |
re_forbidden_union | regex4 | regex forbidden of union |
re_forbidden_var | regex4 | regex forbidden of variable |
re_forbidden_wire | regex4 | regex forbidden of wire type variable3 |
re_required_enum | regex4 | regex required of enum |
re_required_function | regex4 | regex required of function |
re_required_function_inout | regex4 | regex required of inout argument |
re_required_function_input | regex4 | regex required of input argument |
re_required_function_output | regex4 | regex required of output argument |
re_required_function_ref | regex4 | regex required of ref argument |
re_required_instance | regex4 | regex required of instance |
re_required_interface | regex4 | regex required of interface |
re_required_modport | regex4 | regex required of modport |
re_required_module | regex4 | regex required of module |
re_required_package | regex4 | regex required of package |
re_required_parameter | regex4 | regex required of parameter |
re_required_port_inout | regex4 | regex required of inout port |
re_required_port_input | regex4 | regex required of input port |
re_required_port_modport | regex4 | regex required of modport port |
re_required_port_output | regex4 | regex required of output port |
re_required_reg | regex4 | regex required of register type variable2 |
re_required_struct | regex4 | regex required of struct |
re_required_union | regex4 | regex required of union |
re_required_var | regex4 | regex required of variable |
re_required_wire | regex4 | regex required of wire type variable3 |
1
The available values are
"snake"
– snake_case"screaming_snake"
– SCREAMING_SNAKE_CASE"lower_camel"
– lowerCamelCase"upper_camel"
– UpperCamelCase
4
Regular expression string like ".*"
. The available syntax is here.
2
Register type means that the variable is assigned in always_ff
. It will be mapped to flip-flop in synthesis phase.
3
Wire type means that the variable is assigned in always_comb
. It will be mapped to wire in synthesis phase.