@cbnventures/nova 0.33.0 → 0.34.0
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/bin/nova.mjs +5 -2
- package/build/package.json +3 -2
- package/build/scaffold-versions.json +21 -14
- package/build/src/api/app-store-connect.d.ts +28 -0
- package/build/src/api/app-store-connect.d.ts.map +1 -0
- package/build/src/api/app-store-connect.js +494 -0
- package/build/src/api/app-store-connect.js.map +1 -0
- package/build/src/api/google-play-console.d.ts +15 -0
- package/build/src/api/google-play-console.d.ts.map +1 -0
- package/build/src/api/google-play-console.js +136 -0
- package/build/src/api/google-play-console.js.map +1 -0
- package/build/src/cli/generate/github/workflows-blueprint-validate.d.ts +4 -2
- package/build/src/cli/generate/github/workflows-blueprint-validate.d.ts.map +1 -1
- package/build/src/cli/generate/github/workflows-blueprint-validate.js +199 -3
- package/build/src/cli/generate/github/workflows-blueprint-validate.js.map +1 -1
- package/build/src/cli/generate/github/workflows-blueprint.d.ts +6 -0
- package/build/src/cli/generate/github/workflows-blueprint.d.ts.map +1 -1
- package/build/src/cli/generate/github/workflows-blueprint.js +458 -59
- package/build/src/cli/generate/github/workflows-blueprint.js.map +1 -1
- package/build/src/cli/index.js +154 -0
- package/build/src/cli/index.js.map +1 -1
- package/build/src/cli/integration/app-store-connect.d.ts +22 -0
- package/build/src/cli/integration/app-store-connect.d.ts.map +1 -0
- package/build/src/cli/integration/app-store-connect.js +502 -0
- package/build/src/cli/integration/app-store-connect.js.map +1 -0
- package/build/src/cli/integration/discord-developer-portal.d.ts +6 -0
- package/build/src/cli/integration/discord-developer-portal.d.ts.map +1 -0
- package/build/src/cli/integration/discord-developer-portal.js +42 -0
- package/build/src/cli/integration/discord-developer-portal.js.map +1 -0
- package/build/src/cli/integration/google-play-console.d.ts +16 -0
- package/build/src/cli/integration/google-play-console.d.ts.map +1 -0
- package/build/src/cli/integration/google-play-console.js +199 -0
- package/build/src/cli/integration/google-play-console.js.map +1 -0
- package/build/src/cli/integration/index.d.ts +8 -0
- package/build/src/cli/integration/index.d.ts.map +1 -0
- package/build/src/cli/integration/index.js +139 -0
- package/build/src/cli/integration/index.js.map +1 -0
- package/build/src/cli/recipe/package-json/normalize-tooling.d.ts.map +1 -1
- package/build/src/cli/recipe/package-json/normalize-tooling.js +47 -3
- package/build/src/cli/recipe/package-json/normalize-tooling.js.map +1 -1
- package/build/src/cli/recipe/package-json/sync-identity.d.ts.map +1 -1
- package/build/src/cli/recipe/package-json/sync-identity.js +51 -18
- package/build/src/cli/recipe/package-json/sync-identity.js.map +1 -1
- package/build/src/cli/scaffold/app/android.d.ts.map +1 -1
- package/build/src/cli/scaffold/app/android.js +2 -0
- package/build/src/cli/scaffold/app/android.js.map +1 -1
- package/build/src/cli/scaffold/app/apple.d.ts.map +1 -1
- package/build/src/cli/scaffold/app/apple.js +2 -0
- package/build/src/cli/scaffold/app/apple.js.map +1 -1
- package/build/src/cli/scaffold/app/astro.d.ts.map +1 -1
- package/build/src/cli/scaffold/app/astro.js +10 -0
- package/build/src/cli/scaffold/app/astro.js.map +1 -1
- package/build/src/cli/scaffold/app/discord-bot.d.ts.map +1 -1
- package/build/src/cli/scaffold/app/discord-bot.js +11 -1
- package/build/src/cli/scaffold/app/discord-bot.js.map +1 -1
- package/build/src/cli/scaffold/app/expressjs.d.ts.map +1 -1
- package/build/src/cli/scaffold/app/expressjs.js +11 -1
- package/build/src/cli/scaffold/app/expressjs.js.map +1 -1
- package/build/src/cli/scaffold/app/nextjs.d.ts.map +1 -1
- package/build/src/cli/scaffold/app/nextjs.js +4 -1
- package/build/src/cli/scaffold/app/nextjs.js.map +1 -1
- package/build/src/cli/scaffold/app/vite.d.ts.map +1 -1
- package/build/src/cli/scaffold/app/vite.js +10 -1
- package/build/src/cli/scaffold/app/vite.js.map +1 -1
- package/build/src/cli/scaffold/docs/docusaurus.d.ts.map +1 -1
- package/build/src/cli/scaffold/docs/docusaurus.js +8 -2
- package/build/src/cli/scaffold/docs/docusaurus.js.map +1 -1
- package/build/src/cli/scaffold/package/github-action.d.ts.map +1 -1
- package/build/src/cli/scaffold/package/github-action.js +4 -0
- package/build/src/cli/scaffold/package/github-action.js.map +1 -1
- package/build/src/cli/scaffold/package/homebridge.d.ts.map +1 -1
- package/build/src/cli/scaffold/package/homebridge.js +1 -0
- package/build/src/cli/scaffold/package/homebridge.js.map +1 -1
- package/build/src/cli/scaffold/package/pfsense.d.ts.map +1 -1
- package/build/src/cli/scaffold/package/pfsense.js +1 -0
- package/build/src/cli/scaffold/package/pfsense.js.map +1 -1
- package/build/src/cli/scaffold/starter/base.d.ts.map +1 -1
- package/build/src/cli/scaffold/starter/base.js +2 -1
- package/build/src/cli/scaffold/starter/base.js.map +1 -1
- package/build/src/cli/scaffold/tool/serverless.d.ts.map +1 -1
- package/build/src/cli/scaffold/tool/serverless.js +5 -0
- package/build/src/cli/scaffold/tool/serverless.js.map +1 -1
- package/build/src/cli/utility/changelog.d.ts +2 -0
- package/build/src/cli/utility/changelog.d.ts.map +1 -1
- package/build/src/cli/utility/changelog.js +225 -129
- package/build/src/cli/utility/changelog.js.map +1 -1
- package/build/src/cli/utility/configure.d.ts.map +1 -1
- package/build/src/cli/utility/configure.js +251 -42
- package/build/src/cli/utility/configure.js.map +1 -1
- package/build/src/lib/docker-packaging.d.ts +22 -1
- package/build/src/lib/docker-packaging.d.ts.map +1 -1
- package/build/src/lib/docker-packaging.js +1044 -76
- package/build/src/lib/docker-packaging.js.map +1 -1
- package/build/src/lib/file-discovery.js +1 -1
- package/build/src/lib/file-discovery.js.map +1 -1
- package/build/src/lib/ignore-files.d.ts.map +1 -1
- package/build/src/lib/ignore-files.js +4 -1
- package/build/src/lib/ignore-files.js.map +1 -1
- package/build/src/lib/integration.d.ts +14 -0
- package/build/src/lib/integration.d.ts.map +1 -0
- package/build/src/lib/integration.js +323 -0
- package/build/src/lib/integration.js.map +1 -0
- package/build/src/lib/nova-config.d.ts.map +1 -1
- package/build/src/lib/nova-config.js +22 -3
- package/build/src/lib/nova-config.js.map +1 -1
- package/build/src/lib/package-scripts.d.ts.map +1 -1
- package/build/src/lib/package-scripts.js +2 -1
- package/build/src/lib/package-scripts.js.map +1 -1
- package/build/src/lib/regex.d.ts +8 -0
- package/build/src/lib/regex.d.ts.map +1 -1
- package/build/src/lib/regex.js +10 -2
- package/build/src/lib/regex.js.map +1 -1
- package/build/src/lib/release-history.d.ts +2 -1
- package/build/src/lib/release-history.d.ts.map +1 -1
- package/build/src/lib/release-history.js +18 -0
- package/build/src/lib/release-history.js.map +1 -1
- package/build/src/lib/run-workspaces.d.ts +2 -0
- package/build/src/lib/run-workspaces.d.ts.map +1 -1
- package/build/src/lib/run-workspaces.js +121 -1
- package/build/src/lib/run-workspaces.js.map +1 -1
- package/build/src/lib/scaffold-allow-scripts.d.ts +4 -0
- package/build/src/lib/scaffold-allow-scripts.d.ts.map +1 -0
- package/build/src/lib/scaffold-allow-scripts.js +76 -0
- package/build/src/lib/scaffold-allow-scripts.js.map +1 -0
- package/build/src/lib/scaffold.d.ts +3 -2
- package/build/src/lib/scaffold.d.ts.map +1 -1
- package/build/src/lib/scaffold.js +177 -33
- package/build/src/lib/scaffold.js.map +1 -1
- package/build/src/lib/transpile.d.ts.map +1 -1
- package/build/src/lib/transpile.js +6 -5
- package/build/src/lib/transpile.js.map +1 -1
- package/build/src/lib/type-check.d.ts +3 -1
- package/build/src/lib/type-check.d.ts.map +1 -1
- package/build/src/lib/type-check.js +22 -6
- package/build/src/lib/type-check.js.map +1 -1
- package/build/src/lib/utility.d.ts.map +1 -1
- package/build/src/lib/utility.js +0 -7
- package/build/src/lib/utility.js.map +1 -1
- package/build/src/lib/version-contract.d.ts +7 -0
- package/build/src/lib/version-contract.d.ts.map +1 -0
- package/build/src/lib/version-contract.js +80 -0
- package/build/src/lib/version-contract.js.map +1 -0
- package/build/src/lib/version-strategy-migration.d.ts +6 -0
- package/build/src/lib/version-strategy-migration.d.ts.map +1 -0
- package/build/src/lib/version-strategy-migration.js +208 -0
- package/build/src/lib/version-strategy-migration.js.map +1 -0
- package/build/src/lib/workflow-templates.d.ts.map +1 -1
- package/build/src/lib/workflow-templates.js +22 -1
- package/build/src/lib/workflow-templates.js.map +1 -1
- package/build/src/presets/eslint/dx-ignore.d.ts.map +1 -1
- package/build/src/presets/eslint/dx-ignore.js +7 -0
- package/build/src/presets/eslint/dx-ignore.js.map +1 -1
- package/build/src/types/api/app-store-connect.d.ts +427 -0
- package/build/src/types/api/google-play-console.d.ts +146 -0
- package/build/src/types/cli/generate/github/workflows-blueprint-validate.d.ts +61 -0
- package/build/src/types/cli/generate/github/workflows-blueprint.d.ts +90 -12
- package/build/src/types/cli/index.d.ts +8 -0
- package/build/src/types/cli/integration/app-store-connect.d.ts +353 -0
- package/build/src/types/cli/integration/discord-developer-portal.d.ts +36 -0
- package/build/src/types/cli/integration/google-play-console.d.ts +145 -0
- package/build/src/types/cli/integration/index.d.ts +31 -0
- package/build/src/types/cli/recipe/package-json/normalize-tooling.d.ts +16 -0
- package/build/src/types/cli/recipe/package-json/sync-identity.d.ts +9 -0
- package/build/src/types/cli/utility/changelog.d.ts +149 -0
- package/build/src/types/cli/utility/configure.d.ts +122 -3
- package/build/src/types/lib/docker-packaging.d.ts +447 -47
- package/build/src/types/lib/integration.d.ts +264 -0
- package/build/src/types/lib/nova-config.d.ts +9 -0
- package/build/src/types/lib/package-scripts.d.ts +2 -0
- package/build/src/types/lib/release-history.d.ts +15 -0
- package/build/src/types/lib/run-workspaces.d.ts +117 -0
- package/build/src/types/lib/scaffold-allow-scripts.d.ts +54 -0
- package/build/src/types/lib/scaffold.d.ts +108 -2
- package/build/src/types/lib/transpile.d.ts +2 -0
- package/build/src/types/lib/type-check.d.ts +28 -0
- package/build/src/types/lib/utility.d.ts +0 -13
- package/build/src/types/lib/version-contract.d.ts +84 -0
- package/build/src/types/lib/version-strategy-migration.d.ts +207 -0
- package/build/src/types/shared.d.ts +456 -1
- package/build/src/types/tests/cli/generate/github/workflows-blueprint-validate.test.d.ts +49 -0
- package/build/src/types/tests/cli/generate/github/workflows-version-contract.test.d.ts +65 -0
- package/build/src/types/tests/cli/generate/must-haves/agent-conventions.test.d.ts +4 -0
- package/build/src/types/tests/cli/integration.test.d.ts +97 -0
- package/build/src/types/tests/cli/recipe/package-json/normalize-tooling.test.d.ts +21 -0
- package/build/src/types/tests/cli/recipe/package-json/sync-identity-version-contract.test.d.ts +57 -0
- package/build/src/types/tests/cli/scaffold/app/android.test.d.ts +8 -0
- package/build/src/types/tests/cli/scaffold/app/apple.test.d.ts +6 -0
- package/build/src/types/tests/cli/scaffold/app/expressjs.test.d.ts +4 -0
- package/build/src/types/tests/cli/utility/changelog-android.test.d.ts +48 -0
- package/build/src/types/tests/cli/utility/changelog-apple.test.d.ts +72 -0
- package/build/src/types/tests/cli/utility/changelog.test.d.ts +16 -12
- package/build/src/types/tests/cli/utility/configure.test.d.ts +88 -0
- package/build/src/types/tests/cli/utility/run-scripts.test.d.ts +2 -0
- package/build/src/types/tests/cli/utility/run-workspaces.test.d.ts +48 -0
- package/build/src/types/tests/lib/docker-packaging.test.d.ts +169 -27
- package/build/src/types/tests/lib/ignore-files.test.d.ts +2 -0
- package/build/src/types/tests/lib/integration.test.d.ts +60 -0
- package/build/src/types/tests/lib/nova-config.test.d.ts +17 -0
- package/build/src/types/tests/lib/scaffold-allow-scripts.test.d.ts +14 -0
- package/build/src/types/tests/lib/scaffold-version-contract.test.d.ts +59 -0
- package/build/src/types/tests/lib/scaffold.test.d.ts +14 -0
- package/build/src/types/tests/lib/type-check.test.d.ts +26 -0
- package/build/src/types/tests/lib/utility.test.d.ts +21 -0
- package/build/src/types/tests/lib/version-contract.test.d.ts +66 -0
- package/build/src/types/tests/lib/version-strategy-migration.test.d.ts +85 -0
- package/build/src/types/tests/lib/workflow-templates.test.d.ts +4 -0
- package/build/src/types/tests/presets/eslint/dx-ignore.test.d.ts +14 -0
- package/build/src/types/tests/scaffold-output-contract.test.d.ts +10 -0
- package/build/templates/generators/must-haves/agent-conventions/PROJECT_RULES.md +107 -196
- package/build/templates/generators/must-haves/agent-conventions/VISION.md +91 -22
- package/build/templates/generators/must-haves/agent-conventions/conventions/docker.md +4 -4
- package/build/templates/generators/must-haves/agent-conventions/conventions/documentation.md +4 -2
- package/build/templates/scaffold/app/android/package.json +2 -2
- package/build/templates/scaffold/app/android/scripts/run-gradle.mjs +21 -4
- package/build/templates/scaffold/app/apple/package.json +2 -2
- package/build/templates/scaffold/app/apple/project.yml +1 -1
- package/build/templates/scaffold/app/astro/package.json +2 -2
- package/build/templates/scaffold/app/discord-bot/package.json +2 -2
- package/build/templates/scaffold/app/express/package.json +2 -2
- package/build/templates/scaffold/app/nextjs/package.json +2 -2
- package/build/templates/scaffold/app/vite/package.json +2 -2
- package/build/templates/scaffold/docs/docusaurus/docusaurus.config.ts +2 -1
- package/build/templates/scaffold/docs/docusaurus/eslint.config.mts +61 -3
- package/build/templates/scaffold/docs/docusaurus/package.json +6 -4
- package/build/templates/scaffold/docs/docusaurus/src/pages/index.tsx +2 -2
- package/build/templates/scaffold/docs/docusaurus/src/tests/dotenv.test.ts +27 -0
- package/build/templates/scaffold/docs/docusaurus/src/tests/frontmatter.test.ts +1 -1
- package/build/templates/scaffold/docs/docusaurus/src/tests/link.test.ts +1 -1
- package/build/templates/scaffold/docs/docusaurus/src/tests/markdown-table.test.ts +1 -1
- package/build/templates/scaffold/docs/docusaurus/src/tests/terminology.test.ts +1 -1
- package/build/templates/scaffold/docs/docusaurus/src/tests/type-declarations.test.ts +1 -1
- package/build/templates/scaffold/docs/docusaurus/src/types/pages/index.d.ts +2 -2
- package/build/templates/scaffold/docs/docusaurus/tsconfig.app.json +33 -0
- package/build/templates/scaffold/docs/docusaurus/tsconfig.config.json +21 -0
- package/build/templates/scaffold/docs/docusaurus/tsconfig.json +11 -17
- package/build/templates/scaffold/docs/docusaurus/tsconfig.tests.json +28 -0
- package/build/templates/scaffold/docs/docusaurus/vitest.config.mts +1 -14
- package/build/templates/scaffold/docs/docusaurus/vitest.setup.ts +3 -3
- package/build/templates/scaffold/package/github-action/package.json +2 -2
- package/build/templates/scaffold/package/homebridge/bin/repl.mjs +5 -2
- package/build/templates/scaffold/package/homebridge/bin/test-api.mjs +5 -2
- package/build/templates/scaffold/package/homebridge/package.json +2 -2
- package/build/templates/scaffold/package/pfsense/package.json +2 -2
- package/build/templates/scaffold/starter/base/assets/README.md +7 -0
- package/build/templates/scaffold-options/app/android-native/app/build.gradle.kts +1 -1
- package/build/templates/scaffold-options/app/android-native/gradlew.bat +84 -84
- package/build/templates/scaffold-options/app/apple-store-connect-root/assets/app-store-connect/[__WORKSPACE_NAME__]/creative-assets/README.md +10 -0
- package/build/templates/scaffold-options/app/apple-store-connect-root/assets/app-store-connect/[__WORKSPACE_NAME__]/metadata/ios/en-US.json +8 -0
- package/build/templates/scaffold-options/app/apple-store-connect-root/assets/app-store-connect/[__WORKSPACE_NAME__]/metadata/macos/en-US.json +8 -0
- package/build/templates/scaffold-options/app/apple-store-connect-root/assets/app-store-connect/[__WORKSPACE_NAME__]/screenshots/README.md +13 -0
- package/build/templates/scaffold-options/app/google-play-console-root/assets/google-play-console/[__WORKSPACE_NAME__]/graphic-assets/README.md +12 -0
- package/build/templates/scaffold-options/app/google-play-console-root/assets/google-play-console/[__WORKSPACE_NAME__]/metadata/android/en-US.json +6 -0
- package/build/templates/scaffold-options/app/google-play-console-root/assets/google-play-console/[__WORKSPACE_NAME__]/screenshots/README.md +13 -0
- package/build/templates/scaffold-options/docker-image/common/Dockerfile +81 -0
- package/build/templates/scaffold-options/docker-image/common/compose.yml +21 -0
- package/build/templates/scaffold-options/docker-image/common/dockerignore +38 -0
- package/build/templates/scaffold-options/package/node-cli-core/bin/cli.mjs +5 -2
- package/build/templates/scaffold-options/tool/serverless/cloudflare-workers/package.json +2 -2
- package/build/templates/scaffold-options/tool/serverless/vercel-functions/package.json +2 -2
- package/package.json +3 -2
- package/build/templates/scaffold-options/docker-image/astro-node/Dockerfile +0 -27
- package/build/templates/scaffold-options/docker-image/astro-node/compose.yml +0 -12
- package/build/templates/scaffold-options/docker-image/background-service/compose.yml +0 -10
- package/build/templates/scaffold-options/docker-image/container-native/Dockerfile +0 -10
- package/build/templates/scaffold-options/docker-image/container-native/compose.yml +0 -8
- package/build/templates/scaffold-options/docker-image/http-service/compose.yml +0 -11
- package/build/templates/scaffold-options/docker-image/nextjs-standalone/Dockerfile +0 -26
- package/build/templates/scaffold-options/docker-image/nextjs-standalone/compose.yml +0 -12
- package/build/templates/scaffold-options/docker-image/node/Dockerfile +0 -23
- package/build/templates/scaffold-options/docker-image/static-site/Dockerfile +0 -18
- package/build/templates/scaffold-options/docker-image/static-site/compose.yml +0 -8
|
@@ -134,6 +134,10 @@ export type Tests_ScaffoldOutputContract_VerifyGeneratedOutput_TsconfigRaw = str
|
|
|
134
134
|
|
|
135
135
|
export type Tests_ScaffoldOutputContract_VerifyGeneratedOutput_Tsconfig = Record<string, unknown>;
|
|
136
136
|
|
|
137
|
+
export type Tests_ScaffoldOutputContract_VerifyGeneratedOutput_TsconfigReferences = unknown;
|
|
138
|
+
|
|
139
|
+
export type Tests_ScaffoldOutputContract_VerifyGeneratedOutput_TsconfigFileList = unknown;
|
|
140
|
+
|
|
137
141
|
export type Tests_ScaffoldOutputContract_VerifyGeneratedOutput_TsconfigExtends = string[];
|
|
138
142
|
|
|
139
143
|
export type Tests_ScaffoldOutputContract_VerifyGeneratedOutput_PackageJsonIndex = number;
|
|
@@ -199,6 +203,10 @@ export type Tests_ScaffoldOutputContract_VerifyScriptContract_HasParent = boolea
|
|
|
199
203
|
|
|
200
204
|
export type Tests_ScaffoldOutputContract_VerifyScriptContract_ParentIndex = number;
|
|
201
205
|
|
|
206
|
+
export type Tests_ScaffoldOutputContract_VerifyScriptContract_WorkspaceParentCommand = string;
|
|
207
|
+
|
|
208
|
+
export type Tests_ScaffoldOutputContract_VerifyScriptContract_RootParentCommand = string;
|
|
209
|
+
|
|
202
210
|
export type Tests_ScaffoldOutputContract_VerifyScriptContract_ExpectedParentCommand = string;
|
|
203
211
|
|
|
204
212
|
export type Tests_ScaffoldOutputContract_VerifyScriptContract_ExpectedGroupNames = string[];
|
|
@@ -242,6 +250,8 @@ export type Tests_ScaffoldOutputContract_VerifyStarterContract_GeneratedRootPack
|
|
|
242
250
|
|
|
243
251
|
export type Tests_ScaffoldOutputContract_VerifyStarterContract_GeneratedPackageJsonRecipeNames = string[];
|
|
244
252
|
|
|
253
|
+
export type Tests_ScaffoldOutputContract_VerifyStarterContract_GeneratedAllowScripts = Record<string, boolean>;
|
|
254
|
+
|
|
245
255
|
export type Tests_ScaffoldOutputContract_VerifyStarterContract_GeneratedDependencies = Record<string, unknown>;
|
|
246
256
|
|
|
247
257
|
export type Tests_ScaffoldOutputContract_VerifyStarterContract_GeneratedDevDependencies = Record<string, unknown>;
|
|
@@ -1,97 +1,62 @@
|
|
|
1
1
|
# PROJECT_RULES.md
|
|
2
2
|
|
|
3
|
+
<!--
|
|
4
|
+
PROJECT_RULES.md records the repository's current, enforceable operating contract. Describe what
|
|
5
|
+
exists and how contributors work with it today. Product aspirations, future capabilities, and
|
|
6
|
+
unresolved product decisions belong in VISION.md.
|
|
7
|
+
|
|
8
|
+
Keep the top-level sections below in this order. If an enforceable repository rule does not fit a
|
|
9
|
+
canonical section, add a descriptive third-level heading under "Additional Project Rules" rather
|
|
10
|
+
than creating another second-level section. Do not hard-code tool, dependency, platform, or
|
|
11
|
+
release versions; point to the authoritative manifest or configuration instead.
|
|
12
|
+
-->
|
|
13
|
+
|
|
3
14
|
## Project Identity
|
|
4
15
|
|
|
5
16
|
### Name and Description
|
|
6
17
|
|
|
7
18
|
<!--
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
- **Project name:** Name
|
|
19
|
+
- **Project name:** Canonical name.
|
|
11
20
|
- **Description:** One-line description.
|
|
12
|
-
- **Primary
|
|
13
|
-
- **
|
|
21
|
+
- **Primary languages:** Languages used by the repository.
|
|
22
|
+
- **Frameworks / runtimes:** Frameworks and runtimes used by the repository.
|
|
14
23
|
-->
|
|
15
24
|
|
|
16
25
|
### Repository URL
|
|
17
26
|
|
|
18
|
-
<!--
|
|
19
|
-
The full GitHub URL for this repository.
|
|
27
|
+
<!-- - **URL:** Full canonical repository URL. -->
|
|
20
28
|
|
|
21
|
-
|
|
22
|
-
-->
|
|
29
|
+
## Repository Structure
|
|
23
30
|
|
|
24
|
-
|
|
31
|
+
### Repository Layout
|
|
25
32
|
|
|
26
33
|
<!--
|
|
27
|
-
|
|
34
|
+
Show the root and the first useful level of every owned directory. Include important root files
|
|
35
|
+
and annotate each entry with its current responsibility. Do not list generated dependency or
|
|
36
|
+
build directories.
|
|
28
37
|
|
|
29
|
-
```
|
|
30
|
-
|
|
31
|
-
├──
|
|
32
|
-
├──
|
|
33
|
-
├──
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
│ ├── types/ — TypeScript type definitions (.d.ts)
|
|
37
|
-
│ └── tests/ — Unit and integration tests
|
|
38
|
-
├── scripts/ — Build, deploy, and maintenance scripts
|
|
39
|
-
├── .editorconfig — Editor formatting rules
|
|
40
|
-
├── .gitignore — Git ignore patterns
|
|
41
|
-
├── CHANGELOG.md — Release history
|
|
42
|
-
├── LICENSE — MIT license
|
|
43
|
-
├── README.md — Project overview and badges
|
|
44
|
-
├── package.json — Node.js manifest and scripts
|
|
45
|
-
└── tsconfig.json — TypeScript compiler configuration
|
|
38
|
+
```text
|
|
39
|
+
repository/
|
|
40
|
+
├── apps/ — Deployable application workspaces
|
|
41
|
+
├── packages/ — Reusable package workspaces
|
|
42
|
+
├── scripts/ — Repository maintenance scripts
|
|
43
|
+
├── nova.config.json — Nova project and workspace configuration
|
|
44
|
+
└── package.json — Root workspace manifest
|
|
46
45
|
```
|
|
47
46
|
-->
|
|
48
47
|
|
|
49
|
-
|
|
48
|
+
### Source Structure
|
|
50
49
|
|
|
51
|
-
<!--
|
|
52
|
-
A detailed directory tree of the primary source folder (e.g. `src/`, `app/`, `lib/`). Go as deep as needed to show every module, grouped by domain. Annotate each file or folder with its responsibility.
|
|
50
|
+
<!-- Describe each source root deeply enough that a contributor can find the correct ownership boundary without searching the entire repository. -->
|
|
53
51
|
|
|
54
|
-
|
|
55
|
-
src/
|
|
56
|
-
├── cli/
|
|
57
|
-
│ ├── commands/
|
|
58
|
-
│ │ ├── build.ts — `build` command handler
|
|
59
|
-
│ │ └── publish.ts — `publish` command handler
|
|
60
|
-
│ └── index.ts — CLI entry point, argument parsing
|
|
61
|
-
├── lib/
|
|
62
|
-
│ ├── config.ts — Configuration loader and validator
|
|
63
|
-
│ ├── schema.ts — Zod schemas for external API responses
|
|
64
|
-
│ └── regex.ts — Shared regex patterns
|
|
65
|
-
├── toolkit/
|
|
66
|
-
│ ├── logger.ts — Structured logging utility
|
|
67
|
-
│ ├── markdown-table.ts — Markdown table builder
|
|
68
|
-
│ └── index.ts — Barrel exports for toolkit
|
|
69
|
-
├── types/
|
|
70
|
-
│ ├── cli/
|
|
71
|
-
│ │ └── commands.d.ts — Types for CLI commands
|
|
72
|
-
│ ├── lib/
|
|
73
|
-
│ │ └── config.d.ts — Types for configuration
|
|
74
|
-
│ └── shared.d.ts — Shared type aliases
|
|
75
|
-
└── tests/
|
|
76
|
-
├── cli/
|
|
77
|
-
│ └── commands.test.ts
|
|
78
|
-
└── lib/
|
|
79
|
-
└── config.test.ts
|
|
80
|
-
```
|
|
81
|
-
-->
|
|
82
|
-
|
|
83
|
-
## Key Files
|
|
52
|
+
### Key Files
|
|
84
53
|
|
|
85
54
|
<!--
|
|
86
|
-
List the
|
|
87
|
-
|
|
88
|
-
| File
|
|
89
|
-
|
|
90
|
-
|
|
|
91
|
-
| `src/lib/config.ts` | Config loader | Changing configuration shape or defaults |
|
|
92
|
-
| `package.json` | Manifest | Adding dependencies, changing scripts, bumping version |
|
|
93
|
-
| `tsconfig.json` | TS config | Changing compiler options or path aliases |
|
|
94
|
-
| `CHANGELOG.md` | Release notes | Every user-facing change |
|
|
55
|
+
List the files a contributor or agent must understand before changing the repository.
|
|
56
|
+
|
|
57
|
+
| File | Purpose | When to modify |
|
|
58
|
+
|------|---------|----------------|
|
|
59
|
+
| Path | Purpose | Trigger |
|
|
95
60
|
-->
|
|
96
61
|
|
|
97
62
|
## Build and Tooling
|
|
@@ -99,192 +64,138 @@ List the most important files a contributor or AI agent should know about. Inclu
|
|
|
99
64
|
### Prerequisites
|
|
100
65
|
|
|
101
66
|
<!--
|
|
102
|
-
|
|
67
|
+
Reference authoritative version declarations rather than copying mutable version numbers.
|
|
103
68
|
|
|
104
|
-
| Tool
|
|
105
|
-
|
|
106
|
-
|
|
|
107
|
-
| npm | >= 10.x | Package manager |
|
|
108
|
-
| Docker | >= 27.x | Container builds (optional) |
|
|
69
|
+
| Tool | Version source | Purpose |
|
|
70
|
+
|------|--------------------------------|---------|
|
|
71
|
+
| Tool | Manifest or configuration path | Purpose |
|
|
109
72
|
-->
|
|
110
73
|
|
|
111
74
|
### Commands
|
|
112
75
|
|
|
113
76
|
<!--
|
|
114
|
-
List
|
|
115
|
-
|
|
116
|
-
| Command
|
|
117
|
-
|
|
118
|
-
|
|
|
119
|
-
| `npm run build` | Compile TypeScript to JavaScript |
|
|
120
|
-
| `npm run dev` | Start development server with hot reload |
|
|
121
|
-
| `npm run lint` | Run ESLint across the project |
|
|
122
|
-
| `npm test` | Run the test suite |
|
|
77
|
+
List the exact supported commands and the directory from which they run.
|
|
78
|
+
|
|
79
|
+
| Command | What it does |
|
|
80
|
+
|---------|--------------|
|
|
81
|
+
| Command | Behavior |
|
|
123
82
|
-->
|
|
124
83
|
|
|
125
84
|
### Environment Variables
|
|
126
85
|
|
|
127
86
|
<!--
|
|
128
|
-
List every environment variable the
|
|
87
|
+
List every environment variable the repository reads. Explain its source, sensitivity, and whether
|
|
88
|
+
it is required. State "None" when the repository reads no environment variables.
|
|
129
89
|
|
|
130
|
-
| Variable
|
|
131
|
-
|
|
132
|
-
|
|
|
133
|
-
| `LOG_LEVEL` | No | Logging verbosity (default: `info`) |
|
|
90
|
+
| Variable | Required | Sensitive | Purpose |
|
|
91
|
+
|----------|----------|-----------|---------|
|
|
92
|
+
| Variable | Yes / No | Yes / No | Purpose |
|
|
134
93
|
-->
|
|
135
94
|
|
|
136
95
|
## Workspace Rules
|
|
137
96
|
|
|
138
|
-
###
|
|
97
|
+
### Workspace Inventory
|
|
139
98
|
|
|
140
|
-
<!--
|
|
141
|
-
Summarize the naming rules that apply specifically to this project (beyond the universal conventions). Include examples.
|
|
99
|
+
<!-- List every Nova workspace, its role, its policy, and its responsibility. -->
|
|
142
100
|
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
101
|
+
### Versioning and Release Model
|
|
102
|
+
|
|
103
|
+
<!-- Explain which workspaces are versioned, how their version strategies relate, and where those strategies are configured. Do not copy a mutable release number. -->
|
|
104
|
+
|
|
105
|
+
### Manifest and Configuration Rules
|
|
106
|
+
|
|
107
|
+
<!-- Record repository-specific rules for manifests and configuration files, including canonical ordering, ownership, and normalization behavior. -->
|
|
108
|
+
|
|
109
|
+
### Naming Conventions
|
|
110
|
+
|
|
111
|
+
<!-- Record repository-specific naming rules that are not already owned by conventions/*.md. -->
|
|
149
112
|
|
|
150
113
|
### Do / Don't
|
|
151
114
|
|
|
152
115
|
<!--
|
|
153
|
-
|
|
116
|
+
Record enforceable repository-wide guardrails with their rationale.
|
|
154
117
|
|
|
155
118
|
**Do:**
|
|
156
|
-
- Rule
|
|
157
|
-
- Rule with rationale.
|
|
119
|
+
- Rule and rationale.
|
|
158
120
|
|
|
159
121
|
**Don't:**
|
|
160
|
-
-
|
|
161
|
-
- Anti-pattern with explanation of why.
|
|
122
|
+
- Prohibited pattern and rationale.
|
|
162
123
|
-->
|
|
163
124
|
|
|
164
|
-
##
|
|
125
|
+
## Architecture and Data
|
|
165
126
|
|
|
166
127
|
### Architecture
|
|
167
128
|
|
|
168
|
-
<!--
|
|
169
|
-
Describe the high-level architecture pattern this project follows (e.g. layered, hexagonal, MVC, CLI pipeline). Include a diagram if helpful.
|
|
129
|
+
<!-- Describe the current architectural layers, ownership boundaries, and dependency direction. -->
|
|
170
130
|
|
|
171
|
-
|
|
172
|
-
User Input
|
|
173
|
-
│
|
|
174
|
-
▼
|
|
175
|
-
CLI Layer (argument parsing, validation)
|
|
176
|
-
│
|
|
177
|
-
▼
|
|
178
|
-
Service Layer (business logic, orchestration)
|
|
179
|
-
│
|
|
180
|
-
▼
|
|
181
|
-
Data Layer (file I/O, API calls, database)
|
|
182
|
-
```
|
|
183
|
-
-->
|
|
131
|
+
### Data Flow and Ownership
|
|
184
132
|
|
|
185
|
-
|
|
133
|
+
<!-- Explain how data enters, moves through, and leaves the system, including which component owns each persistent or externally visible state. -->
|
|
186
134
|
|
|
187
|
-
|
|
188
|
-
Describe how data moves through the system from input to output. Name the key stages and the module responsible for each.
|
|
135
|
+
### Error Strategy
|
|
189
136
|
|
|
190
|
-
|
|
191
|
-
2. **Validation** — How input is validated. Module: `src/lib/config.ts`.
|
|
192
|
-
3. **Processing** — Core transformation or business logic. Module: `src/lib/processor.ts`.
|
|
193
|
-
4. **Output** — Where results go (stdout, file write, API call). Module: `src/cli/index.ts`.
|
|
194
|
-
-->
|
|
137
|
+
<!-- Explain how each architectural layer reports, propagates, records, and presents failures. -->
|
|
195
138
|
|
|
196
|
-
|
|
139
|
+
## Project Guardrails
|
|
197
140
|
|
|
198
|
-
|
|
199
|
-
How does this project handle errors at each layer? List the approach per layer.
|
|
200
|
-
|
|
201
|
-
| Layer | Strategy |
|
|
202
|
-
|--------------------|------------------------------------------------------|
|
|
203
|
-
| CLI entry point | Catch all, log, set `process.exitCode = 1`, return |
|
|
204
|
-
| Service functions | Throw on failure (caller catches) |
|
|
205
|
-
| External API calls | Zod `.parse()` for validation, try/catch for network |
|
|
206
|
-
| File I/O | try/catch, descriptive error message with file path |
|
|
207
|
-
-->
|
|
141
|
+
### Security, Privacy, and Secrets
|
|
208
142
|
|
|
209
|
-
|
|
143
|
+
<!-- Record authentication, authorization, secret-storage, privacy, and sensitive-data rules that contributors must preserve. -->
|
|
210
144
|
|
|
211
|
-
###
|
|
145
|
+
### Platform and Domain Rules
|
|
212
146
|
|
|
213
|
-
<!--
|
|
214
|
-
Which documentation framework is used, and where its source lives.
|
|
147
|
+
<!-- Record rules imposed by the project's platforms or domain. Use fourth-level subsections here when different platforms need separate rules. -->
|
|
215
148
|
|
|
216
|
-
|
|
217
|
-
- **Source directory:** `docs/`
|
|
218
|
-
- **Build output:** `docs/build/`
|
|
219
|
-
-->
|
|
149
|
+
### Compatibility
|
|
220
150
|
|
|
221
|
-
|
|
151
|
+
<!-- Identify supported environments and compatibility contracts by referencing their authoritative declarations rather than copying mutable versions. -->
|
|
222
152
|
|
|
223
|
-
|
|
224
|
-
A directory tree of the documentation source showing every page and sidebar category.
|
|
153
|
+
## Testing and Verification
|
|
225
154
|
|
|
226
|
-
|
|
227
|
-
docs/
|
|
228
|
-
├── docusaurus.config.ts — Site configuration
|
|
229
|
-
├── sidebars.ts — Sidebar navigation structure
|
|
230
|
-
├── docs/
|
|
231
|
-
│ ├── intro.md — Getting started guide
|
|
232
|
-
│ ├── installation.md — Installation instructions
|
|
233
|
-
│ ├── configuration.md — Configuration reference
|
|
234
|
-
│ └── api/
|
|
235
|
-
│ ├── overview.md — API overview
|
|
236
|
-
│ └── endpoints.md — Endpoint reference
|
|
237
|
-
└── static/
|
|
238
|
-
└── img/ — Static images
|
|
239
|
-
```
|
|
240
|
-
-->
|
|
155
|
+
### Test Strategy
|
|
241
156
|
|
|
242
|
-
|
|
157
|
+
<!-- Describe what is tested at each layer and which behaviors require regression coverage. -->
|
|
243
158
|
|
|
244
|
-
|
|
245
|
-
Commands for building and previewing the documentation site locally.
|
|
159
|
+
### Required Verification
|
|
246
160
|
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
161
|
+
<!-- List the checks required for documentation, implementation, packaging, and release changes. Reference commands defined under Build and Tooling. -->
|
|
162
|
+
|
|
163
|
+
## Documentation and Ownership
|
|
164
|
+
|
|
165
|
+
### Documentation Structure
|
|
166
|
+
|
|
167
|
+
<!-- Describe the documentation surfaces, their source directories, and the kind of information each owns. State when there is no dedicated documentation site. -->
|
|
168
|
+
|
|
169
|
+
### Ownership and Maintenance
|
|
170
|
+
|
|
171
|
+
<!-- State which files are generated, which are edited directly, and what must be updated when repository structure or behavior changes. -->
|
|
252
172
|
|
|
253
173
|
## Publishing and Deployment
|
|
254
174
|
|
|
255
175
|
### Release Process
|
|
256
176
|
|
|
257
|
-
<!--
|
|
258
|
-
Step-by-step description of how a new version goes from code to release.
|
|
259
|
-
|
|
260
|
-
1. Run the project's clean install, check, and build gates.
|
|
261
|
-
2. Preview and approve the command-generated changelog release before applying it.
|
|
262
|
-
3. Run the changelog release to fold workspace entries, bump versions, stamp sentinels, and synchronize exact internal pins.
|
|
263
|
-
4. Run check and build again.
|
|
264
|
-
5. Use a separate concise thematic commit message; it is not the same text as the changelog block.
|
|
265
|
-
6. Tag and push the release commit. The publish workflow trigger is project-config dependent; consult the generated workflow.
|
|
266
|
-
7. Build the GitHub Release notes by combining the released workspace changelog files, retaining workspace names while omitting version/date headings.
|
|
267
|
-
-->
|
|
177
|
+
<!-- Describe the current release sequence without embedding a release number or a mutable tool version. -->
|
|
268
178
|
|
|
269
179
|
### CI/CD Workflows
|
|
270
180
|
|
|
271
181
|
<!--
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
|
275
|
-
|----------------------------|--------------------|------------------------------------------|
|
|
276
|
-
| Generated publish workflow | Project-configured | Build and publish the configured targets |
|
|
277
|
-
| `lock-inactive-issues.yml` | Weekly cron | Lock issues inactive > 30 days |
|
|
182
|
+
| Workflow file | Trigger | What it does |
|
|
183
|
+
|---------------|---------|--------------|
|
|
184
|
+
| Path | Trigger | Behavior |
|
|
278
185
|
-->
|
|
279
186
|
|
|
280
187
|
### Environments
|
|
281
188
|
|
|
282
189
|
<!--
|
|
283
|
-
|
|
190
|
+
| Environment | URL / Identifier | Purpose |
|
|
191
|
+
|-------------|------------------|---------|
|
|
192
|
+
| Environment | Identifier | Purpose |
|
|
193
|
+
-->
|
|
194
|
+
|
|
195
|
+
## Additional Project Rules
|
|
284
196
|
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
| GitHub Pages | `https://owner.github.io/repo` | Documentation site |
|
|
197
|
+
<!--
|
|
198
|
+
Place genuinely repository-specific enforceable rules here under descriptive third-level headings.
|
|
199
|
+
Do not create additional second-level sections. Prefer a canonical section above whenever one fits,
|
|
200
|
+
and move historical context or future intentions to VISION.md instead of placing them here.
|
|
290
201
|
-->
|
|
@@ -1,62 +1,131 @@
|
|
|
1
1
|
# VISION.md
|
|
2
2
|
|
|
3
|
+
<!--
|
|
4
|
+
VISION.md records the durable product intent behind the repository. Describe why the project
|
|
5
|
+
exists, what it should become, and the boundaries that should continue to guide it. Current
|
|
6
|
+
repository mechanics, commands, and implementation rules belong in PROJECT_RULES.md.
|
|
7
|
+
|
|
8
|
+
Keep the top-level sections below in this order. If important vision material does not fit any
|
|
9
|
+
canonical section, add a descriptive third-level heading under "Additional Vision Notes" rather
|
|
10
|
+
than creating another second-level section. Do not hard-code tool, dependency, platform, or
|
|
11
|
+
release versions; point to their authoritative manifests or configuration when relevant.
|
|
12
|
+
-->
|
|
13
|
+
|
|
3
14
|
## Purpose
|
|
4
15
|
|
|
16
|
+
### Origin
|
|
17
|
+
|
|
18
|
+
<!-- What experience, unmet need, or recurring frustration led to this project? -->
|
|
19
|
+
|
|
5
20
|
### Problem Statement
|
|
6
21
|
|
|
7
|
-
<!-- What
|
|
22
|
+
<!-- What precise problem does this project address? Describe the gap without prescribing the implementation. -->
|
|
8
23
|
|
|
9
24
|
### Target Audience
|
|
10
25
|
|
|
11
26
|
<!--
|
|
12
|
-
Who
|
|
27
|
+
Who should benefit from this project, and who is intentionally outside its audience?
|
|
13
28
|
|
|
14
|
-
- **
|
|
15
|
-
- **
|
|
29
|
+
- **Audience** — Why this group needs the project.
|
|
30
|
+
- **Non-audience** — Why another solution would serve this group better.
|
|
16
31
|
-->
|
|
17
32
|
|
|
18
33
|
### Value Proposition
|
|
19
34
|
|
|
20
|
-
<!-- What
|
|
35
|
+
<!-- What outcome does the project provide, and why is that outcome meaningfully better than the available alternatives? -->
|
|
36
|
+
|
|
37
|
+
## Product Direction
|
|
38
|
+
|
|
39
|
+
### Principles
|
|
40
|
+
|
|
41
|
+
<!-- List the durable product beliefs and trade-offs that should guide future decisions. -->
|
|
42
|
+
|
|
43
|
+
### Scope
|
|
44
|
+
|
|
45
|
+
<!-- Define the capabilities and responsibilities that belong to this project. Describe durable boundaries rather than a release-specific checklist. -->
|
|
46
|
+
|
|
47
|
+
### Explicit Non-Goals
|
|
48
|
+
|
|
49
|
+
<!-- List responsibilities the project intentionally does not accept, with a short rationale for each. -->
|
|
50
|
+
|
|
51
|
+
## Product Design
|
|
52
|
+
|
|
53
|
+
### Core Capabilities
|
|
54
|
+
|
|
55
|
+
<!-- Describe the major user-facing capabilities and how they work together. -->
|
|
56
|
+
|
|
57
|
+
### User Experience
|
|
58
|
+
|
|
59
|
+
<!-- Describe the intended user journey, important interaction expectations, and the experience the project should create. -->
|
|
60
|
+
|
|
61
|
+
### Domain Model
|
|
62
|
+
|
|
63
|
+
<!-- Define the durable entities, relationships, states, or concepts that shape the product. Use a diagram or table when it improves clarity. -->
|
|
64
|
+
|
|
65
|
+
## Positioning
|
|
66
|
+
|
|
67
|
+
### Alternatives
|
|
68
|
+
|
|
69
|
+
<!-- Identify realistic alternatives, including doing nothing or using a manual workflow. State what each alternative does well. -->
|
|
70
|
+
|
|
71
|
+
### Differentiators
|
|
72
|
+
|
|
73
|
+
<!-- Explain the durable qualities that distinguish this project without dismissing reasonable alternatives. -->
|
|
74
|
+
|
|
75
|
+
## Risks and Future
|
|
76
|
+
|
|
77
|
+
### Risks
|
|
78
|
+
|
|
79
|
+
<!-- Record assumptions, technical constraints, adoption risks, or product risks that could materially affect success. -->
|
|
80
|
+
|
|
81
|
+
### Open Questions
|
|
82
|
+
|
|
83
|
+
<!-- Record unresolved product decisions. Remove an entry after its answer is incorporated into the appropriate canonical section. -->
|
|
84
|
+
|
|
85
|
+
### Roadmap
|
|
86
|
+
|
|
87
|
+
<!-- Describe the sequence of outcomes the project should pursue without hard-coding release numbers or dates. -->
|
|
88
|
+
|
|
89
|
+
### Success Criteria
|
|
90
|
+
|
|
91
|
+
<!-- Describe the observable outcomes that would indicate the project is succeeding or failing. -->
|
|
21
92
|
|
|
22
93
|
## Marketing Copy
|
|
23
94
|
|
|
24
95
|
### Tagline
|
|
25
96
|
|
|
26
|
-
<!-- One sentence
|
|
97
|
+
<!-- One sentence that captures the project's purpose without unsupported claims. -->
|
|
27
98
|
|
|
28
99
|
### Elevator Pitch
|
|
29
100
|
|
|
30
|
-
<!-- A short paragraph
|
|
101
|
+
<!-- A short paragraph explaining what the project does, who it serves, and why it matters. -->
|
|
31
102
|
|
|
32
103
|
### Key Features
|
|
33
104
|
|
|
34
105
|
<!--
|
|
35
|
-
List the headline
|
|
106
|
+
List the headline capabilities a prospective user should understand first.
|
|
36
107
|
|
|
37
|
-
- **Feature
|
|
38
|
-
- **Feature name** — What it does and why it matters.
|
|
39
|
-
- **Feature name** — What it does and why it matters.
|
|
108
|
+
- **Feature** — What it does and why it matters.
|
|
40
109
|
-->
|
|
41
110
|
|
|
42
|
-
###
|
|
111
|
+
### Voice
|
|
43
112
|
|
|
44
|
-
<!--
|
|
45
|
-
What sets this project apart from comparable tools or services? Focus on architectural decisions, performance characteristics, developer experience, or ecosystem fit.
|
|
46
|
-
|
|
47
|
-
| This project | Alternatives |
|
|
48
|
-
|--------------------------------|------------------------------|
|
|
49
|
-
| Difference this project offers | What alternatives do instead |
|
|
50
|
-
| Difference this project offers | What alternatives do instead |
|
|
51
|
-
-->
|
|
113
|
+
<!-- Record words, phrases, claims, or tones that product and documentation copy should use or avoid. -->
|
|
52
114
|
|
|
53
115
|
## Glossary
|
|
54
116
|
|
|
55
117
|
<!--
|
|
56
|
-
Define
|
|
118
|
+
Define domain-specific terminology that contributors and agents must use consistently.
|
|
57
119
|
|
|
58
120
|
| Term | Definition |
|
|
59
121
|
|------|-----------------------------------------------|
|
|
60
122
|
| Term | What it means in the context of this project. |
|
|
61
|
-
|
|
123
|
+
-->
|
|
124
|
+
|
|
125
|
+
## Additional Vision Notes
|
|
126
|
+
|
|
127
|
+
<!--
|
|
128
|
+
Place genuinely project-specific vision material here under descriptive third-level headings.
|
|
129
|
+
Do not create additional second-level sections. Prefer a canonical section above whenever one
|
|
130
|
+
fits, and do not use this section as a duplicate backlog or implementation log.
|
|
62
131
|
-->
|
|
@@ -24,8 +24,8 @@ FROM node
|
|
|
24
24
|
FROM node:latest
|
|
25
25
|
|
|
26
26
|
# GOOD — pinned to specific version
|
|
27
|
-
FROM node:22.
|
|
28
|
-
FROM postgres:17.
|
|
27
|
+
FROM node:24.22.0-trixie-slim
|
|
28
|
+
FROM postgres:17.11-trixie
|
|
29
29
|
```
|
|
30
30
|
|
|
31
31
|
### Multi-Stage Builds
|
|
@@ -34,14 +34,14 @@ Use named stages. Keep the final image minimal — copy only what's needed from
|
|
|
34
34
|
|
|
35
35
|
```dockerfile
|
|
36
36
|
# GOOD — named stages, minimal final image
|
|
37
|
-
FROM node:22.
|
|
37
|
+
FROM node:24.22.0-trixie-slim AS build
|
|
38
38
|
WORKDIR /app
|
|
39
39
|
COPY package.json package-lock.json ./
|
|
40
40
|
RUN npm ci
|
|
41
41
|
COPY . .
|
|
42
42
|
RUN npm run build
|
|
43
43
|
|
|
44
|
-
FROM node:22.
|
|
44
|
+
FROM node:24.22.0-trixie-slim AS runtime
|
|
45
45
|
WORKDIR /app
|
|
46
46
|
COPY --from=build /app/build ./build
|
|
47
47
|
COPY --from=build /app/package.json ./
|
package/build/templates/generators/must-haves/agent-conventions/conventions/documentation.md
CHANGED
|
@@ -6,7 +6,9 @@ Rules for writing Docusaurus MDX documentation pages.
|
|
|
6
6
|
|
|
7
7
|
### Opening Paragraph
|
|
8
8
|
|
|
9
|
-
- Every page
|
|
9
|
+
- Every page begins with its visible title, followed immediately by a single-sentence opening paragraph before any section heading.
|
|
10
|
+
- Documentation pages may synthesize the visible title from frontmatter and do not need an authored H1.
|
|
11
|
+
- Standalone MDX pages under `src/pages` must place an explicit H1 after imports and before the opening paragraph.
|
|
10
12
|
- Verb-first, states what the feature does.
|
|
11
13
|
|
|
12
14
|
```mdx
|
|
@@ -517,7 +519,7 @@ Require blank lines between specific statement patterns so code stays visually o
|
|
|
517
519
|
Enable the rule in your ESLint flat config:
|
|
518
520
|
|
|
519
521
|
```ts title="eslint.config.ts"
|
|
520
|
-
import { novaRules } from '@cbnventures/nova';
|
|
522
|
+
import { novaRules } from '@cbnventures/nova/presets/eslint';
|
|
521
523
|
|
|
522
524
|
export default [
|
|
523
525
|
...novaRules,
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "[__WORKSPACE_PACKAGE_NAME__]",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "[__WORKSPACE_VERSION__]",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"private": true,
|
|
6
6
|
"scripts": {
|
|
@@ -22,7 +22,7 @@
|
|
|
22
22
|
"node": "[__SCAFFOLD_VERSION_NODE_ENGINE__]"
|
|
23
23
|
},
|
|
24
24
|
"dependencies": {
|
|
25
|
-
"@cbnventures/nova": "0.
|
|
25
|
+
"@cbnventures/nova": "0.34.0"
|
|
26
26
|
},
|
|
27
27
|
"devDependencies": {
|
|
28
28
|
"@types/node": "[__SCAFFOLD_VERSION_TYPES_NODE_24__]",
|