Linting

Basic Usage

# To run analysis only for a script.
talos lint [options...] [script]

# Run linting before executing scripts.
talos run --lint [script]

The linter enables additional diagnostic checks

Common Options

--quiet

Disables all verbose linting diagnostics.

--hints

Enables hint-based diagnostics. These includes type-checking and linting diagnostics that are declared with either a hint or info type.

--config (Unimplemented)

Specifies the input configuration to be used for linting. This allows overriding the crate manifest associated with the given scripts. By default, any script that is linted will use it's upward parent crate manifest lint option.

Configuration Options

The lint property within crate files allow specifing which diagnostics and their severities to be applied when linting. It includes the following properties:

recommended

Enables or disables the recommended linting rules.

rules

Any available rules can be have their diagnostic severity altered through this property. This allows customizing the resulting rules that are applied and how they are applied. For example:

{
    // ...

    "lint": {
        "rules": {
            // setting a linter rule to "none" disables to rule
            "talos/no-unsafe-assignments": "none",

            // rules can be forcibly set to "error", effectively forcing their compilance
            "talos/no-unsafe-calls": "error",

            // rules can also be made to just show hints/information within editors or through the "--hints" flag
            "talos/no-unsafe-returns": "hint",
        },
    },
}

plugins (Unimplemented)

Althrough Talos ships within many linting rules out-of-the-box, this property allows specifying custom linting plugins.