Skip to main content

Function: createFilenameRule()

function createFilenameRule(
    definition: {
        configs: readonly (
            | "secretlint.configs.all"
            | "secretlint.configs.configs"
            | "secretlint.configs.configuration"
            | "secretlint.configs.recommended"
            | "secretlint.configs.secretlintOnly"
            | "secretlint.configs.text"
        )[];
        description: string;
        name: string;
        recommended: boolean;
    } & Readonly<{
        allowedPattern: RegExp;
    }>
): RuleModuleWithDocs<"configProblem", []>;

Defined in: _internal/config-rule-factories.ts:191

CreateFilenameRule create filename rule contract.

Parametersโ€‹

definitionโ€‹

{ configs: readonly ( | "secretlint.configs.all" | "secretlint.configs.configs" | "secretlint.configs.configuration" | "secretlint.configs.recommended" | "secretlint.configs.secretlintOnly" | "secretlint.configs.text")[]; description: string; name: string; recommended: boolean; } & Readonly<{ allowedPattern: RegExp; }>

Returnsโ€‹

RuleModuleWithDocs<"configProblem", []>