Skip to content

dependabit / manifest/src / validateConfig

Function: validateConfig()

ts
function validateConfig(data): {
  dependencies?: {
     issues?: {
        aiAgentAssignment?: {
           breaking?: string;
           enabled: boolean;
           major?: string;
           minor?: string;
        };
        assignees: string[];
        bodyTemplate?: string;
        labels: string[];
        titleTemplate: string;
     };
     monitoring?: {
        checkFrequency: "hourly" | "daily" | "weekly" | "monthly";
        enabled: boolean;
        ignoreChanges: boolean;
        severityOverride?: "breaking" | "major" | "minor";
     };
     schedule?: {
        day?:   | "monday"
           | "tuesday"
           | "wednesday"
           | "thursday"
           | "friday"
           | "saturday"
           | "sunday";
        interval: "hourly" | "daily" | "weekly" | "monthly";
        time?: string;
        timezone: string;
     };
     url: string;
  }[];
  ignore?: {
     patterns?: string[];
     types?: (
        | "reference-implementation"
        | "schema"
        | "documentation"
        | "research-paper"
        | "api-example"
       | "other")[];
     urls?: string[];
     useGitExcludes: boolean;
  };
  issues?: {
     aiAgentAssignment?: {
        breaking?: string;
        enabled: boolean;
        major?: string;
        minor?: string;
     };
     assignees: string[];
     bodyTemplate?: string;
     labels: string[];
     titleTemplate: string;
  };
  llm?: {
     maxTokens: number;
     model?: string;
     provider: "github-copilot" | "claude" | "openai" | "azure-openai";
     temperature: number;
  };
  monitoring?: {
     autoUpdate: boolean;
     enabled: boolean;
     falsePositiveThreshold: number;
  };
  schedule: {
     day?:   | "monday"
        | "tuesday"
        | "wednesday"
        | "thursday"
        | "friday"
        | "saturday"
        | "sunday";
     interval: "hourly" | "daily" | "weekly" | "monthly";
     time?: string;
     timezone: string;
  };
  version: "1";
};

Defined in: packages/manifest/src/validator.ts:71

Validate a dependabit configuration

Parameters

ParameterType
dataunknown

Returns

