@codedrifters/configulator 0.0.248 → 0.0.249
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/index.js +30 -1
- package/lib/index.js.map +1 -1
- package/lib/index.mjs +30 -1
- package/lib/index.mjs.map +1 -1
- package/package.json +1 -1
package/lib/index.js
CHANGED
|
@@ -959,7 +959,36 @@ var baseBundle = {
|
|
|
959
959
|
"- **Never edit generated files** \u2014 they are marked with `// ~~ Generated by projen`",
|
|
960
960
|
"- **After modifying Projen configuration**, run `pnpm exec projen` to regenerate files, then `pnpm install` to update the lockfile.",
|
|
961
961
|
"- **Configure dependencies through Projen** \u2014 never use `npm install`, `pnpm add`, or `yarn add`. Add them to `deps` or `devDeps` in Projen config.",
|
|
962
|
-
"- **Export from index.ts** to maintain clean public APIs"
|
|
962
|
+
"- **Export from index.ts** to maintain clean public APIs",
|
|
963
|
+
"",
|
|
964
|
+
"## Repository Layout",
|
|
965
|
+
"",
|
|
966
|
+
"Every monorepo built with `@codedrifters/configulator` uses a fixed",
|
|
967
|
+
"top-level folder layout. Read a sub-project's role directly from its",
|
|
968
|
+
"outdir:",
|
|
969
|
+
"",
|
|
970
|
+
"| Folder | Purpose |",
|
|
971
|
+
"|--------|---------|",
|
|
972
|
+
"| `/docs` | **Single** monorepo-wide Starlight docs site (the one site that lives outside `/sites`). |",
|
|
973
|
+
"| `/apps/@scope/<name>` | Deployable applications (CDK stacks, mobile apps, backend services). |",
|
|
974
|
+
"| `/packages/@scope/<name>` | Shared libraries (published npm packages and workspace-internal libraries). |",
|
|
975
|
+
"| `/sites/@scope/<name>` | User-facing web front ends that are **not** the monorepo-wide docs site. |",
|
|
976
|
+
"",
|
|
977
|
+
"Every sub-project under `apps/`, `packages/`, or `sites/` is named",
|
|
978
|
+
"`@ownerscope/<name>`, where **scope is the owning party** (not a",
|
|
979
|
+
"category). Kind is captured by the top-level folder \u2014 never scope by",
|
|
980
|
+
"category (e.g. `@apps/foo`, `@libs/bar`).",
|
|
981
|
+
"",
|
|
982
|
+
"To place a **new** sub-project, always use a scaffolding skill \u2014 never",
|
|
983
|
+
"hand-roll the path:",
|
|
984
|
+
"",
|
|
985
|
+
"- `/create-package` \u2014 new shared library under `packages/<scope>/<name>`",
|
|
986
|
+
"- `/create-app` \u2014 new deployable app under `apps/<scope>/<name>`",
|
|
987
|
+
"- `/create-site` \u2014 new web front end under `sites/<scope>/<name>`",
|
|
988
|
+
"",
|
|
989
|
+
"The `monorepo-layout` rule documents the full contract (outdir",
|
|
990
|
+
"defaults per project type, the docs-singleton carve-out, synth-time",
|
|
991
|
+
"enforcement)."
|
|
963
992
|
].join("\n"),
|
|
964
993
|
tags: ["project"]
|
|
965
994
|
},
|