@deltabox/toolchain 2.1.1 → 2.3.2

package/dist/packages/shared/src/config-schema/changelog.js

@@ -1 +1 @@
-import"node:path";import"node:url";import.meta.url;import{section as e,withEnabled as t}from"./meta.js";import{workflowOptionsSchema as n}from"./workflow.js";import{z as r}from"zod";const i=r.object({main:r.union([r.string(),r.array(r.string())]).describe('Branch glob(s) the CI + release workflows run on, and the release PR base (default `["main"]`).').optional(),dev:r.union([r.string(),r.array(r.string())]).describe("Branch glob(s) the changelog/version workflow runs on. No default: when omitted it reuses `main` (so a single-branch repo needs no `dev`).").optional()}).describe(`Branches the generated workflows target.`).meta({id:`ChangelogBranchesConfig`}),a=t(r.object({dir:r.string().describe("Directory the generated `commitlint.config.mjs` is written to (default: the project root). The husky hook and CI use `--config` to point at it.").optional(),types:r.array(r.string()).describe(`Allowed commit types (commitlint).`).optional(),scopes:r.array(r.string()).describe(`Allowed commit scopes (commitlint).`).optional()}),`Enable commitlint (default true when the changelog is enabled). Set false to generate changelogs without the Conventional-Commits pipeline.`).describe(`commitlint config, output location and allow-lists.`).meta({id:`ChangelogCommitlintConfig`}),o=r.enum([`uniform`,`root-only`,`individual`]).describe(`Where the changelog version bump is applied.`).meta({id:`ChangelogVersioningTarget`}),s=r.object({target:o.describe("`uniform` bumps the root and every workspace to one shared version; `root-only` bumps the root only; `individual` bumps each changed workspace independently (default `uniform`).").optional(),workspaces:r.array(r.string()).describe("Glob patterns selecting the workspaces to version (relative to the root). Defaults to the root `package.json` `workspaces` field; when there is none the root `package.json` is used on its own.").optional(),bump:r.record(r.string(),r.unknown()).describe(`Custom bump rules for major/minor/patch (matchers or callbacks).`).optional(),allowOverBump:r.boolean().describe(`Apply a bump once per matching change instead of once per run (default false).`).optional(),commit:r.unknown().describe(`Commit message formatting/credit options or callback.`).optional(),provider:r.unknown().describe("`default`, `changesets`, a provider id, or a custom provider/callback.").optional()}).describe(`Automatic version bumping options.`).meta({id:`ChangelogVersioningConfig`}),c=r.union([r.boolean(),s]).describe(`Automatic version bumping when a changelog entry is generated.`).meta({id:`ChangelogVersioning`}),l={commitlint:e(a).describe("commitlint config; set `false` to disable the Conventional-Commits pipeline.").optional(),versioning:c.describe("Automatic version bumping on changelog generation (default `true`).").optional(),vscode:r.boolean().describe(`Write the Conventional-Commits VS Code settings (default true).`).optional(),groups:r.unknown().describe("Conventional-Commits group order/titles: an ordered array of CC types or `{ type, title, order, hidden }`, a type->title/options record, or a callback. Titles/order/hidden also accept callbacks (TS/JS configs only).").optional(),breaking:r.unknown().describe("How breaking changes are detected: `conventional` (default: a `!` in the CC subject or a `BREAKING CHANGE:` footer), `any` (legacy loose match), `false` (disable), `{ pattern }` / `{ match }`, or a callback (TS/JS configs only).").optional()},u=t(n.extend({branches:i.describe(`Branches the generated workflows target.`).optional(),...l}),`Enable/disable the changelog workflow and pipeline (default: enabled when present).`).describe(`Changelog workflow + pipeline: versioning, VS Code settings and commitlint.`).meta({id:`ChangelogConfig`}),d=r.union([r.boolean(),r.string(),u]).describe("`true`/`false` to enable/disable, the changelog pipeline config object, or a raw YAML string written verbatim as the changelog workflow file.").meta({id:`ChangelogWorkflowSetting`}),f=t(r.object(l)).describe("Manual `toolchain.changelog` pipeline config for `dbx changelog`, the VS Code actions and the API; `ci.changelog` inherits these options.").meta({id:`ToolchainChangelogConfig`});export{i as changelogBranchesConfigSchema,a as changelogCommitlintConfigSchema,u as changelogConfigSchema,s as changelogVersioningConfigSchema,c as changelogVersioningSchema,o as changelogVersioningTargetSchema,d as changelogWorkflowSettingSchema,f as legacyChangelogConfigSchema};
+import"node:path";import"node:url";import.meta.url;import{externalConfigSchema as e}from"./external.js";import{section as t,withEnabled as n}from"./meta.js";import{azureWorkflowSettingSchema as r,githubWorkflowSettingSchema as i,gitlabWorkflowSettingSchema as a,workflowOptionsSchema as o}from"./workflow.js";import{z as s}from"zod";const c=s.object({main:s.union([s.string(),s.array(s.string())]).describe('Branch glob(s) the CI + release workflows run on, and the release PR base (default `["main"]`).').optional(),dev:s.union([s.string(),s.array(s.string())]).describe("Branch glob(s) the changelog/version workflow runs on. No default: when omitted it reuses `main` (so a single-branch repo needs no `dev`).").optional()}).describe(`Branches the generated workflows target.`).meta({id:`ChangelogBranchesConfig`}),l=n(s.object({dir:s.string().describe("Directory the generated `commitlint.config.mjs` is written to (default: the project root). The husky hook and CI use `--config` to point at it.").optional(),types:s.array(s.string()).describe(`Allowed commit types (commitlint).`).optional(),scopes:s.array(s.string()).describe(`Allowed commit scopes (commitlint).`).optional()}),`Enable commitlint (default true when the changelog is enabled). Set false to generate changelogs without the Conventional-Commits pipeline.`).describe(`commitlint config, output location and allow-lists.`).meta({id:`ChangelogCommitlintConfig`}),u=s.enum([`uniform`,`root-only`,`individual`]).describe(`Where the changelog version bump is applied.`).meta({id:`ChangelogVersioningTarget`}),d=s.object({hash:s.string().describe(`The full commit hash.`),subject:s.string().describe(`The commit subject line.`),body:s.string().describe(`The commit body (including any footers).`),author:s.string().describe(`The commit author name.`),authorEmail:s.string().describe(`The commit author email.`)}),f=s.object({name:s.string().describe(`The author display name.`),url:s.string().describe(`The author profile URL.`).optional()}),p=s.object({number:s.number().describe(`The issue number.`),title:s.string().describe(`The issue title.`).optional(),url:s.string().describe(`The issue URL.`).optional()}),m={author:s.boolean().describe("Include the `by <author>` credit (default true).").optional(),commitSha:s.boolean().describe(`Include the commit hash link (default true).`).optional(),issues:s.boolean().describe(`Include issue/fixes links (default true).`).optional(),authorAvatar:s.boolean().describe(`Prefix the author with their GitHub avatar (default false).`).optional()},h=s.object({commit:d,repo:s.string().describe("The GitHub `owner/repo` slug.").optional(),author:f,issues:s.array(p),options:s.object(m)}),g=s.function({input:[h],output:s.string()}).describe(`Fully custom commit line formatter (TS/JS configs only; return the bullet body).`).meta({tsType:`((ctx: ChangelogCommitFormatContext) => string)`}),_=s.object({...m,format:g.optional()}).describe(`Commit message formatting/credit options.`).meta({id:`ChangelogCommitFormatConfig`}),v=s.object({cwd:s.string().describe(`The repository root.`),changelog:e(`The resolved changelog config.`,`ChangelogConfig`).optional(),records:s.array(d).describe(`The commits in the scanned range.`)}),y=s.function({input:[v],output:s.union([s.string(),s.void()])}).describe(`A custom provider callback returning the changelog body (TS/JS configs only).`).meta({tsType:`((ctx: ChangelogProviderContext) => string | void)`}),b=s.object({id:s.string().describe(`The provider id.`),run:y}).describe(`A custom changelog provider object.`).meta({id:`ChangelogProviderConfig`}),x=s.union([s.string(),b,y]).describe("`default`, `changesets`, a provider id, a custom provider object, or a callback (TS/JS configs only)."),S=s.object({env:s.record(s.string(),s.string()).describe(`The process environment.`),logger:s.any().describe(`The toolchain logger (runtime-only).`),packageJson:e(`The package.json content.`,`PackageJson`).optional(),breaking:s.boolean().or(s.enum([`conventional`,`any`])).describe(`How breaking changes are detected.`).optional(),commit:d,level:s.enum([`major`,`minor`,`patch`]).describe(`The bump level being evaluated.`)}),C=s.function({input:[S],output:s.union([s.boolean(),s.enum([`major`,`minor`,`patch`])])}).describe(`A custom bump matcher (TS/JS configs only).`).meta({tsType:`((ctx: ChangelogBumpRuleCallbackContext) => boolean | "major" | "minor" | "patch")`}),w=s.object({breaking:s.boolean().describe(`Match only commits whose breaking state equals this value.`).optional(),type:s.string().describe(`Match this Conventional-Commits type.`).optional(),types:s.array(s.string()).describe(`Match any of these CC types.`).optional(),scope:s.string().describe(`Match this Conventional-Commits scope.`).optional(),scopes:s.array(s.string()).describe(`Match any of these CC scopes.`).optional(),pattern:s.string().describe(`Match this regular expression.`).optional(),match:s.string().describe(`Match this substring.`).optional()}).describe(`A declarative bump matcher.`).meta({id:`ChangelogBumpRuleMatch`}),T=s.union([s.boolean(),s.string(),w,C]),E=s.union([T,s.array(T)]).describe(`A bump rule: a matcher/callback or a list of matchers/callbacks.`).meta({id:`ChangelogBumpRule`}),D=s.object({target:u.describe("`uniform` bumps the root and every workspace to one shared version; `root-only` bumps the root only; `individual` bumps each changed workspace independently (default `uniform`).").optional(),workspaces:s.array(s.string()).describe("Glob patterns selecting the workspaces to version (relative to the root). Defaults to the root `package.json` `workspaces` field; when there is none the root `package.json` is used on its own.").optional(),bump:s.object({major:E.optional(),minor:E.optional(),patch:E.optional()}).describe(`Custom bump rules for major/minor/patch (matchers or callbacks).`).optional(),allowOverBump:s.boolean().describe(`Apply a bump once per matching change instead of once per run (default false).`).optional(),commit:_.describe(`Commit message formatting/credit options (with an optional formatter callback).`).optional(),provider:x.describe("`default`, `changesets`, a provider id, or a custom provider/callback.").optional()}).describe(`Automatic version bumping options.`).meta({id:`ChangelogVersioningConfig`}),O=s.union([s.boolean(),D]).describe(`Automatic version bumping when a changelog entry is generated.`).meta({id:`ChangelogVersioning`}),k=s.object({parsed:s.object({type:s.string(),scope:s.string().optional(),breaking:s.boolean(),rest:s.string()}),text:s.string(),bodyParagraphs:s.array(s.array(s.string()))}),A=s.object({types:s.array(s.string()).describe(`The CC types present in the current changelog.`),items:s.array(k).describe(`Every item being grouped.`)}),j=A.extend({type:s.string().describe(`The CC type of this group.`),defaultTitle:s.string().describe(`The built-in title for this type.`),index:s.number().describe(`The group position in the configured/default order.`),groupItems:s.array(k).describe(`The items in this group.`)}),M=s.function({input:[j],output:s.string()}).describe(`A custom group title callback (TS/JS configs only).`).meta({tsType:`((ctx: ChangelogGroupContext) => string)`}),N=s.function({input:[j],output:s.number()}).describe(`A custom group order callback (TS/JS configs only).`).meta({tsType:`((ctx: ChangelogGroupContext) => number)`}),P=s.function({input:[j],output:s.boolean()}).describe(`A custom group hidden callback (TS/JS configs only).`).meta({tsType:`((ctx: ChangelogGroupContext) => boolean)`}),F=s.object({type:s.string().describe(`The CC type (required for object entries in an array).`).optional(),title:s.union([s.string(),M]).describe(`Custom heading title (or callback; TS/JS configs only).`).optional(),order:s.union([s.number(),N]).describe(`Sort position; lower comes first (or callback; TS/JS configs only).`).optional(),hidden:s.union([s.boolean(),P]).describe(`Omit this group from the rendered changelog (or callback; TS/JS only).`).optional()}).describe(`One Conventional-Commits group.`),I=s.array(s.union([s.string(),F])),L=s.record(s.string(),s.union([s.string(),F,s.boolean()])),R=s.function({input:[A],output:s.union([I,L])}).describe(`A custom group builder (TS/JS configs only).`).meta({tsType:`((ctx: ChangelogGroupsContext) => ChangelogGroupsSetting)`}),z=s.union([I,L,R]).describe("Conventional-Commits group order/titles: an ordered array of CC types or `{ type, title, order, hidden }`, a type->title/options record, or a callback (TS/JS configs only)."),B=s.object({pattern:s.string().describe(`A regular expression matched against the subject and body.`).optional(),match:s.string().describe(`A substring matched against the subject and body.`).optional()}),V=s.function({input:[s.object({subject:s.string().describe(`The Conventional-Commits subject.`),body:s.string().describe(`The commit body (including any footers).`)})],output:s.boolean()}).describe(`A custom breaking-change predicate (TS/JS configs only).`).meta({tsType:`((commit: ChangelogBreakingCommit) => boolean)`}),H=s.union([s.boolean(),s.enum([`conventional`,`any`]),B,V]).describe("How breaking changes are detected: `conventional` (default: a `!` in the CC subject or a `BREAKING CHANGE:` footer), `any` (legacy loose match), `false` (disable), `{ pattern }` / `{ match }`, or a callback (TS/JS configs only)."),U={commitlint:t(l).describe("commitlint config; set `false` to disable the Conventional-Commits pipeline.").optional(),versioning:O.describe("Automatic version bumping on changelog generation (default `true`).").optional(),vscode:s.boolean().describe(`Write the Conventional-Commits VS Code settings (default true).`).optional(),groups:z.optional(),breaking:H.optional()},W=n(o.extend({branches:c.describe(`Branches the generated workflows target.`).optional(),...U}),`Enable/disable the changelog workflow and pipeline (default: enabled when present).`).describe(`Changelog workflow + pipeline: versioning, VS Code settings and commitlint.`).meta({id:`CiChangelogConfig`}),G=s.union([s.boolean(),s.string(),i,a,r,W]).describe("`true`/`false` to enable/disable, a complete GitHub/GitLab/Azure workflow (with `provider`), the changelog pipeline config object, or a raw YAML string written verbatim as the changelog workflow file.").meta({id:`ChangelogWorkflowSetting`}),K=n(s.object(U)).describe("Manual `toolchain.changelog` pipeline config for `dbx changelog`, the VS Code actions and the API; `ci.changelog` inherits these options.").meta({id:`ChangelogConfig`});export{c as changelogBranchesConfigSchema,V as changelogBreakingCallbackSchema,H as changelogBreakingSettingSchema,w as changelogBumpRuleMatchSchema,E as changelogBumpRuleSchema,_ as changelogCommitFormatConfigSchema,l as changelogCommitlintConfigSchema,K as changelogConfigSchema,F as changelogGroupConfigSchema,z as changelogGroupsSettingSchema,b as changelogProviderConfigSchema,x as changelogProviderSettingSchema,D as changelogVersioningConfigSchema,O as changelogVersioningSchema,u as changelogVersioningTargetSchema,G as changelogWorkflowSettingSchema,W as ciChangelogConfigSchema};