ts
{
  dependencies?: {
     issues?: {
        aiAgentAssignment?: {
           breaking?: string;
           enabled: boolean;
           major?: string;
           minor?: string;
        };
        assignees: string[];
        bodyTemplate?: string;
        labels: string[];
        titleTemplate: string;
     };
     monitoring?: {
        checkFrequency: "hourly" | "daily" | "weekly" | "monthly";
        enabled: boolean;
        ignoreChanges: boolean;
        severityOverride?: "breaking" | "major" | "minor";
     };
     schedule?: {
        day?:   | "monday"
           | "tuesday"
           | "wednesday"
           | "thursday"
           | "friday"
           | "saturday"
           | "sunday";
        interval: "hourly" | "daily" | "weekly" | "monthly";
        time?: string;
        timezone: string;
     };
     url: string;
  }[];
  ignore?: {
     patterns?: string[];
     types?: (
        | "reference-implementation"
        | "schema"
        | "documentation"
        | "research-paper"
        | "api-example"
       | "other")[];
     urls?: string[];
     useGitExcludes: boolean;
  };
  issues?: {
     aiAgentAssignment?: {
        breaking?: string;
        enabled: boolean;
        major?: string;
        minor?: string;
     };
     assignees: string[];
     bodyTemplate?: string;
     labels: string[];
     titleTemplate: string;
  };
  llm?: {
     maxTokens: number;
     model?: string;
     provider: "github-copilot" | "claude" | "openai" | "azure-openai";
     temperature: number;
  };
  monitoring?: {
     autoUpdate: boolean;
     enabled: boolean;
     falsePositiveThreshold: number;
  };
  schedule: {
     day?:   | "monday"
        | "tuesday"
        | "wednesday"
        | "thursday"
        | "friday"
        | "saturday"
        | "sunday";
     interval: "hourly" | "daily" | "weekly" | "monthly";
     time?: string;
     timezone: string;
  };
  version: "1";
}
NameTypeDefined in
dependencies?{ issues?: { aiAgentAssignment?: { breaking?: string; enabled: boolean; major?: string; minor?: string; }; assignees: string[]; bodyTemplate?: string; labels: string[]; titleTemplate: string; }; monitoring?: { checkFrequency: "hourly" | "daily" | "weekly" | "monthly"; enabled: boolean; ignoreChanges: boolean; severityOverride?: "breaking" | "major" | "minor"; }; schedule?: { day?: | "monday" | "tuesday" | "wednesday" | "thursday" | "friday" | "saturday" | "sunday"; interval: "hourly" | "daily" | "weekly" | "monthly"; time?: string; timezone: string; }; url: string; }[]packages/manifest/src/schema.ts:236
ignore?{ patterns?: string[]; types?: ( | "reference-implementation" | "schema" | "documentation" | "research-paper" | "api-example" | "other")[]; urls?: string[]; useGitExcludes: boolean; }packages/manifest/src/schema.ts:239
ignore.patterns?string[]packages/manifest/src/schema.ts:243
ignore.types?( | "reference-implementation" | "schema" | "documentation" | "research-paper" | "api-example" | "other")[]packages/manifest/src/schema.ts:242
ignore.urls?string[]packages/manifest/src/schema.ts:241
ignore.useGitExcludesbooleanpackages/manifest/src/schema.ts:244
issues?{ aiAgentAssignment?: { breaking?: string; enabled: boolean; major?: string; minor?: string; }; assignees: string[]; bodyTemplate?: string; labels: string[]; titleTemplate: string; }packages/manifest/src/schema.ts:224
issues.aiAgentAssignment?{ breaking?: string; enabled: boolean; major?: string; minor?: string; }packages/manifest/src/schema.ts:184
issues.aiAgentAssignment.breaking?stringpackages/manifest/src/schema.ts:187
issues.aiAgentAssignment.enabledbooleanpackages/manifest/src/schema.ts:186
issues.aiAgentAssignment.major?stringpackages/manifest/src/schema.ts:188
issues.aiAgentAssignment.minor?stringpackages/manifest/src/schema.ts:189
issues.assigneesstring[]packages/manifest/src/schema.ts:183
issues.bodyTemplate?stringpackages/manifest/src/schema.ts:193
issues.labelsstring[]packages/manifest/src/schema.ts:182
issues.titleTemplatestringpackages/manifest/src/schema.ts:192
llm?{ maxTokens: number; model?: string; provider: "github-copilot" | "claude" | "openai" | "azure-openai"; temperature: number; }packages/manifest/src/schema.ts:222
llm.maxTokensnumberpackages/manifest/src/schema.ts:176
llm.model?stringpackages/manifest/src/schema.ts:175
llm.provider"github-copilot" | "claude" | "openai" | "azure-openai"packages/manifest/src/schema.ts:172
llm.temperaturenumberpackages/manifest/src/schema.ts:177
monitoring?{ autoUpdate: boolean; enabled: boolean; falsePositiveThreshold: number; }packages/manifest/src/schema.ts:227
monitoring.autoUpdatebooleanpackages/manifest/src/schema.ts:230
monitoring.enabledbooleanpackages/manifest/src/schema.ts:229
monitoring.falsePositiveThresholdnumberpackages/manifest/src/schema.ts:231
schedule{ day?: | "monday" | "tuesday" | "wednesday" | "thursday" | "friday" | "saturday" | "sunday"; interval: "hourly" | "daily" | "weekly" | "monthly"; time?: string; timezone: string; }packages/manifest/src/schema.ts:223
schedule.day?| "monday" | "tuesday" | "wednesday" | "thursday" | "friday" | "saturday" | "sunday"packages/manifest/src/schema.ts:160
schedule.interval"hourly" | "daily" | "weekly" | "monthly"packages/manifest/src/schema.ts:159
schedule.time?stringpackages/manifest/src/schema.ts:163
schedule.timezonestringpackages/manifest/src/schema.ts:167
version"1"packages/manifest/src/schema.ts:219

Throws

if validation fails

Released under the MIT License.