@gsp-bef/create-igix-backend 0.0.0-stage → 0.0.1

package/index.mjs

@@ -0,0 +1,231 @@
+#!/usr/bin/env node
+/** create-igix-backend — iGIX 后端工程 pom 生成（自包含单文件）。
+ *  用法：交互两步（BO 目录 → 工程名）或命令行 --bo <BO 目录> --name <工程名> [--dir <落点>]
+ *  产物：{dir}/pom.xml + src/main/java 源码根（包目录随首个类自动创建）—— 命名 {bo}-{工程名}-backend，包根含工程名段（多工程防类冲突）。 */
+import fs from "node:fs";
+import path from "node:path";
+import readline from "node:readline/promises";
+
+const PARENT = { groupId: "io.iec.edp", artifactId: "caf-boot-parent", version: "1.10.0-rc.11" };
+const VERSION = "0.1.0-SNAPSHOT";
+
+const parseArgs = (argv) => {
+  const o = {};
+  for (let i = 0; i < argv.length; i++) {
+    if (!argv[i].startsWith("--")) continue;
+    const k = argv[i].slice(2);
+    const v = argv[i + 1];
+    if (v === undefined || v.startsWith("--")) o[k] = true;
+    else { o[k] = v.trim(); i++; }
+  }
+  return o;
+};
+
+function locateBoDir(startDir) {
+  if (fs.existsSync(path.join(startDir, "gspproject.json")))
+    return { boDir: path.dirname(startDir), projectDir: startDir, corrected: true };
+  for (const e of fs.readdirSync(startDir, { withFileTypes: true })) {
+    if (!e.isDirectory()) continue;
+    const child = path.join(startDir, e.name);
+    if (fs.existsSync(path.join(child, "gspproject.json")))
+      return { boDir: startDir, projectDir: child, corrected: false };
+  }
+  return null;
+}
+
+function readGspProject(projectDir) {
+  const gsp = JSON.parse(fs.readFileSync(path.join(projectDir, "gspproject.json"), "utf8"));
+  const missing = ["AppCode", "ServiceUnitCode", "BizobjectCode"].filter((k) => !gsp[k]);
+  if (missing.length > 0) throw new Error(`gspproject.json 缺少字段：${missing.join("、")}（${projectDir}）`);
+  return gsp;
+}
+
+function pomXml({ groupId, name, version, pkg, parentVersion }) {
+  return `<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+
+  <parent>
+    <groupId>${PARENT.groupId}</groupId>
+    <artifactId>${PARENT.artifactId}</artifactId>
+    <version>${parentVersion || PARENT.version}</version>
+  </parent>
+
+  <groupId>${groupId}</groupId>
+  <artifactId>${name}</artifactId>
+  <version>${version}</version>
+
+  <properties>
+    <maven.compiler.source>1.8</maven.compiler.source>
+    <maven.compiler.target>1.8</maven.compiler.target>
+    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+  </properties>
+
+  <dependencies>
+    <dependency>
+      <groupId>io.iec.edp</groupId>
+      <artifactId>caf-boot-starter-base</artifactId>
+    </dependency>
+    <dependency>
+      <groupId>io.iec.edp</groupId>
+      <artifactId>caf-boot-starter-rest</artifactId>
+    </dependency>
+    <dependency>
+      <groupId>io.iec.edp</groupId>
+      <artifactId>caf-boot-starter-data</artifactId>
+    </dependency>
+    <dependency>
+      <groupId>io.iec.edp</groupId>
+      <artifactId>caf-boot-starter-session</artifactId>
+    </dependency>
+    <dependency>
+      <groupId>io.iec.edp</groupId>
+      <artifactId>caf-boot-starter-application-context</artifactId>
+    </dependency>
+  </dependencies>
+
+  <build>
+    <finalName>${name}</finalName>
+  </build>
+</project>
+`;
+}
+
+function readmeMd({ name, groupId, pkg }) {
+  return `# ${name}
+
+\`${name}\` 是 iGIX 后端 Java 工程（由 \`create-igix-backend\` 生成）。
+
+- groupId：\`${groupId}\`
+- 包根：\`${pkg}\`
+- parent：\`io.iec.edp:caf-boot-parent\`，JDK 8
+
+## 编码
+
+代码按能力加载对应 skill 生成：BEF CRUD 用 \`bef-core\`（基于 .be 建模）、REST 用 \`caf-rest-service\`、部署口径对齐用 \`caf-host-hardening\`。
+
+部署见 [DEPLOY-IGIX.md](DEPLOY-IGIX.md)。
+`;
+}
+
+function deployMd({ app, su, bo, name }) {
+  return `# iGIX 部署说明
+
+本工程随 **BO 目录整体**经平台发布流水线交付（主路径），产物最终落到 **iGIX 安装盘**；
+本地 \`spring-boot:run\` 不是交付形态。
+
+## 主路径：平台发布流水线（随 BO 发布）
+
+经 iGIX MCP 发布（内部先做发布前校验 validatebo，**不通过不发布**）：
+
+\`\`\`text
+igix_apply_publish_backend({ appCode: "${app}", suCode: "${su}", boCode: "${bo}" })
+\`\`\`
+
+流水线：\`mvn clean install → 元数据部署 → DBO 部署 → 构件热加载\`。产物同时落三处：
+Maven 仓库、\`bo-${bo}-back/publish/server/apps/${app}/${su}/libs/\`、
+**\`<安装盘>/server/apps/${app}/${su}/libs/\`**（宿主真正加载的位置）。
+
+- 同步长调用（实测约 2~5 分钟）；**客户端超时先到 ≠ 失败**——以安装盘
+  \`server/apps/${app}/${su}/libs/\` 产物落盘（滞后约 1~2 分钟）+ 宿主日志「构件热加载完成」二次确认
+- \`.be\` 元数据有变更时先经 bef-modeler 保存并同步（sysnbe）——**发布不替代元数据交付**
+
+## 备选：手动打包复制（不经流水线、无门禁）
+
+仅当该 BO 未纳入平台发布体系时使用：
+
+\`\`\`bash
+mvn package
+node <caf-new-app>/scripts/package-igix.mjs --module-dir <本工程根> --app ${app} --su ${su} --alias "${name}"
+# 将 dist/igix/server/apps/${app} 整体复制到 <IGIX_HOME>/server/apps/（新建目录，勿写入 oc/emc）
+# 安装盘 startup 后验证
+\`\`\`
+
+## 禁止
+
+- 原位覆盖安装盘 \`server/apps/**/libs/*.jar\`（Windows 文件锁会拒绝；热更新走 bef-deploy 的 agent staging 投放）
+- 把交付物写进安装盘已有应用目录（oc / emc / cms）
+- 本地 CXF 回退作为交付物或验收标准
+`;
+}
+
+async function main() {
+  const args = parseArgs(process.argv.slice(2));
+  let rl = null;
+  let pipedLines = null;
+  const clean = (s) => String(s).replace(/^\uFEFF/, "").trim();
+  // TTY 走 readline 交互；管道（AI 调用/echo 喂入）非 TTY——readline 在 stdin EOF 时会挂起、
+  // readFileSync(0) 在 Windows 管道不可靠，改为异步读完 stdin 按行消费
+  let pipedText = null;
+  const readAllStdin = () =>
+    new Promise((resolve) => {
+      const chunks = [];
+      process.stdin.on("data", (c) => chunks.push(c));
+      process.stdin.on("end", () => resolve(Buffer.concat(chunks).toString("utf8")));
+      process.stdin.on("error", () => resolve(""));
+    });
+  const ask = async (t) => {
+    if (process.stdin.isTTY) {
+      if (!rl) rl = readline.createInterface({ input: process.stdin, output: process.stdout });
+      return clean(await rl.question(t));
+    }
+    if (pipedText === null) pipedText = await readAllStdin();
+    if (!pipedLines) pipedLines = pipedText.split(/\r?\n/).map(clean).filter(Boolean);
+    return pipedLines.shift() ?? "";
+  };
+
+  // 第 1 步：BO 目录
+  const boInput = args.bo ?? (await ask("请输入业务对象目录全路径（至 <APP>\\<SU>\\<BO> 层级，示例 D:\\projects\\demo\\demo-su\\order）: "));
+
+  const startDir = path.resolve(boInput);
+  if (!fs.existsSync(startDir)) {
+    console.error(`路径不存在：${startDir}`);
+    process.exit(3);
+  }
+  const located = locateBoDir(startDir);
+  if (!located) {
+    console.error(`未在 ${startDir}（及其一级子目录）找到 gspproject.json。请先经 MCP 创建业务对象与元数据工程（igix_apply_create_bo → igix_apply_create_project）。`);
+    process.exit(3);
+  }
+  const { boDir, projectDir, corrected } = located;
+  const gsp = readGspProject(projectDir);
+
+  const app = String(gsp.AppCode).toLowerCase();
+  const su = String(gsp.ServiceUnitCode).toLowerCase();
+  const bo = String(gsp.BizobjectCode).toLowerCase();
+  // 第 2 步：工程名 → {bo}-{工程名}-backend
+  const nameInput = args.name ?? String(await ask(`请输入工程名: `));
+  const normalized = nameInput.trim().toLowerCase().replace(/[^a-z0-9-]+/g, "-").replace(/-+/g, "-").replace(/^-+|-+$/g, "");
+  if (!/^[a-z][a-z0-9-]*$/.test(normalized)) {
+    console.error(`工程名含非法字符（字母/数字/连字符以外的部分已转连字符）：${nameInput} → ${normalized}`);
+    process.exit(3);
+  }
+  const name = `${bo}-${normalized}-backend`;
+  if (rl) rl.close();  const groupId = `com.inspur.gs.${app}.${su}`;
+  const pkg = `com.inspur.gs.${app}.${su}.${bo}.${normalized}`;
+  const targetDir = args.dir ? path.resolve(args.dir) : path.join(boDir, name);
+
+  if (fs.existsSync(targetDir) && fs.readdirSync(targetDir).length > 0) {
+    console.error(`目标目录非空：${targetDir}`);
+    process.exit(1);
+  }
+  fs.mkdirSync(targetDir, { recursive: true });
+  fs.writeFileSync(path.join(targetDir, "pom.xml"), pomXml({ groupId, name, version: VERSION, pkg, parentVersion: args["parent-version"] }));
+  // 源码目录结构（src/main/java 或多模块拆分）不在此创建，由 AI 按场景自由发挥
+  fs.writeFileSync(path.join(targetDir, ".gitignore"), "target/\n*.class\n*.jar\n.idea/\n*.iml\n.vscode/\n");
+  fs.writeFileSync(
+    path.join(targetDir, "README.md"),
+    readmeMd({ name, groupId, pkg })
+  );
+  fs.writeFileSync(path.join(targetDir, "DEPLOY-IGIX.md"), deployMd({ app, su, bo, name }));
+
+  console.log(`[create-igix-backend] 已生成 ${targetDir}`);
+  console.log(`[create-igix-backend] 包根 ${pkg}；随 BO ${bo} 经发布流水线交付（见 DEPLOY-IGIX.md）`);
+}
+
+main().catch((e) => {
+  console.error(`[create-igix-backend] ${e.message}`);
+  process.exit(1);
+});

package/package.json

@@ -1,6 +1,23 @@
 {
   "name": "@gsp-bef/create-igix-backend",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.0.1",
+  "description": "iGIX 后端工程生成器（交互两步：BO 目录 → 工程名；命名 {bo}-{工程名}-backend，pom 极简 DDD 自由演进，含部署指导文档）",
+  "type": "module",
+  "bin": {
+    "create-igix-backend": "index.mjs"
+  },
+  "files": [
+    "index.mjs"
+  ],
+  "keywords": [
+    "igix",
+    "caf",
+    "maven",
+    "scaffold",
+    "backend"
+  ],
+  "license": "MIT",
+  "engines": {
+    "node": ">=18"
+  }
+}

package/README.md

@@ -1,3 +0,0 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.