Interface EnforceRule

A rule delegated to an external tool (linter, ast-grep, dependency-cruiser, etc.) or to a vigiles-internal check.

interface EnforceRule {
    _kind: "enforce";
    details?: RuleDetails;
    linterRule: LinterRule | `vigiles/${string}`;
    render?: RuleRender;
    verify: boolean;
    why: string;
}

Index

Properties

_kind details? linterRule render? verify why

Properties

`Readonly`_kind

_kind: "enforce"

`Optional` `Readonly`details

details?: RuleDetails

Where the long text lives; rendered as a verified link.

`Readonly`linterRule

linterRule: LinterRule | `vigiles/${string}`

`Optional` `Readonly`render

render?: RuleRender

How much of the rule the compiled file carries. Default "full".

`Readonly`verify

verify: boolean

Skip verification for this rule. Default: true (verify).

`Readonly`why

why: string