@eagleoutice/flowr - v2.13.1
    Preparing search index...

    Interface LinterRuleInformation<Config>

    interface LinterRuleInformation<Config extends MergeableRecord = never> {
        activeByDefault?: boolean;
        certainty: LintingRuleCertainty;
        defaultConfig: NoInfer<DeepReadonly<Config>>;
        description: string;
        name: string;
        tags: readonly LintingRuleTag[];
    }

    Type Parameters

    Index

    Properties

    activeByDefault?: boolean

    Whether the rule runs when a linter query does not explicitly list any rules. Defaults to true when omitted. Set to false for noisy or heuristic rules that should only run when requested explicitly (an explicit rule list overrides this flag).

    executeLinterQuery - reads this flag to pick the default rule set

    The linting rule's certainty in terms of the rule's calculations' precision and recall.

    defaultConfig: NoInfer<DeepReadonly<Config>>

    The default config for this linting rule. This config is combined with the user config when executing the rule.

    description: string

    A short description of the linting rule. This is used to display the rule in the UI and to provide a brief overview of what the rule does.

    name: string

    Human-Readable name of the linting rule.

    tags: readonly LintingRuleTag[]

    A short list of tags that describe and categorize the linting rule.