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

    Interface LinterRuleInformation<Config>

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

    Type Parameters

    Index

    Properties

    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.