@deltabox/toolchain 1.11.3 → 2.0.0

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

@@ -1 +0,0 @@
-import"node:path";import"node:url";import.meta.url;import{z as e}from"zod";const t=e.enum([`monorepo-root`,`monorepo-workspace`,`project`]).describe(`The project kind (detected when omitted).`).meta({id:`ProjectType`}),n=e.object({type:t.optional(),name:e.string().describe("The unscoped project name (written as `<scope>/<name>`).").optional(),scope:e.string().describe("The npm scope, eg. `@acme`.").optional(),author:e.string().describe("Package author (`package.json` `author`).").optional(),license:e.string().describe("SPDX license id (`package.json` `license`).").optional(),homepage:e.string().describe("Project homepage (`package.json` `homepage`).").optional(),repo:e.string().describe("Repository URL (`package.json` `repository`). For a workspace it also resolves to the workspace path (`repository.directory`).").optional(),nodeVersion:e.string().describe("Node version for CI/templates, eg. `22` (not `package.json` `engines`).").optional(),packageManager:e.string().describe("Package manager name, written as `<name>@<version>` (default `yarn`).").optional(),packageManagerVersion:e.string().describe("Package manager version, eg. `4.17.1`.").optional(),description:e.string().describe("One-line description (`package.json` `description`).").optional(),inherit:e.boolean().describe(`Inherit the parent project metadata (default true). Set false to keep this project entirely independent of the root config.`).optional()}).meta({id:`ToolchainProjectConfig`}),r=e.object({name:e.string().describe(`Step display name.`).optional(),id:e.string().describe("Step id (for `steps.<id>` outputs).").optional(),if:e.string().describe("Conditional expression (`if:`).").optional(),uses:e.string().describe("Action to run (`uses:`), eg. `actions/checkout@v4`.").optional(),run:e.string().describe("Shell command(s) to run (`run:`).").optional(),shell:e.string().describe("Shell to run `run` in, eg. `bash`.").optional(),"working-directory":e.string().describe(`Directory the step runs in.`).optional(),with:e.record(e.string(),e.union([e.string(),e.number(),e.boolean()])).describe("Inputs for a `uses` action.").optional(),env:e.record(e.string(),e.string()).describe(`Environment variables for the step.`).optional()}).meta({id:`WorkflowStep`}),i=e.object({job:e.string().describe(`Target job id (defaults to the primary/first job).`).optional(),before:e.array(r).describe(`Steps inserted at the start.`).optional(),after:e.array(r).describe(`Steps appended at the end.`).optional()}).meta({id:`WorkflowStepsConfig`}),a=e.object({enabled:e.boolean().describe(`Enable/disable this workflow (default true).`).optional(),pushBranches:e.array(e.string()).describe("Replace `on.push.branches`.").optional(),pullRequestBranches:e.array(e.string()).describe("Replace `on.pull_request.branches`.").optional(),triggers:e.record(e.string(),e.unknown()).describe("Extra `on.*` triggers.").optional(),extra:e.record(e.string(),e.unknown()).describe("Extra top-level keys (`permissions`, `concurrency`, `env`, ...).").optional(),steps:e.union([i,e.array(i)]).describe(`Extra steps for a job (one group, or per-job groups).`).optional(),jobs:e.record(e.string(),e.unknown()).describe(`Extra complete jobs merged in.`).optional(),tokens:e.record(e.string(),e.union([e.string(),e.number(),e.boolean()])).describe("Per-workflow token overrides (`nodeVersion`, `packageManager`, ...).").optional()}).meta({id:`WorkflowConfig`}),o=e.union([e.boolean(),e.string(),a]).describe("`true`/`false` to enable/disable, an object to override parts of the default, or a raw YAML string written verbatim as the workflow file.").meta({id:`WorkflowSetting`}),s=e.object({ci:o.describe("The CI workflow (`ci.yml`).").optional(),changelog:o.describe("The changelog/version workflow (`changelog.yml`).").optional(),release:o.describe("The release workflow (`release.yml`).").optional(),issues:o.describe("The issue-title workflow (`issues.yml`).").optional(),sync:o.describe("The toolchain sync workflow (`sync.yml`).").optional()}).meta({id:`ChangelogWorkflowsConfig`}),c=e.enum([`uniform`,`root-only`,`individual`]).describe(`Where the changelog version bump is applied.`).meta({id:`ChangelogVersioningTarget`}),l=e.object({target:c.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:e.array(e.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()}).meta({id:`ChangelogVersioningConfig`}),u=e.union([e.boolean(),l]).describe(`Automatic version bumping when a changelog entry is generated.`).meta({id:`ChangelogVersioning`}),d=e.object({enabled:e.boolean().describe(`Master switch (enabled when the section is defined).`).optional(),workflows:s.describe("Which workflows to write into `.github/workflows`. Each id is `true`/`false`, an object of overrides, or a raw YAML string written verbatim.").optional(),branches:e.object({main:e.union([e.string(),e.array(e.string())]).describe('Branch glob(s) the CI + release workflows run on, and the release PR base (default `["main"]`).').optional(),dev:e.union([e.string(),e.array(e.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.`).optional(),types:e.array(e.string()).describe(`Allowed commit types (commitlint).`).optional(),scopes:e.array(e.string()).describe(`Allowed commit scopes (commitlint).`).optional(),commitlint:e.object({dir:e.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()}).describe(`commitlint config output location.`).optional(),versioning:u.describe("Automatic version bumping on changelog generation (default `true`).").optional(),vscode:e.boolean().describe(`Write the Conventional-Commits VS Code settings.`).optional()}).meta({id:`ToolchainChangelogConfig`}),f=e.object({enabled:e.boolean().describe(`Master switch (enabled when the section is defined).`).optional(),vscode:e.boolean().describe(`Write the Biome VS Code settings (default true).`).optional(),overrides:e.record(e.string(),e.unknown()).describe("Deep-merged over the generated `biome.json` (arrays union).").optional()}).meta({id:`ToolchainBiomeConfig`}),p=e.object({enabled:e.boolean().describe(`Master switch (enabled when the section is defined).`).optional(),glob:e.union([e.string(),e.array(e.string())]).describe("Glob(s) for the workspace default tsconfig files. Defaults to matching every `defaultFile` recursively.").optional(),exclude:e.union([e.string(),e.array(e.string())]).describe("Glob(s) to exclude from `glob`. Defaults to the common ignored paths (`node_modules`, `.dbx`, `dist`, `build`, ...).").optional(),gitignore:e.boolean().describe("Also respect `.gitignore` files (root + nested) when matching `glob` (default true).").optional(),refs:e.boolean().describe(`Wire project references (default false).`).optional(),composite:e.boolean().describe("Emit `composite: true` (default false).").optional(),aliases:e.boolean().describe(`Inject path aliases (default true).`).optional(),indent:e.number().describe(`JSON indentation (default 4).`).optional(),rootFile:e.string().describe("The workspaces tsconfig file name that holds `paths` + `references` (default `tsconfig.workspaces.json`).").optional(),defaultFile:e.string().describe("The workspace default tsconfig file name that the generator expands (default `tsconfig.default.json`).").optional(),buildFile:e.string().describe("The workspace build tsconfig file name (default `tsconfig.build.json`).").optional()}).meta({id:`ToolchainTsconfigConfig`}),m=e.object({enabled:e.boolean().describe(`Watch by default (enabled when the section is defined).`).optional(),debounce:e.number().describe(`Debounce window in ms (default 150).`).optional(),exclude:e.union([e.string(),e.array(e.string())]).describe("Glob(s) excluded from watching. Defaults to the common ignored paths (`node_modules`, `.dbx`, `dist`, `build`, ...).").optional(),gitignore:e.boolean().describe("Also respect `.gitignore` files (root + nested) when watching (default true).").optional()}).meta({id:`ToolchainWatchConfig`}),h=e.object({level:e.enum([`debug`,`info`,`warn`,`error`,`silent`]).describe("Minimum level to print (default `info`).").optional(),color:e.boolean().describe("Force colours on/off (default: on; `--no-color` disables).").optional(),name:e.string().describe("Prefix non-indented lines with `<name>:` (default `dbx`).").optional()}).meta({id:`ToolchainLoggerConfig`}),g=e.object({color:e.boolean().describe(`Force provider command colours on/off (default: inherit the logger).`).optional()}).meta({id:`ToolchainProvidersConfig`}),_=e.enum([`builtin`,`local`,`npm`,`git`,`vite-plus`]).describe(`How to load the source.`).meta({id:`ToolchainTemplateSourceType`}),v=e.enum([`project`,`workspace`,`application`,`folder`,`tooling`,`pipeline`]).describe(`What the template produces.`).meta({id:`ToolchainTemplateKind`}),y=e.object({type:_.describe(`How to load the source.`),locate:e.string().describe(`A builtin id, local dir, npm scope, git URL or Vite+ id.`),id:e.string().describe(`Stable id (defaults to the basename/scope).`).optional(),name:e.string().describe(`Display name override.`).optional(),description:e.string().describe(`Description override.`).optional(),kind:v.describe(`What the template produces.`).optional(),ref:e.string().describe(`Git branch/tag/commit.`).optional(),subdir:e.string().describe(`Subdirectory within the source that holds the template.`).optional(),tags:e.array(e.string()).describe(`Free-form tags.`).optional(),online:e.boolean().describe(`Whether the source needs network access.`).optional()}).meta({id:`ToolchainTemplateSource`}),b=e.object({enabled:e.boolean().describe(`Master switch (enabled when the section is defined).`).optional(),sources:e.array(y).describe(`Extra sources on top of the builtin + registry sources.`).optional()}).meta({id:`ToolchainTemplatesConfig`}),x=e.object({enabled:e.boolean().describe(`Master switch (enabled when the section is defined).`).optional(),packages:e.record(e.string(),e.string()).describe(`The default catalog: package name -> version range.`).optional(),named:e.record(e.string(),e.record(e.string(),e.string())).describe("Named catalogs (Yarn `catalogs:` / pnpm `catalogs:`): name -> packages.").optional()}).meta({id:`ToolchainCatalogsConfig`}),S=e.object({config:e.boolean().describe("Write the managed `vite.config.ts` (default true).").optional()}).catchall(e.unknown()).meta({id:`ToolchainViteConfig`});function C(t){return e.union([e.boolean(),t])}const w=e.object({project:n.describe("Project metadata: canonical `package.json` fields and template tokens (inherited by workspaces).").optional(),changelog:C(d).describe(`Conventional-Commits CI, commitlint and the changelog pipeline.`).optional(),biome:C(f).describe("Biome config generation (for consumers that still want a `biome.json`).").optional(),tsconfig:C(p).describe(`Workspace tsconfig generation (path aliases + project references).`).optional(),templates:C(b).describe(`Template sources / scaffolding.`).optional(),catalogs:C(x).describe("Package catalogs written to the package manager catalog file (`catalog:`).").optional(),vite:C(S).describe("The full Vite+ config; `dbx sync` writes the root `vite.config.ts` from it.").optional(),watch:C(m).describe("Watch behaviour for `dbx watch`.").optional(),logger:C(h).describe(`Logging level, colours and prefix for toolchain output.`).optional(),providers:C(g).describe(`Provider command behaviour (eg. colour for the passthrough commands).`).optional()}).meta({id:`ToolchainConfigSections`}),T=e.object({toolchain:w.describe("The `@deltabox/toolchain` settings (every section is opt-in by presence).").optional()}).meta({id:`DbxConfigSections`}),E={ProjectType:t,ToolchainProjectConfig:n,WorkflowStep:r,WorkflowStepsConfig:i,WorkflowConfig:a,WorkflowSetting:o,ChangelogWorkflowsConfig:s,ChangelogVersioningTarget:c,ChangelogVersioningConfig:l,ChangelogVersioning:u,ToolchainChangelogConfig:d,ToolchainBiomeConfig:f,ToolchainTsconfigConfig:p,ToolchainWatchConfig:m,ToolchainTemplateSourceType:_,ToolchainTemplateKind:v,ToolchainTemplateSource:y,ToolchainTemplatesConfig:b,ToolchainCatalogsConfig:x,ToolchainViteConfig:S,ToolchainLoggerConfig:h,ToolchainProvidersConfig:g,ToolchainConfigSections:w,DbxConfigSections:T},D={project:n,changelog:d,biome:f,tsconfig:p,templates:b,catalogs:x,vite:S,watch:m,logger:h,providers:g},O={project:"Project metadata: canonical `package.json` fields (applied on sync, inherited by workspaces) plus the replacement tokens every template understands.",changelog:`Conventional-Commits CI, commitlint and the changelog pipeline.`,biome:"Biome config generation (for consumers that still want a `biome.json`).",tsconfig:`Workspace tsconfig generation (path aliases + project references).`,templates:`Template sources / scaffolding.`,catalogs:"Package catalogs written to the package manager catalog file (`catalog:`).",vite:"The full Vite+ config; `dbx sync` writes the root `vite.config.ts` from it.",watch:"Watch behaviour for `dbx watch`.",logger:`Logging level, colours and prefix for toolchain output.`,providers:`Provider command behaviour (eg. colour for the provider passthrough commands).`};export{O as CONFIG_SECTION_DESCRIPTIONS,D as CONFIG_SECTION_SCHEMAS,E as CONFIG_TYPE_SCHEMAS,f as biomeConfigSchema,x as catalogsConfigSchema,d as changelogConfigSchema,l as changelogVersioningConfigSchema,u as changelogVersioningSchema,c as changelogVersioningTargetSchema,s as changelogWorkflowsConfigSchema,T as dbxConfigSchema,h as loggerConfigSchema,n as projectConfigSchema,t as projectTypeSchema,g as providersConfigSchema,v as templateKindSchema,y as templateSourceSchema,_ as templateSourceTypeSchema,b as templatesConfigSchema,w as toolchainConfigSchema,p as tsconfigConfigSchema,S as viteConfigSchema,m as watchConfigSchema,a as workflowConfigSchema,o as workflowSettingSchema,r as workflowStepSchema,i as workflowStepsConfigSchema};