@chidchanun/bcp 0.1.28 → 0.2.0

package/docs/releases/0.2.0.md

@@ -0,0 +1,146 @@
+# BCP Framework 0.2.0
+
+> **Milestone:** Framework Platform
+>
+> **Release state:** unreleased development target. Do not mark this version as published until local validation, RC checks, tagging and npm publication complete.
+
+BCP Framework `0.2.0` establishes an explicit platform baseline for the public package surface, runtime target, CLI families and documentation metadata built across the `0.1.x` releases.
+
+## Highlights
+
+### Framework platform manifest
+
+New machine-readable source:
+
+```text
+docs/platform-manifest.json
+```
+
+It records:
+
+- framework version/release state,
+- minimum Node.js and React baseline,
+- standalone production build target,
+- public application entrypoints,
+- CLI command families,
+- capability groups,
+- storage-provider families,
+- previous-baseline compatibility intent,
+- documentation contract files.
+
+The manifest is intended for tooling and `bcp-docs-web`; framework source and tests remain authoritative for runtime behavior.
+
+### Public entrypoint contract
+
+The platform baseline explicitly recognizes:
+
+```text
+bcp
+bcp/island
+bcp/cache
+bcp/config
+bcp/validation
+bcp/error
+bcp/database
+bcp/auth
+bcp/server
+bcp/server-only
+bcp/middleware
+```
+
+A new package-stage smoke check validates that prepared npm artifacts preserve the required exports before release.
+
+### Package/release consistency
+
+The `0.2.0` package validation adds checks for:
+
+- framework/create-app version parity,
+- required public exports,
+- `bcp` and `bcp-framework` executable aliases,
+- minimum Node.js engine declaration,
+- inclusion of the platform manifest/contract/migration guide/release notes,
+- docs-web version target consistency.
+
+This validation runs in addition to existing runtime, storage, hardening and Developer Experience smoke tests.
+
+### Migration guide
+
+New guide:
+
+```text
+docs/migration-0.2.md
+```
+
+The `0.2.0` milestone does not intentionally remove public entrypoints from the `0.1.29` baseline. Existing applications should still run normal upgrade validation because BCP remains pre-1.0.
+
+### Docs-web platform source
+
+`bcp-docs-web` now has two explicit machine-readable framework sources:
+
+```text
+docs/docs-web-manifest.json
+  -> navigation/routes/Markdown sources
+
+docs/platform-manifest.json
+  -> version/runtime/public-entrypoint/capability contract
+```
+
+The docs-web navigation includes the platform contract and `0.2.0` migration guide.
+
+## Runtime/build target
+
+The supported production output remains:
+
+```text
+.bcp-framework/build/
+├─ client/
+├─ public/
+└─ server/
+   └─ server.mjs
+```
+
+`0.2.0` does not yet add native `.exe`, desktop or mobile build targets.
+
+## Compatibility
+
+Compatibility goal from `0.1.29`:
+
+```text
+intentional public-entrypoint removals: none
+standalone runtime model change: none
+create-bcp-app project model change: none required
+```
+
+Projects should still run:
+
+```bash
+bcp doctor
+npm run typecheck
+npm run build
+```
+
+before production deployment after the upgrade.
+
+## Documentation
+
+New/updated platform documents:
+
+- `docs/platform-manifest.json`
+- `docs/platform-contract.md`
+- `docs/migration-0.2.md`
+- `docs/docs-web-manifest.json`
+- `docs/README.md`
+- root `README.md`
+
+## Validation required before release
+
+```bash
+npm run typecheck
+npm run test:unit
+npm run test:integration
+npm run test:package
+npm run test:e2e
+npm run rc:check
+```
+
+Do not tag or publish `v0.2.0` until these pass against the final release commit.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@chidchanun/bcp",
-  "version": "0.1.28",
+  "version": "0.2.0",
   "description": "BCP Framework - a React full-stack framework with file-based routing, SSR, APIs, middleware, islands, caching and standalone production builds.",
   "type": "module",
   "license": "MIT",

package/packages/cli/src/args.ts

@@ -8,6 +8,7 @@ export type CliCommand =
   | "routes"
   | "update"
   | "db"
+  | "generate"
   | "doctor"
   | "inspect"
   | "help"
@@ -20,6 +21,13 @@ export type DatabaseCliAction =
   | "create"
   | "help";
 
+export type GenerateCliKind =
+  | "page"
+  | "api"
+  | "middleware"
+  | "migration"
+  | "help";
+
 export interface CliOptions {
   command: CliCommand;
 
@@ -37,9 +45,15 @@ export interface CliOptions {
 
   json?: boolean;
 
+  force?: boolean;
+
   dbAction?: DatabaseCliAction;
 
   dbMigrationName?: string;
+
+  generateKind?: GenerateCliKind;
+
+  generateName?: string;
 }
 
 export function parseCliArgs(
@@ -68,12 +82,21 @@ export function parseCliArgs(
   let json =
     false;
 
+  let force =
+    false;
+
   let dbAction:
     DatabaseCliAction | undefined;
 
   let dbMigrationName:
     string | undefined;
 
+  let generateKind:
+    GenerateCliKind | undefined;
+
+  let generateName:
+    string | undefined;
+
   let commandSet = false;
 
   for (
@@ -92,6 +115,11 @@ export function parseCliArgs(
         command === "db"
       ) {
         dbAction = "help";
+      } else if (
+        commandSet &&
+        command === "generate"
+      ) {
+        generateKind = "help";
       } else {
         command = "help";
       }
@@ -224,6 +252,14 @@ export function parseCliArgs(
       continue;
     }
 
+    if (
+      argument === "--force"
+    ) {
+      force =
+        true;
+      continue;
+    }
+
     if (
       argument.startsWith("-")
     ) {
@@ -299,6 +335,45 @@ export function parseCliArgs(
       );
     }
 
+    if (
+      commandSet &&
+      command === "generate"
+    ) {
+      if (
+        generateKind === undefined
+      ) {
+        if (
+          argument === "page" ||
+          argument === "api" ||
+          argument === "middleware" ||
+          argument === "migration" ||
+          argument === "help"
+        ) {
+          generateKind =
+            argument;
+          continue;
+        }
+
+        throw new Error(
+          `Unknown generator: ${argument}`
+        );
+      }
+
+      if (
+        generateKind !== "middleware" &&
+        generateKind !== "help" &&
+        generateName === undefined
+      ) {
+        generateName =
+          argument;
+        continue;
+      }
+
+      throw new Error(
+        `Unexpected argument: ${argument}`
+      );
+    }
+
     if (commandSet) {
       throw new Error(
         `Unexpected argument: ${argument}`
@@ -312,6 +387,7 @@ export function parseCliArgs(
       argument === "routes" ||
       argument === "update" ||
       argument === "db" ||
+      argument === "generate" ||
       argument === "doctor" ||
       argument === "inspect" ||
       argument === "help" ||
@@ -349,6 +425,15 @@ export function parseCliArgs(
     );
   }
 
+  if (
+    force &&
+    command !== "generate"
+  ) {
+    throw new Error(
+      "Option --force is only valid with `bcp generate`."
+    );
+  }
+
   return {
     command,
     rootDirectory,
@@ -362,12 +447,23 @@ export function parseCliArgs(
           json: true,
         }
       : {}),
+    ...(force
+      ? {
+          force: true,
+        }
+      : {}),
     ...(command === "db"
       ? {
           dbAction,
           dbMigrationName,
         }
       : {}),
+    ...(command === "generate"
+      ? {
+          generateKind,
+          generateName,
+        }
+      : {}),
   };
 }