dznlint

A linter helping you write correct and consistent Dezyne code.

Requires Node.js to run.

Installation

$ npm install -D dznlint

Usage

npx dznlint <options> [...files]

For help on the different options, see:

npx dznlint --help

Configuration

By default, dznlint will look for the file dznlint.config.json in its working directory. You can also specify which config file to use by providing the --config-file CLI argument. This json file should contain a subset of the available configuration values.

For example:

{
    "implicit_illegal": "warning", // Do not allow explicit illegals
    "naming_convention": {
        "component": "[A-Z][a-zA-Z0-9]*", // Set naming convention for component
        "interface": "I[A-Z][a-zA-Z0-9]*" // Set naming convention for interface
    },
    "no_shadowing": "warning" // Set shadowing rule violations to 'warning' severity
}

Available rules:

Default values are indicated in bold.

call_arguments_must_match

Arguments passed to a function call must match the parameters of that function or event.

Possible values: "hint" | "warning" | "error"

dead_code

No code allowed after return statements in functions.

Possible values: "hint" | "warning" | "error"

format

Dznlint formatting options, will be used when supplying cli with the --format or --f flag to format files instead of linting.

Default formatting settings are:

{
    "format": {
        "indent": ["spaces", 4], // ["spaces" | "tabs", indent width] - indentation
        "braces": "next-line", // "next-line" | "same-line" - where to put opening braces
        "indent_components_interfaces": true, // indent component/interface root
        "target_width": 80 // width of the file after which formatter might insert extra newlines
    }
}

implicit_illegal

Do not mark events explicitly illegal. As of Dezyne 2.14, events not mentioned are implicitly assumed to be illegal.

Possible values: "hint" | "warning" | "error"

inline_temporary_variables

Temporary variables that are only referred to once should be inlined.

Possible values: "hint" | "warning" | "error"

naming_convention

Naming convention for various different variables.

Default value:

{
    "component": "[A-Z][a-zA-Z0-9]*",
    "enum": "[A-Z][a-zA-Z0-9]*",
    "enum_member": "[A-Z][a-zA-Z0-9]*",
    "interface": "I[A-Z][a-zA-Z0-9]*",
    "local": "[a-z_][a-zA-Z0-9]*",
    "type": "[A-Z][a-zA-Z0-9]*"
}

never_fired_event

If an out event in an interface is never fired it is not useful, and often indicates the programmer forgot something.

Possible values: "hint" | "warning" | "error"

never_legal_event

If an in event in an interface is always illegal it is not useful, and often indicates the programmer forgot something.

Possible values: "hint" | "warning" | "error"

no_bool_out_parameters

Out parameters of type bool are not allowed by Dezyne and will lead to a well-formedness error.

Possible values: "hint" | "warning" | "error"

no_duplicate_parameters

Parameters should have distinct names.

Possible values: "hint" | "warning" | "error"

no_duplicate_port_binding

Ports cannot be bound more than once.

Possible values: "hint" | "warning" | "error"

no_empty_defer_capture

Defer statements should capture one or more state variables to prevent unexpected verification time explosion due to the defer queue unexpectedly growing.

Possible values: "hint" | "warning" | "error"

no_recursive_system

Systems cannot contain instances of themself.

Possible values: "hint" | "warning" | "error"

no_shadowing

Parameters and variables should not shadow (re-define) variables that already exist in scope.

Possible values: "hint" | "warning" | "error"

no_unconnected_ports

All ports in a system should be connected for the system to be valid.

Possible values: "hint" | "warning" | "error"

no_unknown_imports

Imported dzn files should be resolvable by dznlint. This check might fail if the include directories are not properly set. If this check fails other linting rules might also fail, since they rely on type information.

Possible values: "hint" | "warning" | "error"

no_unknown_variables

All referenced variables, members and types should be known.

Possible values: "hint" | "warning" | "error"

no_unknown_port_binding

Bindings cannot bind to unknown ports.

Possible values: "hint" | "warning" | "error"

no_unused_instances

Defined instances should be used in at least one binding.

Possible values: "hint" | "warning" | "error"

no_unused_parameters

Parameters should be referenced at least once, or escaped by prefixing (or replacing with) _.

Possible values: "hint" | "warning"| "error"

no_unused_ports

Pports should be referenced at least once.

Possible values: "hint" | "warning"| "error"

no_unused_variables

Defined variables should be referenced at least once.

Possible values: "hint" | "warning" | "error"

on_parameters_must_match

Parameters in an on trigger must match the number of parameters specified by the triggering event.

Possible values: "hint" | "warning" | "error"

parameter_direction

Parameter direction (in/out/inout) should always be specified.

Possible values: "hint" | "warning" | "error"

port_missing_redundant_blocking

As of Dezyne 2.15, a provided port should be marked blocking if any of its calls is implemented using the blocking keyword. On the other hand, if no blocking is used in the behavior for this port, it should not be marked as blocking.

Possible values: "hint" | "warning" | "error" (Default: disabled for backwards compatibility)