Skip to main content

eslint-plugin-copilot Documentation / _internal/create-copilot-rule / createCopilotRule

Function: createCopilotRule()

function createCopilotRule<Options, MessageIds>(
    ruleDefinition: Readonly<
        RuleWithMetaAndName<
            Options,
            MessageIds,
            Readonly<{
                copilotConfigs:
                    | "copilot.configs.all"
                    | "copilot.configs.minimal"
                    | "copilot.configs.recommended"
                    | "copilot.configs.strict"
                    | readonly (
                          | "copilot.configs.all"
                          | "copilot.configs.minimal"
                          | "copilot.configs.recommended"
                          | "copilot.configs.strict"
                      )[];
                description: string;
                frozen: boolean;
                recommended: boolean;
                requiresTypeChecking: boolean;
            }>
        >
    >
): CopilotRuleModule;

Defined in: _internal/create-copilot-rule.ts:99

Shared rule creator that injects canonical docs URLs and stable catalog ids.

Type Parameters​

Type Parameter
Options extends readonly unknown[]
MessageIds extends string

Parameters​

| Parameter | Type | | ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- | --------------------------- | ------------------------------- | -------------------------- | ---------- | ----------------------- | --------------------------- | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | | ruleDefinition | Readonly<RuleWithMetaAndName<Options, MessageIds, Readonly<{ copilotConfigs: | "copilot.configs.all" | "copilot.configs.minimal" | "copilot.configs.recommended" | "copilot.configs.strict" | readonly ( | "copilot.configs.all" | "copilot.configs.minimal" | "copilot.configs.recommended" | "copilot.configs.strict")[]; description: string; frozen: boolean; recommended: boolean; requiresTypeChecking: boolean; }>>> |

Returns​

CopilotRuleModule