dependabit / manifest/src / stringifyConfig

Function: stringifyConfig()

function stringifyConfig(config): string;

Defined in: packages/manifest/src/config.ts:63

Serialises a validated DependabitConfig to a YAML string.

Parameters

Parameter	Type	Description
config	{ 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"; }	The config to serialise.
config.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; }[]	-
config.ignore?	{ patterns?: string[]; types?: ( | "reference-implementation" | "schema" | "documentation" | "research-paper" | "api-example" | "other")[]; urls?: string[]; useGitExcludes: boolean; }	-
config.ignore.patterns?	string[]	-
config.ignore.types?	( | "reference-implementation" | "schema" | "documentation" | "research-paper" | "api-example" | "other")[]	-
config.ignore.urls?	string[]	-
config.ignore.useGitExcludes	boolean	-
config.issues?	{ aiAgentAssignment?: { breaking?: string; enabled: boolean; major?: string; minor?: string; }; assignees: string[]; bodyTemplate?: string; labels: string[]; titleTemplate: string; }	-
config.issues.aiAgentAssignment?	{ breaking?: string; enabled: boolean; major?: string; minor?: string; }	-
config.issues.aiAgentAssignment.breaking?	string	-
config.issues.aiAgentAssignment.enabled	boolean	-
config.issues.aiAgentAssignment.major?	string	-
config.issues.aiAgentAssignment.minor?	string	-
config.issues.assignees	string[]	-
config.issues.bodyTemplate?	string	-
config.issues.labels	string[]	-
config.issues.titleTemplate	string	-
config.llm?	{ maxTokens: number; model?: string; provider: "github-copilot" | "claude" | "openai" | "azure-openai"; temperature: number; }	-
config.llm.maxTokens	number	-
config.llm.model?	string	-
config.llm.provider	"github-copilot" | "claude" | "openai" | "azure-openai"	-
config.llm.temperature	number	-
config.monitoring?	{ autoUpdate: boolean; enabled: boolean; falsePositiveThreshold: number; }	-
config.monitoring.autoUpdate	boolean	-
config.monitoring.enabled	boolean	-
config.monitoring.falsePositiveThreshold	number	-
config.schedule	{ day?: | "monday" | "tuesday" | "wednesday" | "thursday" | "friday" | "saturday" | "sunday"; interval: "hourly" | "daily" | "weekly" | "monthly"; time?: string; timezone: string; }	-
config.schedule.day?	| "monday" | "tuesday" | "wednesday" | "thursday" | "friday" | "saturday" | "sunday"	-
config.schedule.interval	"hourly" | "daily" | "weekly" | "monthly"	-
config.schedule.time?	string	-
config.schedule.timezone	string	-
config.version	"1"	-

Returns

string

YAML string representation.

Throws

If config fails schema validation before serialisation.

Pitfalls

• YAML comments present in the original file are not preserved; this function always produces comment-free YAML.