@wneng/create-keel 0.3.0 → 0.3.3

package/README.md

@@ -5,7 +5,32 @@
 [![license](https://img.shields.io/npm/l/@wneng/create-keel.svg)](./LICENSE)
 [![node](https://img.shields.io/node/v/@wneng/create-keel.svg)](https://nodejs.org)
 
-Scaffolder for Contract First + Vibe Coding projects following the `keel` conventions (see root `AGENTS.md`).
+Scaffolder for **Contract First + Vibe Coding** projects following the `keel` conventions (see root `AGENTS.md`).
+
+> **完整中文安装与使用指南**：[`docs/03-工程规范与研发基础设施/keel-getting-started.md`](https://gitee.com/wangneng521/keel/blob/main/docs/03-%E5%B7%A5%E7%A8%8B%E8%A7%84%E8%8C%83%E4%B8%8E%E7%A0%94%E5%8F%91%E5%9F%BA%E7%A1%80%E8%AE%BE%E6%96%BD/keel-getting-started.md)（13 节，含三档采用策略、工程规范四大类、AI 访问模式、常见故障排查）。
+
+## TL;DR
+
+```bash
+# Quickstart：创建项目（交互式）
+npx @wneng/create-keel create my-app
+
+# 推荐第一次试用：带完整样例特性
+npx @wneng/create-keel create demo --yes --sample-feature
+
+# 给已有项目加特性
+cd my-app
+npx @wneng/create-keel feature add user-signup
+
+# 完整档（To B 多客户交付）
+npx @wneng/create-keel create my-full \
+  --backend java --frontend react --mobile flutter --miniapp wechat \
+  --agent rust-desktop --deploy kubernetes --contract rest+events \
+  --ai kiro --license apache-2.0 --gitLfs --integrations \
+  --ci github --roles qa,field,data,legal-security,marketing,design \
+  --engineering-standards full \
+  --yes
+```
 
 ## Usage
 

package/dist/index.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 
 // src/version.ts
-var SCAFFOLDER_VERSION = "0.3.0";
+var SCAFFOLDER_VERSION = "0.3.3";
 
 // src/schema/options.ts
 import Ajv from "ajv";
@@ -414,6 +414,32 @@ function parseCreateArgs(args) {
   let engineeringStandards;
   let engineeringStandardsExplicit = false;
   let multiApp = false;
+  let backend;
+  let frontend;
+  let mobile;
+  let miniapp;
+  let agent;
+  let deploy;
+  let contract;
+  let ai;
+  let license;
+  let gitLfs;
+  let integrations;
+  function takeEnum(flag, next, enumValues) {
+    if (next === void 0 || next.startsWith("--")) {
+      throw new UserInputError(
+        `${flag} requires a value`,
+        `\u53EF\u9009\u503C\uFF1A${enumValues.join(" | ")}`
+      );
+    }
+    if (!enumValues.includes(next)) {
+      throw new UserInputError(
+        `invalid ${flag} value: ${JSON.stringify(next)}`,
+        `\u53EF\u9009\u503C\uFF1A${enumValues.join(" | ")}`
+      );
+    }
+    return next;
+  }
   for (let i = 0; i < args.length; i += 1) {
     const a = args[i];
     switch (a) {
@@ -438,6 +464,58 @@ function parseCreateArgs(args) {
       case "--multi-app":
         multiApp = true;
         break;
+      case "--gitLfs":
+      case "--git-lfs":
+        gitLfs = true;
+        break;
+      case "--integrations":
+        integrations = true;
+        break;
+      case "--backend": {
+        backend = takeEnum("--backend", args[i + 1], BACKEND_LANGUAGES);
+        i += 1;
+        break;
+      }
+      case "--frontend": {
+        frontend = takeEnum("--frontend", args[i + 1], FRONTEND_FRAMEWORKS);
+        i += 1;
+        break;
+      }
+      case "--mobile": {
+        mobile = takeEnum("--mobile", args[i + 1], MOBILE_KINDS);
+        i += 1;
+        break;
+      }
+      case "--miniapp": {
+        miniapp = takeEnum("--miniapp", args[i + 1], MINIAPP_KINDS);
+        i += 1;
+        break;
+      }
+      case "--agent": {
+        agent = takeEnum("--agent", args[i + 1], AGENT_KINDS);
+        i += 1;
+        break;
+      }
+      case "--deploy": {
+        deploy = takeEnum("--deploy", args[i + 1], DEPLOY_TARGETS);
+        i += 1;
+        break;
+      }
+      case "--contract": {
+        contract = takeEnum("--contract", args[i + 1], CONTRACT_KINDS);
+        i += 1;
+        break;
+      }
+      case "--ai": {
+        ai = takeEnum("--ai", args[i + 1], AI_TOOLS);
+        i += 1;
+        break;
+      }
+      case "--license": {
+        license = takeEnum("--license", args[i + 1], LICENSE_KINDS);
+        i += 1;
+        break;
+      }
       case "--engineering-standards": {
         const next = args[i + 1];
         if (next === void 0 || next.startsWith("--")) {
@@ -545,7 +623,18 @@ function parseCreateArgs(args) {
     ...roles !== void 0 ? { roles } : {},
     ...sampleFeature ? { sampleFeature: true } : {},
     ...engineeringStandards !== void 0 ? { engineeringStandards } : {},
-    ...multiApp ? { multiApp: true } : {}
+    ...multiApp ? { multiApp: true } : {},
+    ...backend !== void 0 ? { backend } : {},
+    ...frontend !== void 0 ? { frontend } : {},
+    ...mobile !== void 0 ? { mobile } : {},
+    ...miniapp !== void 0 ? { miniapp } : {},
+    ...agent !== void 0 ? { agent } : {},
+    ...deploy !== void 0 ? { deploy } : {},
+    ...contract !== void 0 ? { contract } : {},
+    ...ai !== void 0 ? { ai } : {},
+    ...license !== void 0 ? { license } : {},
+    ...gitLfs !== void 0 ? { gitLfs } : {},
+    ...integrations !== void 0 ? { integrations } : {}
   };
   if (sampleFeature && dryRun) {
     throw new UserInputError(
@@ -553,7 +642,7 @@ function parseCreateArgs(args) {
       "\u8BF7\u53BB\u6389\u4E00\u9879\u540E\u91CD\u8BD5"
     );
   }
-  if (!engineeringStandardsExplicit && yes) {
+  if (!engineeringStandardsExplicit) {
     return {
       projectName,
       flags: { ...flags, engineeringStandards: "standard" }
@@ -624,6 +713,17 @@ function helpText() {
     "                     Adoption tier for engineering standards: " + ADOPTION_TIERS.join("|"),
     "                     (default in --yes mode: standard; omitted in interactive mode)",
     "  --multi-app        Initialise the project in multi-app mode (<env>/apps/<name>/)",
+    "  --backend <kind>   " + BACKEND_LANGUAGES.join("|"),
+    "  --frontend <kind>  " + FRONTEND_FRAMEWORKS.join("|"),
+    "  --mobile <kind>    " + MOBILE_KINDS.join("|"),
+    "  --miniapp <kind>   " + MINIAPP_KINDS.join("|"),
+    "  --agent <kind>     " + AGENT_KINDS.join("|"),
+    "  --deploy <kind>    " + DEPLOY_TARGETS.join("|"),
+    "  --contract <kind>  " + CONTRACT_KINDS.join("|"),
+    "  --ai <kind>        " + AI_TOOLS.join("|"),
+    "  --license <kind>   " + LICENSE_KINDS.join("|"),
+    "  --gitLfs           Enable Git LFS in the generated project",
+    "  --integrations     Enable docs/06-\u96C6\u6210\u5BF9\u63A5/ at create time",
     "  -h, --help         Show this help",
     "  -v, --version      Show the scaffolder version",
     "",
@@ -710,7 +810,8 @@ var PARTIAL_OPTIONS_SCHEMA = {
       type: "array",
       items: { type: "string", enum: [...ROLE_KINDS] },
       uniqueItems: true
-    }
+    },
+    multiApp: { type: "boolean" }
   }
 };
 var ajv2 = new Ajv2({ allErrors: true, strict: true });
@@ -2222,7 +2323,19 @@ async function resolveOptions(input) {
     ...merged,
     projectName,
     ...flags.ci !== void 0 ? { ci: flags.ci } : {},
-    ...flags.roles !== void 0 ? { roles: flags.roles } : {}
+    ...flags.roles !== void 0 ? { roles: flags.roles } : {},
+    ...flags.backend !== void 0 ? { backend: flags.backend } : {},
+    ...flags.frontend !== void 0 ? { frontend: flags.frontend } : {},
+    ...flags.mobile !== void 0 ? { mobile: flags.mobile } : {},
+    ...flags.miniapp !== void 0 ? { miniapp: flags.miniapp } : {},
+    ...flags.agent !== void 0 ? { agent: flags.agent } : {},
+    ...flags.deploy !== void 0 ? { deploy: flags.deploy } : {},
+    ...flags.contract !== void 0 ? { contract: flags.contract } : {},
+    ...flags.ai !== void 0 ? { ai: flags.ai } : {},
+    ...flags.license !== void 0 ? { license: flags.license } : {},
+    ...flags.gitLfs !== void 0 ? { gitLfs: flags.gitLfs } : {},
+    ...flags.integrations !== void 0 ? { integrations: flags.integrations } : {},
+    ...flags.multiApp !== void 0 ? { multiApp: flags.multiApp } : {}
   };
   if (flags.yes) {
     const full = { ...buildDefaultOptions(projectName), ...merged };