@codedrifters/configulator 0.0.242 → 0.0.244

package/lib/index.js

@@ -210,6 +210,7 @@ __export(index_exports, {
   ROOT_CI_TASK_NAME: () => ROOT_CI_TASK_NAME,
   ROOT_TURBO_TASK_NAME: () => ROOT_TURBO_TASK_NAME,
   ResetTask: () => ResetTask,
+  STARLIGHT_ROLE: () => STARLIGHT_ROLE,
   StarlightProject: () => StarlightProject,
   TestRunner: () => TestRunner,
   TurboRepo: () => TurboRepo,
@@ -229,6 +230,7 @@ __export(index_exports, {
   bcmWriterBundle: () => bcmWriterBundle,
   companyProfileBundle: () => companyProfileBundle,
   formatLayoutViolation: () => formatLayoutViolation,
+  formatStarlightSingletonViolation: () => formatStarlightSingletonViolation,
   getLatestEligibleVersion: () => getLatestEligibleVersion,
   githubWorkflowBundle: () => githubWorkflowBundle,
   industryDiscoveryBundle: () => industryDiscoveryBundle,
@@ -244,6 +246,7 @@ __export(index_exports, {
   requirementsReviewerBundle: () => requirementsReviewerBundle,
   requirementsWriterBundle: () => requirementsWriterBundle,
   researchPipelineBundle: () => researchPipelineBundle,
+  resolveAstroProjectOutdir: () => resolveAstroProjectOutdir,
   resolveAwsCdkProjectOutdir: () => resolveAwsCdkProjectOutdir,
   resolveModelAlias: () => resolveModelAlias,
   resolveOutdirFromPackageName: () => resolveOutdirFromPackageName,
@@ -254,6 +257,7 @@ __export(index_exports, {
   turborepoBundle: () => turborepoBundle,
   typescriptBundle: () => typescriptBundle,
   validateMonorepoLayout: () => validateMonorepoLayout,
+  validateStarlightSingleton: () => validateStarlightSingleton,
   vitestBundle: () => vitestBundle
 });
 module.exports = __toCommonJS(index_exports);
@@ -900,7 +904,12 @@ var baseBundle = {
         "- The docs site is monorepo-wide. Sub-project documentation belongs",
         "  inside that single site (under `docs/content/`), not in a per-package",
         "  `docs/` folder.",
-        "- Configulator's `StarlightProject` defaults its `outdir` to `/docs`.",
+        "- Configulator's `StarlightProject` defaults its `outdir` to `/docs` and",
+        '  its `role` to `"docs"`. A second `StarlightProject` with `role: "docs"`',
+        "  fails synth \u2014 the singleton rule is enforced at validate time.",
+        "- Additional Starlight sites (client-facing, marketing, etc.) must set",
+        '  `role: "site"`, which routes them under `sites/<scope>/<name>` just',
+        "  like a plain `AstroProject`.",
         "- `/sites` is reserved for end-user-facing web front ends (marketing",
         "  sites, SPAs, client-facing apps). It deliberately does not host the",
         "  dev-docs site.",
@@ -916,7 +925,8 @@ var baseBundle = {
         "| `TypeScriptProject` | `packages/<scope>/<name>` |",
         "| `AwsCdkProject` | `apps/<scope>/<name>` |",
         "| `AstroProject` | `sites/<scope>/<name>` |",
-        "| `StarlightProject` (role = docs) | `docs/` |",
+        "| `StarlightProject` (role = docs, default) | `docs/` |",
+        "| `StarlightProject` (role = site) | `sites/<scope>/<name>` |",
         "",
         "`<scope>` is parsed from the sub-project's package name (everything",
         "after `@` and before `/`). `<name>` is the unscoped part of the",
@@ -15637,18 +15647,6 @@ var JsiiFaker = class _JsiiFaker extends import_projen12.Component {
 // src/projects/astro-project.ts
 var import_projen17 = require("projen");
 
-// src/projects/typescript-project.ts
-var import_projen16 = require("projen");
-var import_javascript4 = require("projen/lib/javascript");
-var import_release = require("projen/lib/release");
-var import_ts_deepmerge2 = require("ts-deepmerge");
-
-// src/projects/monorepo-project.ts
-var import_github2 = require("projen/lib/github");
-var import_javascript3 = require("projen/lib/javascript");
-var import_typescript3 = require("projen/lib/typescript");
-var import_ts_deepmerge = require("ts-deepmerge");
-
 // src/projects/monorepo-layout.ts
 var MONOREPO_LAYOUT = {
   DOCS: "docs",
@@ -15672,7 +15670,7 @@ function validateMonorepoLayout(root) {
   const rootOutdir = toPosix(root.outdir);
   for (const sub of root.subprojects) {
     const className = sub.constructor.name;
-    const expectedRoot = LAYOUT_ROOT_BY_PROJECT_TYPE[className];
+    const expectedRoot = expectedRootFor(sub, className);
     if (expectedRoot === void 0) {
       continue;
     }
@@ -15688,11 +15686,40 @@ function validateMonorepoLayout(root) {
   }
   return violations;
 }
+function validateStarlightSingleton(root) {
+  const docsRoleProjects = [];
+  for (const sub of root.subprojects) {
+    if (sub.constructor.name !== "StarlightProject") {
+      continue;
+    }
+    if (getStarlightRole(sub) === "docs") {
+      docsRoleProjects.push(sub.name);
+    }
+  }
+  if (docsRoleProjects.length <= 1) {
+    return void 0;
+  }
+  return { projectNames: docsRoleProjects };
+}
+function expectedRootFor(sub, className) {
+  if (className === "StarlightProject") {
+    return getStarlightRole(sub) === "site" ? MONOREPO_LAYOUT.SITES : MONOREPO_LAYOUT.DOCS;
+  }
+  return LAYOUT_ROOT_BY_PROJECT_TYPE[className];
+}
+function getStarlightRole(sub) {
+  const role = sub.role;
+  return role === "site" ? "site" : "docs";
+}
 function formatLayoutViolation(violation) {
   const { projectName, projectType, outdir, expectedRoot } = violation;
   const expectedExample = expectedRoot === MONOREPO_LAYOUT.DOCS ? "docs/" : `${expectedRoot}/<scope>/<name>`;
   return `[monorepo-layout] ${projectType} "${projectName}" has outdir "${outdir}", which is outside the expected root "${expectedRoot}/" (expected e.g. "${expectedExample}"). See docs/requirements/architectural-decisions/ADR-006-monorepo-layout.md.`;
 }
+function formatStarlightSingletonViolation(violation) {
+  const names = violation.projectNames.map((n) => `"${n}"`).join(", ");
+  return `[monorepo-layout] Multiple StarlightProject instances with role: "docs" found (${names}). ADR-006 allows exactly one docs-role Starlight project per MonorepoProject. Either remove the duplicates or set role: "site" on the additional ones so they land under sites/. See docs/requirements/architectural-decisions/ADR-006-monorepo-layout.md.`;
+}
 function outdirMatchesRoot(relOutdir, expectedRoot) {
   const segments = relOutdir.split("/").filter((s) => s.length > 0);
   if (segments.length === 0) {
@@ -15720,6 +15747,58 @@ function relativeOutdir(rootOutdir, subOutdir) {
   return subOutdir;
 }
 
+// src/projects/resolve-outdir.ts
+function parseScopedName(input) {
+  if (!input.startsWith("@")) {
+    return void 0;
+  }
+  const slashIndex = input.indexOf("/");
+  if (slashIndex < 2) {
+    return void 0;
+  }
+  const scope = input.slice(0, slashIndex);
+  const name = input.slice(slashIndex + 1);
+  if (name.length === 0 || name.includes("/")) {
+    return void 0;
+  }
+  return { scope, name };
+}
+function resolveOutdirFromPackageName(packageName, root) {
+  if (packageName === void 0 || packageName.length === 0) {
+    throw new Error(
+      "Cannot derive outdir: packageName (or name) is required when outdir is omitted. Either pass a scoped `packageName` / `name` like `@scope/foo`, or set `outdir` explicitly."
+    );
+  }
+  const parsed = parseScopedName(packageName);
+  if (parsed === void 0) {
+    throw new Error(
+      `Cannot derive outdir from unscoped packageName "${packageName}". Either use a scoped name like \`@scope/foo\`, or set \`outdir\` explicitly. Configulator places sub-projects at "${root}/<scope>/<name>".`
+    );
+  }
+  return `${root}/${parsed.scope}/${parsed.name}`;
+}
+function resolveTypeScriptProjectOutdir(packageName) {
+  return resolveOutdirFromPackageName(packageName, MONOREPO_LAYOUT.PACKAGES);
+}
+function resolveAwsCdkProjectOutdir(packageName) {
+  return resolveOutdirFromPackageName(packageName, MONOREPO_LAYOUT.APPS);
+}
+function resolveAstroProjectOutdir(packageName) {
+  return resolveOutdirFromPackageName(packageName, MONOREPO_LAYOUT.SITES);
+}
+
+// src/projects/typescript-project.ts
+var import_projen16 = require("projen");
+var import_javascript4 = require("projen/lib/javascript");
+var import_release = require("projen/lib/release");
+var import_ts_deepmerge2 = require("ts-deepmerge");
+
+// src/projects/monorepo-project.ts
+var import_github2 = require("projen/lib/github");
+var import_javascript3 = require("projen/lib/javascript");
+var import_typescript3 = require("projen/lib/typescript");
+var import_ts_deepmerge = require("ts-deepmerge");
+
 // src/tasks/reset-task.ts
 var import_projen13 = require("projen");
 var ResetTask = class _ResetTask extends import_projen13.Component {
@@ -16446,10 +16525,20 @@ var MonorepoProject = class extends import_typescript3.TypeScriptAppProject {
    * layout contract. Runs in `preSynthesize` so all sub-projects are
    * attached by the time we inspect the tree.
    *
+   * Two checks run in sequence:
+   *
+   * 1. **Outdir-vs-root validation.** Every sub-project's `outdir` must
+   *    live under the root expected for its project type (ADR-006 §4).
+   * 2. **Docs-singleton validation.** At most one `StarlightProject`
+   *    may carry `role: "docs"` (ADR-006 §3).
+   *
    * Behavior is controlled by `layoutEnforcement`:
-   * - `"off"`  — skip validation.
-   * - `"warn"` — log a `console.warn` per violation; continue.
-   * - `"error"` — throw on the first violation.
+   * - `"off"`  — skip both checks.
+   * - `"warn"` — log a `console.warn` per violation; continue. Singleton
+   *   violations also warn in this mode rather than throwing, so all
+   *   layout findings are surfaced consistently.
+   * - `"error"` — throw on the first outdir violation, or on the
+   *   singleton violation if outdir validation passed.
    */
   preSynthesize() {
     super.preSynthesize();
@@ -16457,15 +16546,22 @@ var MonorepoProject = class extends import_typescript3.TypeScriptAppProject {
       return;
     }
     const violations = validateMonorepoLayout(this);
-    if (violations.length === 0) {
-      return;
-    }
+    const singletonViolation = validateStarlightSingleton(this);
     if (this.layoutEnforcement === LAYOUT_ENFORCEMENT.ERROR) {
-      throw new Error(formatLayoutViolation(violations[0]));
+      if (violations.length > 0) {
+        throw new Error(formatLayoutViolation(violations[0]));
+      }
+      if (singletonViolation !== void 0) {
+        throw new Error(formatStarlightSingletonViolation(singletonViolation));
+      }
+      return;
     }
     for (const violation of violations) {
       console.warn(formatLayoutViolation(violation));
     }
+    if (singletonViolation !== void 0) {
+      console.warn(formatStarlightSingletonViolation(singletonViolation));
+    }
   }
   /**
    * Allows a sub project to request installation of dependency at the Monorepo root
@@ -16495,43 +16591,6 @@ var MonorepoProject = class extends import_typescript3.TypeScriptAppProject {
   }
 };
 
-// src/projects/resolve-outdir.ts
-function parseScopedName(input) {
-  if (!input.startsWith("@")) {
-    return void 0;
-  }
-  const slashIndex = input.indexOf("/");
-  if (slashIndex < 2) {
-    return void 0;
-  }
-  const scope = input.slice(0, slashIndex);
-  const name = input.slice(slashIndex + 1);
-  if (name.length === 0 || name.includes("/")) {
-    return void 0;
-  }
-  return { scope, name };
-}
-function resolveOutdirFromPackageName(packageName, root) {
-  if (packageName === void 0 || packageName.length === 0) {
-    throw new Error(
-      "Cannot derive outdir: packageName (or name) is required when outdir is omitted. Either pass a scoped `packageName` / `name` like `@scope/foo`, or set `outdir` explicitly."
-    );
-  }
-  const parsed = parseScopedName(packageName);
-  if (parsed === void 0) {
-    throw new Error(
-      `Cannot derive outdir from unscoped packageName "${packageName}". Either use a scoped name like \`@scope/foo\`, or set \`outdir\` explicitly. Configulator places sub-projects at "${root}/<scope>/<name>".`
-    );
-  }
-  return `${root}/${parsed.scope}/${parsed.name}`;
-}
-function resolveTypeScriptProjectOutdir(packageName) {
-  return resolveOutdirFromPackageName(packageName, MONOREPO_LAYOUT.PACKAGES);
-}
-function resolveAwsCdkProjectOutdir(packageName) {
-  return resolveOutdirFromPackageName(packageName, MONOREPO_LAYOUT.APPS);
-}
-
 // src/projects/typescript-project.ts
 var TestRunner = {
   JEST: "jest",
@@ -16718,9 +16777,11 @@ var TypeScriptProject = class extends import_projen16.typescript.TypeScriptProje
 // src/projects/astro-project.ts
 var AstroProject = class extends TypeScriptProject {
   constructor(userOptions) {
+    const resolvedOutdir = userOptions.outdir ?? resolveAstroProjectOutdir(userOptions.packageName ?? userOptions.name);
     const options = {
       testRunner: TestRunner.VITEST,
       ...userOptions,
+      outdir: resolvedOutdir,
       depsUpgradeOptions: {
         ...userOptions.depsUpgradeOptions,
         exclude: [...userOptions.depsUpgradeOptions?.exclude ?? [], "astro"]
@@ -17497,8 +17558,13 @@ var AwsCdkProject = class extends import_projen20.awscdk.AwsCdkTypeScriptApp {
 
 // src/projects/starlight-project.ts
 var import_projen21 = require("projen");
+var STARLIGHT_ROLE = {
+  DOCS: "docs",
+  SITE: "site"
+};
 var StarlightProject = class extends AstroProject {
   constructor(userOptions) {
+    const role = userOptions.role ?? STARLIGHT_ROLE.DOCS;
     const starlightConfig = buildStarlightConfig(userOptions);
     const starlightSpec = {
       name: "starlight",
@@ -17506,8 +17572,10 @@ var StarlightProject = class extends AstroProject {
       defaultImport: true,
       args: JSON.stringify(starlightConfig, null, 2)
     };
+    const resolvedOutdir = userOptions.outdir ?? (role === STARLIGHT_ROLE.DOCS ? MONOREPO_LAYOUT.DOCS : void 0);
     const mergedOptions = {
       ...userOptions,
+      outdir: resolvedOutdir,
       integrations: [starlightSpec, ...userOptions.integrations ?? []],
       depsUpgradeOptions: {
         ...userOptions.depsUpgradeOptions,
@@ -17519,6 +17587,7 @@ var StarlightProject = class extends AstroProject {
       }
     };
     super(mergedOptions);
+    this.role = role;
     const starlightVersion = userOptions.starlightVersion ?? VERSION.STARLIGHT_VERSION;
     const sharpVersion = userOptions.sharpVersion ?? VERSION.SHARP_VERSION;
     this.addDeps(
@@ -17646,6 +17715,7 @@ var TypeScriptConfig = class extends import_projen22.Component {
   ROOT_CI_TASK_NAME,
   ROOT_TURBO_TASK_NAME,
   ResetTask,
+  STARLIGHT_ROLE,
   StarlightProject,
   TestRunner,
   TurboRepo,
@@ -17665,6 +17735,7 @@ var TypeScriptConfig = class extends import_projen22.Component {
   bcmWriterBundle,
   companyProfileBundle,
   formatLayoutViolation,
+  formatStarlightSingletonViolation,
   getLatestEligibleVersion,
   githubWorkflowBundle,
   industryDiscoveryBundle,
@@ -17680,6 +17751,7 @@ var TypeScriptConfig = class extends import_projen22.Component {
   requirementsReviewerBundle,
   requirementsWriterBundle,
   researchPipelineBundle,
+  resolveAstroProjectOutdir,
   resolveAwsCdkProjectOutdir,
   resolveModelAlias,
   resolveOutdirFromPackageName,
@@ -17690,6 +17762,7 @@ var TypeScriptConfig = class extends import_projen22.Component {
   turborepoBundle,
   typescriptBundle,
   validateMonorepoLayout,
+  validateStarlightSingleton,
   vitestBundle
 });
 //# sourceMappingURL=index.js.map