Skip to main content

Type Alias: GithubActionsRuleDocs

type GithubActionsRuleDocs = Rule.RuleMetaData["docs"] & {
    configs?:
        | GithubActionsConfigReference
        | readonly GithubActionsConfigReference[];
    recommended: boolean;
    requiresTypeChecking: boolean;
    ruleId: `R${number}`;
    ruleNumber: number;
    url: string;
};

Defined in: _internal/rule-docs.ts:10

Custom docs metadata stored alongside each ESLint rule definition.

Type Declarationโ€‹

configs?โ€‹

readonly optional configs?:
  | GithubActionsConfigReference
  | readonly GithubActionsConfigReference[];
readonly recommended: boolean;

requiresTypeCheckingโ€‹

readonly requiresTypeChecking: boolean;

ruleIdโ€‹

readonly ruleId: `R${number}`;

ruleNumberโ€‹

readonly ruleNumber: number;

urlโ€‹

readonly url: string;