@codedrifters/configulator 0.0.237 → 0.0.239

package/lib/index.mjs

@@ -459,7 +459,7 @@ var baseBundle = {
         "## Important Notes",
         "",
         "- **Never edit generated files** \u2014 they are marked with `// ~~ Generated by projen`",
-        "- **After modifying Projen configuration**, run `npx projen` to regenerate files, then `pnpm install` to update the lockfile.",
+        "- **After modifying Projen configuration**, run `pnpm exec projen` to regenerate files, then `pnpm install` to update the lockfile.",
         "- **Configure dependencies through Projen** \u2014 never use `npm install`, `pnpm add`, or `yarn add`. Add them to `deps` or `devDeps` in Projen config.",
         "- **Export from index.ts** to maintain clean public APIs"
       ].join("\n"),
@@ -476,7 +476,7 @@ var baseBundle = {
         "",
         "## Prohibited Commands",
         "",
-        "- `npx projen` \u2014 synthesize project files",
+        "- `pnpm exec projen` \u2014 synthesize project files",
         "- `pnpm install` / `pnpm i` \u2014 install dependencies",
         "- `pnpm build` / `pnpm build:all` \u2014 build the project",
         "- `pnpm test` / `pnpm --filter ... test` \u2014 run tests",
@@ -489,7 +489,7 @@ var baseBundle = {
         "",
         "After making changes that need validation, tell the user the specific commands to run:",
         "",
-        "1. **After projen config changes** \u2014 tell the user to run `npx projen && pnpm install`",
+        "1. **After projen config changes** \u2014 tell the user to run `pnpm exec projen && pnpm install`",
         "2. **After source code changes** \u2014 tell the user to run `pnpm --filter @codedrifters/<package> test`",
         "3. **After multi-package changes** \u2014 tell the user to run `pnpm build:all`"
       ].join("\n"),
@@ -2447,7 +2447,7 @@ var githubWorkflowBundle = {
         "",
         "When the user says **open a PR** (or similar), follow these steps exactly:",
         "",
-        "1. **Regenerate project files** \u2014 run `npx projen` then `pnpm install` to ensure all generated files are up to date. Check `git diff` \u2014 if there are changes, commit them before proceeding.",
+        "1. **Regenerate project files** \u2014 run `pnpm exec projen` then `pnpm install` to ensure all generated files are up to date. Check `git diff` \u2014 if there are changes, commit them before proceeding.",
         "2. **Run the full monorepo build** \u2014 run `pnpm build:all` to compile, lint, and test all packages (mirrors the CI pipeline). This command requires the user to be authenticated to AWS on the prod account used for Turborepo remote caching (`readonlyaccess-prod-525259625215-us-east-1` profile). If the command fails due to AWS credentials, ask the user to authenticate first. If the build produces changes to turbo inputs (typically snapshot files or ESLint auto-fixes), commit those changes and run `pnpm build:all` again \u2014 the build must complete cleanly with no uncommitted changes.",
         "3. **Check for uncommitted changes** \u2014 if any exist, commit them with a conventional commit message",
         "4. **Pull and rebase from the default branch** \u2014 run `git pull origin {{repository.defaultBranch}} --rebase` to incorporate the latest changes and resolve any conflicts before pushing",
@@ -4593,7 +4593,7 @@ var issueWorkerSubAgent = {
     "",
     "Run the appropriate verification commands depending on what changed:",
     "",
-    "1. If Projen config was changed: `npx projen && pnpm install`",
+    "1. If Projen config was changed: `pnpm exec projen && pnpm install`",
     "2. Compile the affected package: `pnpm --filter @codedrifters/<package> compile`",
     "3. Test the affected package: `pnpm --filter @codedrifters/<package> test`",
     "4. If changes span multiple packages: `pnpm build:all`",
@@ -5586,7 +5586,7 @@ var pnpmBundle = {
         "- Configure dependencies in Projen configuration files (`.projenrc.ts` or `projenrc/*.ts`)",
         "- Add dependencies to `deps`, `devDeps`, or `peerDeps` arrays in project configuration",
         '- Use catalog dependencies when available (e.g., `"aws-cdk-lib@catalog:"`)',
-        "- Ask the user to run `npx projen` and `pnpm install` after updating dependency configuration",
+        "- Ask the user to run `pnpm exec projen` and `pnpm install` after updating dependency configuration",
         "",
         "**DO NOT:**",
         "- Run `npm install some-package`",
@@ -7015,11 +7015,11 @@ var projenBundle = {
         "After modifying any file in `projenrc/` or `.projenrc.ts`, regenerate project files:",
         "",
         "```sh",
-        "npx projen",
+        "pnpm exec projen",
         "pnpm install",
         "```",
         "",
-        "Both steps are required \u2014 `npx projen` regenerates files, `pnpm install` updates the lockfile to match.",
+        "Both steps are required \u2014 `pnpm exec projen` regenerates files, `pnpm install` updates the lockfile to match.",
         "",
         "## Building",
         "",
@@ -7100,7 +7100,7 @@ var projenBundle = {
         "After finishing implementation work, validate that changes are correct by running the appropriate commands depending on what was changed:",
         "",
         "1. **Projen config changes** (`projenrc/`, `.projenrc.ts`):",
-        "   - Run `npx projen` then `pnpm install`",
+        "   - Run `pnpm exec projen` then `pnpm install`",
         "   - Verify no unexpected generated file changes with `git diff`",
         "",
         "2. **Source code changes** (in a sub-package):",
@@ -7117,7 +7117,7 @@ var projenBundle = {
         "",
         "| Task | Command |",
         "|------|---------|",
-        "| Synthesize projen | `npx projen` |",
+        "| Synthesize projen | `pnpm exec projen` |",
         "| Install deps | `pnpm install` |",
         "| Full monorepo build | `pnpm build:all` |",
         "| Root build only | `pnpm build` |",
@@ -7143,7 +7143,7 @@ var projenBundle = {
       content: [
         "# Customizing Agent Rules",
         "",
-        "Agent rules for Claude and Cursor are **generated** by configulator's `AgentConfig` component. The generated output files (`.claude/rules/`, `.cursor/rules/`, `CLAUDE.md`) must not be edited directly \u2014 they are overwritten on every `npx projen` run.",
+        "Agent rules for Claude and Cursor are **generated** by configulator's `AgentConfig` component. The generated output files (`.claude/rules/`, `.cursor/rules/`, `CLAUDE.md`) must not be edited directly \u2014 they are overwritten on every `pnpm exec projen` run.",
         "",
         "## Adding Repo-Specific Rules",
         "",
@@ -7176,7 +7176,7 @@ var projenBundle = {
         "",
         "## After Any Change",
         "",
-        "Run `npx projen` then `pnpm install` to regenerate the output files."
+        "Run `pnpm exec projen` then `pnpm install` to regenerate the output files."
       ].join("\n"),
       tags: ["workflow"]
     },
@@ -7194,7 +7194,7 @@ var projenBundle = {
         "- Edit Projen configuration in:",
         "  - `.projenrc.ts` (root)",
         "  - `projenrc/*.ts` (package-specific)",
-        "- After making Projen changes, run `npx projen` to synthesize",
+        "- After making Projen changes, run `pnpm exec projen` to synthesize",
         "",
         "## Workspace Dependencies",
         "",
@@ -15487,6 +15487,77 @@ import {
 } from "projen/lib/typescript";
 import { merge } from "ts-deepmerge";
 
+// src/projects/monorepo-layout.ts
+var MONOREPO_LAYOUT = {
+  DOCS: "docs",
+  APPS: "apps",
+  PACKAGES: "packages",
+  SITES: "sites"
+};
+var LAYOUT_ENFORCEMENT = {
+  OFF: "off",
+  WARN: "warn",
+  ERROR: "error"
+};
+var LAYOUT_ROOT_BY_PROJECT_TYPE = {
+  TypeScriptProject: MONOREPO_LAYOUT.PACKAGES,
+  AwsCdkProject: MONOREPO_LAYOUT.APPS,
+  AstroProject: MONOREPO_LAYOUT.SITES,
+  StarlightProject: MONOREPO_LAYOUT.DOCS
+};
+function validateMonorepoLayout(root) {
+  const violations = [];
+  const rootOutdir = toPosix(root.outdir);
+  for (const sub of root.subprojects) {
+    const className = sub.constructor.name;
+    const expectedRoot = LAYOUT_ROOT_BY_PROJECT_TYPE[className];
+    if (expectedRoot === void 0) {
+      continue;
+    }
+    const relOutdir = relativeOutdir(rootOutdir, toPosix(sub.outdir));
+    if (!outdirMatchesRoot(relOutdir, expectedRoot)) {
+      violations.push({
+        projectName: sub.name,
+        projectType: className,
+        outdir: relOutdir,
+        expectedRoot
+      });
+    }
+  }
+  return violations;
+}
+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 outdirMatchesRoot(relOutdir, expectedRoot) {
+  const segments = relOutdir.split("/").filter((s) => s.length > 0);
+  if (segments.length === 0) {
+    return false;
+  }
+  if (segments[0] !== expectedRoot) {
+    return false;
+  }
+  if (expectedRoot === MONOREPO_LAYOUT.DOCS) {
+    return true;
+  }
+  return segments.length >= 2;
+}
+function toPosix(p) {
+  return p.replace(/\\/g, "/");
+}
+function relativeOutdir(rootOutdir, subOutdir) {
+  if (subOutdir === rootOutdir) {
+    return "";
+  }
+  const prefix2 = rootOutdir.endsWith("/") ? rootOutdir : `${rootOutdir}/`;
+  if (subOutdir.startsWith(prefix2)) {
+    return subOutdir.slice(prefix2.length);
+  }
+  return subOutdir;
+}
+
 // src/tasks/reset-task.ts
 import { Component as Component13 } from "projen";
 var ResetTask = class _ResetTask extends Component13 {
@@ -15995,6 +16066,11 @@ var MonorepoProject = class extends TypeScriptAppProject {
        * By default treat as a registry consumer (upgrade workflow syncs configulator).
        */
       configulatorRegistryConsumer: true,
+      /**
+       * ADR-006 layout enforcement defaults to "warn" during rollout so
+       * legacy outdirs log actionable warnings but do not break synth.
+       */
+      layoutEnforcement: LAYOUT_ENFORCEMENT.WARN,
       /**
        * We don't want sample code generated for the root project.
        */
@@ -16108,6 +16184,7 @@ var MonorepoProject = class extends TypeScriptAppProject {
     this.tsconfig?.removeInclude(`${this.srcdir}/**/*.ts`);
     this.pnpmVersion = options.pnpmVersion;
     this.configulatorRegistryConsumer = options.configulatorRegistryConsumer ?? true;
+    this.layoutEnforcement = options.layoutEnforcement ?? LAYOUT_ENFORCEMENT.WARN;
     new VSCodeConfig(this);
     new PnpmWorkspace(this, options.pnpmOptions?.pnpmWorkspaceOptions);
     if (options.turbo) {
@@ -16202,6 +16279,32 @@ var MonorepoProject = class extends TypeScriptAppProject {
       );
     }
   }
+  /**
+   * Validate sub-project `outdir` values against the ADR-006 monorepo
+   * layout contract. Runs in `preSynthesize` so all sub-projects are
+   * attached by the time we inspect the tree.
+   *
+   * Behavior is controlled by `layoutEnforcement`:
+   * - `"off"`  — skip validation.
+   * - `"warn"` — log a `console.warn` per violation; continue.
+   * - `"error"` — throw on the first violation.
+   */
+  preSynthesize() {
+    super.preSynthesize();
+    if (this.layoutEnforcement === LAYOUT_ENFORCEMENT.OFF) {
+      return;
+    }
+    const violations = validateMonorepoLayout(this);
+    if (violations.length === 0) {
+      return;
+    }
+    if (this.layoutEnforcement === LAYOUT_ENFORCEMENT.ERROR) {
+      throw new Error(formatLayoutViolation(violations[0]));
+    }
+    for (const violation of violations) {
+      console.warn(formatLayoutViolation(violation));
+    }
+  }
   /**
    * Allows a sub project to request installation of dependency at the Monorepo root
    * They must provide a function that is executed after dependencies have been installed
@@ -17322,10 +17425,13 @@ export {
   DEFAULT_TEARDOWN_BRANCH_PATTERNS,
   DEFAULT_TYPE_LABELS,
   JsiiFaker,
+  LAYOUT_ENFORCEMENT,
+  LAYOUT_ROOT_BY_PROJECT_TYPE,
   MCP_TRANSPORT,
   MERGE_METHODS,
   MIMIMUM_RELEASE_AGE,
   MINIMUM_RELEASE_AGE,
+  MONOREPO_LAYOUT,
   MonorepoProject,
   PROD_DEPLOY_NAME,
   PnpmWorkspace,
@@ -17352,6 +17458,7 @@ export {
   baseBundle,
   bcmWriterBundle,
   companyProfileBundle,
+  formatLayoutViolation,
   getLatestEligibleVersion,
   githubWorkflowBundle,
   industryDiscoveryBundle,
@@ -17373,6 +17480,7 @@ export {
   softwareProfileBundle,
   turborepoBundle,
   typescriptBundle,
+  validateMonorepoLayout,
   vitestBundle
 };
 //# sourceMappingURL=index.mjs.map