@codedrifters/configulator 0.0.317 → 0.0.318

package/lib/index.d.ts

@@ -81,7 +81,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)
  */
@@ -131,7 +131,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)
          */
@@ -269,10 +269,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`). */
@@ -452,7 +454,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 {
     /**
@@ -580,7 +582,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$1) => boolean;
     /**
@@ -593,7 +595,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$1) => ReadonlyArray<Project$1>;
     /** Rules included in this bundle. */
@@ -1380,11 +1382,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"
@@ -2877,7 +2879,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">>;
     /**
@@ -4467,7 +4469,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.
      */
@@ -4481,7 +4483,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.
      */
@@ -4934,10 +4936,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;
 /**
@@ -6416,7 +6418,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;
@@ -6465,7 +6467,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>>;
 }
@@ -6490,7 +6492,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;
@@ -6763,7 +6765,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;
     /**
@@ -6879,7 +6881,7 @@ interface AwsLocalDeploymentConfig {
     /**
      * The pattern used to identify stacks to deploy in CI deployments.
      *
-     * @default *-${account}-${region}
+     * @default `*-${account}-${region}`
      */
     readonly stackPattern?: string;
 }
@@ -6891,7 +6893,7 @@ interface CiDeploymentConfig {
     /**
      * The pattern used to identify stacks to deploy in CI deployments.
      *
-     * @default *-${account}-${region}
+     * @default `*-${account}-${region}`
      */
     readonly stackPattern?: string;
 }
@@ -7541,7 +7543,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";
@@ -8467,7 +8469,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";
     /**
@@ -8475,7 +8477,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";
     /**
@@ -8839,8 +8841,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): PnpmWorkspace | undefined;
     /**
@@ -9206,7 +9208,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[];
     /**
@@ -9348,7 +9350,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;
     /**
@@ -9367,7 +9369,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;
     /**
@@ -9509,7 +9511,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;
@@ -9716,7 +9718,7 @@ interface TurboRepoOptions {
     /**
      * Version of turborepo to use.
      *
-     * @default: specified in versions file
+     * @default specified in versions file
      */
     readonly turboVersion?: string;
     /**
@@ -9765,7 +9767,7 @@ interface TurboRepoOptions {
      */
     readonly globalPassThroughEnv?: Array<string>;
     /**
-     * @default: "stream"
+     * @default "stream"
      *
      * Select a terminal UI for the repository.
      *
@@ -9776,7 +9778,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
@@ -9793,7 +9795,7 @@ interface TurboRepoOptions {
      */
     readonly dangerouslyDisablePackageManagerCheck?: boolean;
     /**
-     * @default: ".turbo/cache"
+     * @default ".turbo/cache"
      *
      * Specify the filesystem cache directory.
      *
@@ -9810,7 +9812,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:
@@ -9835,7 +9837,7 @@ interface TurboRepoOptions {
     /**
      * Env Args that will bre added to turbo's build:all task
      *
-     * @default: {}
+     * @default `{}`
      */
     readonly buildAllTaskEnvVars?: Record<string, string>;
     /*****************************************************************************
@@ -9847,31 +9849,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;
 }
@@ -9932,7 +9934,7 @@ declare class TurboRepo extends Component$1 {
      */
     readonly globalPassThroughEnv: Array<string>;
     /**
-     * @default: "stream"
+     * @default "stream"
      *
      * Select a terminal UI for the repository.
      *
@@ -9943,7 +9945,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
@@ -9960,7 +9962,7 @@ declare class TurboRepo extends Component$1 {
      */
     readonly dangerouslyDisablePackageManagerCheck: boolean;
     /**
-     * @default: ".turbo/cache"
+     * @default ".turbo/cache"
      *
      * Specify the filesystem cache directory.
      *
@@ -9976,7 +9978,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:
@@ -10193,7 +10195,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;
         /**
@@ -10211,7 +10213,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).
      *
@@ -10227,7 +10229,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;
     /**
@@ -10501,8 +10503,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
@@ -10727,7 +10729,7 @@ interface StarlightProjectOptions extends AstroProjectOptions {
      */
     readonly editLink?: StarlightEditLink;
     /**
-     * @astrojs/starlight package version.
+     * `@astrojs/starlight` package version.
      *
      * @default VERSION.STARLIGHT_VERSION
      */
@@ -10779,7 +10781,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;
 
@@ -10807,7 +10809,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): void;
 
@@ -10855,7 +10857,7 @@ declare function pinPnpmActionSetup(project: Project): 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): void;
 

package/lib/index.js

@@ -16916,8 +16916,8 @@ var PnpmWorkspace = class _PnpmWorkspace extends import_projen.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) {
     const isDefined = (c) => c instanceof _PnpmWorkspace;
@@ -25199,8 +25199,8 @@ var ProjectMetadata = class _ProjectMetadata extends import_projen2.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
@@ -27960,7 +27960,7 @@ _TurboRepo.buildWorkflowOptions = (remoteCacheOptions) => {
     preBuildSteps: [
       {
         name: "AWS Creds for SSM",
-        uses: "aws-actions/configure-aws-credentials@v4",
+        uses: "aws-actions/configure-aws-credentials@v6",
         with: {
           ["role-to-assume"]: remoteCacheOptions.oidcRole,
           ["aws-region"]: "us-east-1",
@@ -28373,7 +28373,7 @@ var VERSION = {
    */
   SHARP_VERSION: "0.34.5",
   /**
-   * Version of @astrojs/starlight to pin for StarlightProject scaffolding.
+   * Version of `@astrojs/starlight` to pin for StarlightProject scaffolding.
    */
   STARLIGHT_VERSION: "0.39.2",
   /**
@@ -28381,7 +28381,7 @@ var VERSION = {
    */
   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).
    */
   TYPES_NODE_VERSION: "25.8.0",
   /**
@@ -31963,7 +31963,7 @@ var AuditCategory = {
   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.
    */
   SampleFailures: "sampleFailures"
@@ -34032,7 +34032,7 @@ var MonorepoProject = class extends import_typescript3.TypeScriptAppProject {
       release: false,
       /**
        * Uppgrade dependencies automatically unless otherwise instructed.
-       * Exclude @codedrifters/configulator so the default upgrade task does not
+       * Exclude `@codedrifters/configulator` so the default upgrade task does not
        * upgrade it (version is often managed in-repo or via a separate sync step).
        */
       depsUpgrade: true,
@@ -34309,12 +34309,8 @@ var MonorepoProject = class extends import_typescript3.TypeScriptAppProject {
 
 // src/typescript/tsdoc-config.ts
 var import_projen20 = require("projen");
-var STANDARD_MODIFIER_TAGS = [
-  "@default",
-  "@defaultValue",
-  "@experimental",
-  "@internal"
-];
+var STANDARD_MODIFIER_TAGS = ["@default"];
+var STANDARD_INLINE_TAGS = ["@code"];
 var ALWAYS_ON_SCOPES = ["@codedrifters"];
 var TsdocConfig = class _TsdocConfig extends import_projen20.Component {
   /**
@@ -34343,17 +34339,26 @@ var TsdocConfig = class _TsdocConfig extends import_projen20.Component {
       ...scopeFromName ? [scopeFromName] : [],
       ...options.workspaceScopes ?? []
     ]);
-    const tagSet = /* @__PURE__ */ new Set([
+    const modifierTagSet = /* @__PURE__ */ new Set([
       ...STANDARD_MODIFIER_TAGS,
       ...Array.from(scopeSet),
       ...options.additionalModifierTags ?? []
     ]);
-    const tagDefinitions = Array.from(tagSet).sort((a, b) => a.localeCompare(b)).map((tagName) => ({
-      tagName,
-      syntaxKind: "modifier",
-      allowMultiple: true
-    }));
+    const inlineTagSet = /* @__PURE__ */ new Set([...STANDARD_INLINE_TAGS]);
+    const tagDefinitions = [
+      ...Array.from(modifierTagSet).map((tagName) => ({
+        tagName,
+        syntaxKind: "modifier",
+        allowMultiple: true
+      })),
+      ...Array.from(inlineTagSet).map((tagName) => ({
+        tagName,
+        syntaxKind: "inline",
+        allowMultiple: true
+      }))
+    ].sort((a, b) => a.tagName.localeCompare(b.tagName));
     new import_projen20.JsonFile(project, "tsdoc.json", {
+      marker: false,
       obj: {
         $schema: "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
         tagDefinitions
@@ -34803,7 +34808,7 @@ var AwsDeployWorkflow = class _AwsDeployWorkflow extends import_projen24.Compone
      * 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
      */
     this.buildBranchFilterCondition = (branches) => {
@@ -34850,7 +34855,7 @@ var AwsDeployWorkflow = class _AwsDeployWorkflow extends import_projen24.Compone
          */
         {
           name: `AWS Creds ${awsStageType}/${deploymentTargetRole}/${account}/${region}`,
-          uses: "aws-actions/configure-aws-credentials@v4",
+          uses: "aws-actions/configure-aws-credentials@v6",
           with: {
             "role-to-assume": roleArn,
             "aws-region": region,