@codedrifters/configulator 0.0.317 → 0.0.318

package/lib/index.d.mts

@@ -32,7 +32,7 @@ declare const AGENT_PLATFORM: {
 type AgentPlatform = (typeof AGENT_PLATFORM)[keyof typeof AGENT_PLATFORM];
 /**
  * Render target for Claude Code rules.
- * - SCOPED_FILE: .claude/rules/{name}.md (default — supports paths frontmatter for conditional activation)
+ * - SCOPED_FILE: `.claude/rules/{name}.md` (default — supports paths frontmatter for conditional activation)
  * - AGENTS_MD: AGENTS.md (always-active, shared with Codex)
  * - CLAUDE_MD: CLAUDE.md (always-active, Claude-only content not consumed by other agents)
  */
@@ -82,7 +82,7 @@ interface AgentPlatformOverrides {
     readonly claude?: {
         /**
          * Where to render this rule for Claude Code.
-         * - SCOPED_FILE: .claude/rules/{name}.md (default — supports paths frontmatter)
+         * - SCOPED_FILE: `.claude/rules/{name}.md` (default — supports paths frontmatter)
          * - AGENTS_MD: AGENTS.md (always-active, shared with Codex)
          * - CLAUDE_MD: CLAUDE.md (always-active, Claude-only)
          */
@@ -220,10 +220,12 @@ interface AgentSkill {
      * files for that platform alongside the SKILL.md.
      *
      * @example
+     * ```ts
      * referenceFiles: [
      *   { path: '_references/templates/_template-FR.md', content: '# Functional Requirement\n...' },
      *   { path: '_references/standards-and-frameworks.md', content: '# Standards\n...' },
      * ]
+     * ```
      */
     readonly referenceFiles?: ReadonlyArray<{
         /** Path relative to the skill directory (e.g., `_references/templates/_template-FR.md`). */
@@ -403,7 +405,7 @@ interface AgentCommand {
 }
 /**
  * An executable procedure (shell script) that ships with a bundle.
- * Rendered to .claude/procedures/{name} as an executable file.
+ * Rendered to `.claude/procedures/{name}` as an executable file.
  */
 interface AgentProcedure {
     /**
@@ -531,7 +533,7 @@ interface AgentRuleBundle {
      * Function that inspects the Projen project and returns true if this
      * bundle should be automatically included. Receives the root project
      * as input and can check for sibling components, dependencies, etc.
-     * @example (project) => Vitest.of(project) !== undefined
+     * @example `(project) => Vitest.of(project) !== undefined`
      */
     readonly appliesWhen: (project: Project) => boolean;
     /**
@@ -544,7 +546,7 @@ interface AgentRuleBundle {
      * TypeScript-adjacent code (e.g. typescript, aws-cdk, vitest, jest) should
      * implement this so their rules only activate for files in the packages
      * that actually use them.
-     * @example (project) => findProjectsWithFile(project, 'tsconfig.json')
+     * @example `(project) => findProjectsWithFile(project, 'tsconfig.json')`
      */
     readonly findApplicableProjects?: (project: Project) => ReadonlyArray<Project>;
     /** Rules included in this bundle. */
@@ -1331,11 +1333,11 @@ interface MeetingType {
  * edits on that meeting (see the `meeting-analyst` agent's
  * **Areas filtering** section for the full gating contract).
  *
- * Example: declaring `{ id: 'product-engineering', label: 'Product &
- * Engineering', docRoot: 'product' }` tells the `meeting-analysis`
- * bundle that a meeting whose frontmatter carries
- * `areas: [product-engineering]` should have its direct edits routed
- * under `<docsRoot>/product/`.
+ * Example: declaring
+ * `{ id: 'product-engineering', label: 'Product & Engineering', docRoot: 'product' }`
+ * tells the `meeting-analysis` bundle that a meeting whose frontmatter
+ * carries `areas: [product-engineering]` should have its direct edits
+ * routed under `<docsRoot>/product/`.
  *
  * When `AgentConfigOptions.meetings.meetingAreas` is non-empty, the
  * `meeting-analysis` bundle renders an "Area → doc-root mapping"
@@ -2828,7 +2830,7 @@ interface AgentConfigOptions {
      * match one of the six tier-aware bundle names — typos or
      * deprecated bundle names would otherwise be silently ignored.
      *
-     * @default {}
+     * @default `{}`
      */
     readonly bundleAgentTiers?: Readonly<Record<string, "powerful" | "balanced" | "fast">>;
     /**
@@ -4418,7 +4420,7 @@ interface ResolvedScheduledTask {
     readonly typeLabel: string;
     /**
      * Exact `type:*` label values (without the `type:` prefix) the
-     * worker picks up. When set (length >= 1), represents a
+     * worker picks up. When set (`length >= 1`), represents a
      * multi-type filter (e.g. routing-bucket `worker-issue`). When
      * unset, the `typeLabel` single-value filter applies.
      */
@@ -4432,7 +4434,7 @@ interface ResolvedScheduledTask {
     readonly phasePrefix?: string;
     /**
      * Exact phase-label values the worker filters on (e.g.
-     * `["req:write"]`). When set (length >= 1), takes precedence over
+     * `["req:write"]`). When set (`length >= 1`), takes precedence over
      * `phasePrefix`. When unset, the `phasePrefix` prefix-match
      * applies.
      */
@@ -4885,10 +4887,10 @@ declare function validateAgentTierConfig(config?: AgentTierConfig): ReadonlyArra
  *
  * When `excludeBundles` is non-empty, rows whose `type:*` label is
  * owned by an excluded bundle are dropped before rendering. Tiers
- * that end up with no surviving rows render an empty `_(none
- * registered)_` cell for consistency with the existing render — the
- * tier itself stays in the table so the dispatch ordering is still
- * documented end-to-end.
+ * that end up with no surviving rows render an empty
+ * `_(none registered)_` cell for consistency with the existing
+ * render — the tier itself stays in the table so the dispatch
+ * ordering is still documented end-to-end.
  */
 declare function renderAgentTierSection(tiers: ReadonlyArray<ResolvedAgentTier>, excludeBundles?: ReadonlyArray<string>): string;
 /**
@@ -6367,7 +6369,7 @@ interface GitHubProjectMetadata {
     readonly sprints?: GitHubSprintMetadata;
     /**
      * Kanban column (status field) definitions.
-     * @example [{ name: 'To Do', id: 'status_1' }, { name: 'In Progress', id: 'status_2' }]
+     * @example `[{ name: 'To Do', id: 'status_1' }, { name: 'In Progress', id: 'status_2' }]`
      */
     readonly columns?: ReadonlyArray<{
         readonly name: string;
@@ -6416,7 +6418,7 @@ interface SlackMetadata {
     readonly alertsChannel?: string;
     /**
      * Additional named channels. Keys are purpose identifiers.
-     * @example { releases: '#releases', support: '#customer-support' }
+     * @example `{ releases: '#releases', support: '#customer-support' }`
      */
     readonly channels?: Readonly<Record<string, string>>;
 }
@@ -6441,7 +6443,7 @@ interface DeploymentMetadata {
     readonly awsRegion?: string;
     /**
      * Named environments.
-     * @example { dev: { accountId: '111', region: 'us-east-1' }, prod: { accountId: '222', region: 'us-east-1' } }
+     * @example `{ dev: { accountId: '111', region: 'us-east-1' }, prod: { accountId: '222', region: 'us-east-1' } }`
      */
     readonly environments?: Readonly<Record<string, {
         readonly accountId?: string;
@@ -6714,7 +6716,7 @@ interface AstroIntegrationSpec {
      */
     readonly name: string;
     /**
-     * Module to import from, e.g. "@astrojs/react".
+     * Module to import from, e.g. `@astrojs/react`.
      */
     readonly importPath: string;
     /**
@@ -6830,7 +6832,7 @@ interface AwsLocalDeploymentConfig {
     /**
      * The pattern used to identify stacks to deploy in CI deployments.
      *
-     * @default *-${account}-${region}
+     * @default `*-${account}-${region}`
      */
     readonly stackPattern?: string;
 }
@@ -6842,7 +6844,7 @@ interface CiDeploymentConfig {
     /**
      * The pattern used to identify stacks to deploy in CI deployments.
      *
-     * @default *-${account}-${region}
+     * @default `*-${account}-${region}`
      */
     readonly stackPattern?: string;
 }
@@ -7492,7 +7494,7 @@ declare const AuditCategory: {
     readonly LinkFailures: "linkFailures";
     /**
      * Findings produced by the fenced-sample compilation check that
-     * flags ` ```ts ` / ` ```typescript ` / ` ```tsx ` blocks in the
+     * flags `ts`, `typescript`, and `tsx` fenced code blocks in the
      * docs that fail `tsc`. Wired in by child issue #520.
      */
     readonly SampleFailures: "sampleFailures";
@@ -8418,7 +8420,7 @@ declare const VERSION: {
      */
     readonly SHARP_VERSION: "0.34.5";
     /**
-     * Version of @astrojs/starlight to pin for StarlightProject scaffolding.
+     * Version of `@astrojs/starlight` to pin for StarlightProject scaffolding.
      */
     readonly STARLIGHT_VERSION: "0.39.2";
     /**
@@ -8426,7 +8428,7 @@ declare const VERSION: {
      */
     readonly TURBO_VERSION: "2.9.14";
     /**
-     * Version of @types/node to use across all packages (pnpm catalog).
+     * Version of `@types/node` to use across all packages (pnpm catalog).
      */
     readonly TYPES_NODE_VERSION: "25.8.0";
     /**
@@ -8790,8 +8792,8 @@ declare class PnpmWorkspace extends Component {
      * Get the pnpm workspace component of a project. If it does not exist,
      * return undefined.
      *
-     * @param project
-     * @returns
+     * @param project - The project to query.
+     * @returns The PnpmWorkspace component if present, otherwise undefined.
      */
     static of(project: Project$1): PnpmWorkspace | undefined;
     /**
@@ -9157,7 +9159,7 @@ interface VitestConfigOptions {
     /**
      * Glob patterns for test files.
      *
-     * @default ["**\/*.{test,spec}.?(c|m)[jt]s?(x)"]
+     * @default `["**\/*.{test,spec}.?(c|m)[jt]s?(x)"]`
      */
     readonly include?: string[];
     /**
@@ -9299,7 +9301,7 @@ interface TypeScriptProjectOptions extends Omit<typescript.TypeScriptProjectOpti
      * `.api-extractor/` and are gitignored). Set to `false` to opt a
      * package out of drift detection entirely.
      *
-     * @default {}
+     * @default `{}`
      */
     readonly apiExtractor?: ApiExtractorOptions | false;
     /**
@@ -9318,7 +9320,7 @@ interface TypeScriptProjectOptions extends Omit<typescript.TypeScriptProjectOpti
      * `internal` tag — even when the token sits inside a backtick code span
      * — and that strips this field from the published `.d.ts` rollup.
      *
-     * @default {}
+     * @default `{}`
      */
     readonly tsdocConfig?: TsdocConfigOptions | false;
     /**
@@ -9460,7 +9462,7 @@ declare class AwsDeployWorkflow extends Component {
      * Handles both exact matches (e.g., "main") and glob patterns (e.g., "feature/*").
      * Also allows workflow_dispatch (manual runs) to proceed.
      *
-     * @param branches Array of GitBranch objects with branch patterns
+     * @param branches - Array of GitBranch objects with branch patterns
      * @returns Condition string or empty string if no branches provided
      */
     private buildBranchFilterCondition;
@@ -9667,7 +9669,7 @@ interface TurboRepoOptions {
     /**
      * Version of turborepo to use.
      *
-     * @default: specified in versions file
+     * @default specified in versions file
      */
     readonly turboVersion?: string;
     /**
@@ -9716,7 +9718,7 @@ interface TurboRepoOptions {
      */
     readonly globalPassThroughEnv?: Array<string>;
     /**
-     * @default: "stream"
+     * @default "stream"
      *
      * Select a terminal UI for the repository.
      *
@@ -9727,7 +9729,7 @@ interface TurboRepoOptions {
      */
     readonly ui?: "tui" | "stream";
     /**
-     * @default: false
+     * @default false
      *
      * Turborepo uses your repository's lockfile to determine caching behavior,
      * Package Graphs, and more. Because of this, we use the packageManager field
@@ -9744,7 +9746,7 @@ interface TurboRepoOptions {
      */
     readonly dangerouslyDisablePackageManagerCheck?: boolean;
     /**
-     * @default: ".turbo/cache"
+     * @default ".turbo/cache"
      *
      * Specify the filesystem cache directory.
      *
@@ -9761,7 +9763,7 @@ interface TurboRepoOptions {
      */
     readonly daemon?: boolean;
     /**
-     * @default: "strict"
+     * @default "strict"
      *
      * Turborepo's Environment Modes allow you to control which environment
      * variables are available to a task at runtime:
@@ -9786,7 +9788,7 @@ interface TurboRepoOptions {
     /**
      * Env Args that will bre added to turbo's build:all task
      *
-     * @default: {}
+     * @default `{}`
      */
     readonly buildAllTaskEnvVars?: Record<string, string>;
     /*****************************************************************************
@@ -9798,31 +9800,31 @@ interface TurboRepoOptions {
     /**
      * Pre compile task
      *
-     * @default: "pre-compile"
+     * @default "pre-compile"
      */
     readonly preCompileTask?: Task;
     /**
      * Compile task
      *
-     * @default: "compile"
+     * @default "compile"
      */
     readonly compileTask?: Task;
     /**
      * Post compile task
      *
-     * @default: "post-compile"
+     * @default "post-compile"
      */
     readonly postCompileTask?: Task;
     /**
      * Test task
      *
-     * @default: "test"
+     * @default "test"
      */
     readonly testTask?: Task;
     /**
      * Package task
      *
-     * @default: "package"
+     * @default "package"
      */
     readonly packageTask?: Task;
 }
@@ -9883,7 +9885,7 @@ declare class TurboRepo extends Component$1 {
      */
     readonly globalPassThroughEnv: Array<string>;
     /**
-     * @default: "stream"
+     * @default "stream"
      *
      * Select a terminal UI for the repository.
      *
@@ -9894,7 +9896,7 @@ declare class TurboRepo extends Component$1 {
      */
     readonly ui: "tui" | "stream";
     /**
-     * @default: false
+     * @default false
      *
      * Turborepo uses your repository's lockfile to determine caching behavior,
      * Package Graphs, and more. Because of this, we use the packageManager field
@@ -9911,7 +9913,7 @@ declare class TurboRepo extends Component$1 {
      */
     readonly dangerouslyDisablePackageManagerCheck: boolean;
     /**
-     * @default: ".turbo/cache"
+     * @default ".turbo/cache"
      *
      * Specify the filesystem cache directory.
      *
@@ -9927,7 +9929,7 @@ declare class TurboRepo extends Component$1 {
      */
     readonly daemon: boolean;
     /**
-     * @default: "strict"
+     * @default "strict"
      *
      * Turborepo's Environment Modes allow you to control which environment
      * variables are available to a task at runtime:
@@ -10144,7 +10146,7 @@ interface MonorepoProjectOptions extends Omit<TypeScriptProjectOptions$1, "defau
         /**
          * The version of PNPM to use in the monorepo.
          * @default VERSION.PNPM_VERSION
-         * @see {@link src/versions.ts}
+         * @see `src/versions.ts`
          */
         version?: string;
         /**
@@ -10162,7 +10164,7 @@ interface MonorepoProjectOptions extends Omit<TypeScriptProjectOptions$1, "defau
      */
     readonly approveMergeUpgradeOptions?: ApproveMergeUpgradeOptions;
     /**
-     * Whether this monorepo consumes @codedrifters/configulator from a registry (npm).
+     * Whether this monorepo consumes `@codedrifters/configulator` from a registry (npm).
      * When true, the upgrade workflow adds steps to sync configulator and synthesize.
      * Set to false when configulator is developed in this repo (e.g. workspace dependency).
      *
@@ -10178,7 +10180,7 @@ interface MonorepoProjectOptions extends Omit<TypeScriptProjectOptions$1, "defau
      * - `ProjectMetadataOptions`: explicit metadata configuration
      * - `false`: disable ProjectMetadata entirely
      *
-     * @default {} (auto-detect from package.json)
+     * @default `{}` (auto-detect from package.json)
      */
     readonly projectMetadata?: ProjectMetadataOptions | false;
     /**
@@ -10452,8 +10454,8 @@ declare class ProjectMetadata extends Component {
     /**
      * Return the maintainer-seed addendum for the `project-context`
      * bundle, or an empty string when the root project either has no
-     * layout-enforcement opinion or has opted out (`layoutEnforcement:
-     * "off"`).
+     * layout-enforcement opinion or has opted out
+     * (`layoutEnforcement: "off"`).
      *
      * Uses duck-typing on the root project's `layoutEnforcement`
      * property to avoid a circular import with `MonorepoProject`. The
@@ -10678,7 +10680,7 @@ interface StarlightProjectOptions extends AstroProjectOptions {
      */
     readonly editLink?: StarlightEditLink;
     /**
-     * @astrojs/starlight package version.
+     * `@astrojs/starlight` package version.
      *
      * @default VERSION.STARLIGHT_VERSION
      */
@@ -10730,7 +10732,7 @@ declare const COMPLETE_JOB_ID = "complete";
  * Call this for the default build workflow and for any build workflow created
  * by Configulator (e.g. AwsDeployWorkflow).
  *
- * @param buildWorkflow The Projen BuildWorkflow to append the complete job to.
+ * @param buildWorkflow - The Projen BuildWorkflow to append the complete job to.
  */
 declare function addBuildCompleteJob(buildWorkflow: BuildWorkflow): void;
 
@@ -10758,7 +10760,7 @@ declare function addBuildCompleteJob(buildWorkflow: BuildWorkflow): void;
  *    (e.g. the upgrade workflow). Steps held inside lazy closures
  *    are skipped — those are reached via pass 1.
  *
- * @param project The project whose GitHub workflows should be patched.
+ * @param project - The project whose GitHub workflows should be patched.
  */
 declare function pinPnpmActionSetup(project: Project$1): void;
 
@@ -10806,7 +10808,7 @@ declare function pinPnpmActionSetup(project: Project$1): void;
  * untouched. The step's `uses` field is also left alone — this
  * helper pins the input, not the action version pin.
  *
- * @param project The project whose GitHub workflows should be patched.
+ * @param project - The project whose GitHub workflows should be patched.
  */
 declare function pinSetupNodeVersion(project: Project$1): void;