create-pangza 1.0.0 → 1.1.0

package/README.md

@@ -10,7 +10,12 @@ npx create-pangza init my-app
 npm create pangza@latest -- init my-app
 ```
 
-交互勾选模块：`orm` / `auth` / `redis` / `log` / `schedule` / `encrypt` / `validate`。
+交互勾选模块：`orm` / `auth` / `redis` / `log` / `schedule` / `encrypt` / `validate`。  
+勾选 `orm` / `redis` 时会写入 `EnableOrm()` / `EnableRedis()`；未勾选则启动不连库、不因缺配置报错。不生成 `.gitkeep`。
+
+初始化还会生成：
+- `application.yaml`：默认 `server.port: 5270`；按所选模块追加 `redis` / `datasource`+`orm` 等
+- `tsconfig.json`：`@/*` → `src/*`（dev：`tsconfig-paths`；build：`tsc-alias`）
 
 ```bash
 npx create-pangza init my-app --modules=orm,auth,redis --db=mysql

package/lib/generate.js

@@ -31,7 +31,13 @@ function findProjectRoot(cwd = process.cwd()) {
           ...(json.dependencies || {}),
           ...(json.devDependencies || {}),
         };
-        if (deps["@pangza/express"]) return dir;
+        if (
+          deps["@pangza/express"] ||
+          deps["@pangza/application"] ||
+          deps["@pangza/core"]
+        ) {
+          return dir;
+        }
       } catch {
         /* ignore */
       }
@@ -59,7 +65,7 @@ function writeFile(filePath, content, { force }) {
 }
 
 function tplEntity({ Pascal, snake }) {
-  return `import { TableField, TableId, TableName } from "@pangza/express";
+  return `import { TableField, TableId, TableName } from "@pangza/orm";
 
 @TableName("${snake}")
 export default class ${Pascal}Entity {
@@ -89,7 +95,7 @@ export default class ${Pascal}Entity {
 }
 
 function tplMapper({ Pascal, fileBase }) {
-  return `import { Mapper, MapperType } from "@pangza/express";
+  return `import { Mapper, MapperType } from "@pangza/orm";
 import ${Pascal}Entity from "../entity/${fileBase}";
 
 @Mapper(${Pascal}Entity)
@@ -98,7 +104,7 @@ export default class ${Pascal}Mapper extends MapperType {}
 }
 
 function tplService({ Pascal, fileBase }) {
-  return `import { BaseService, Service } from "@pangza/express";
+  return `import { BaseService, Service } from "@pangza/core";
 import ${Pascal}Mapper from "../mapper/${fileBase}";
 
 @Service(${Pascal}Mapper)
@@ -115,8 +121,8 @@ function tplController({ Pascal, fileBase, apiPath, camel }) {
   PutMapping,
   RequestBody,
   RequestPath,
-  Resource,
-} from "@pangza/express";
+} from "@pangza/application";
+import { Resource } from "@pangza/core";
 import ${Pascal}Service from "../../service/${fileBase}";
 
 @Controller("/api/${apiPath}")

package/lib/modules.js

@@ -1,6 +1,6 @@
 "use strict";
 
-/** 可选能力模块（当前均由单包 @pangza/express 提供，差异在依赖与脚手架文件） */
+/** 可选能力模块（按分包安装；入口按模块分包导入） */
 const MODULES = [
   {
     id: "orm",
@@ -35,7 +35,7 @@ const MODULES = [
   {
     id: "validate",
     label: "Validate",
-    hint: "参数校验装饰器",
+    hint: "参数校验装饰器（含在 @pangza/core）",
   },
 ];
 
@@ -81,7 +81,8 @@ const DB_ENV = {
 /** @param {string[]} moduleIds @param {string} [dbType] */
 function resolveDependencies(moduleIds, dbType = "mysql") {
   const deps = {
-    "@pangza/express": "^1.0.0",
+    "@pangza/application": "^1.1.0",
+    "@pangza/core": "^1.1.0",
     cors: "^2.8.5",
     express: "^5.2.1",
     inversify: "^8.2.3",
@@ -90,18 +91,28 @@ function resolveDependencies(moduleIds, dbType = "mysql") {
   const set = new Set(moduleIds);
 
   if (set.has("orm")) {
+    deps["@pangza/orm"] = "^1.1.0";
     Object.assign(deps, DB_DEPS[dbType] || DB_DEPS.mysql);
   }
   if (set.has("redis") || set.has("auth")) {
+    deps["@pangza/redis"] = "^1.1.0";
     deps.redis = "^6.2.1";
   }
   if (set.has("auth")) {
+    deps["@pangza/auth"] = "^1.1.0";
     deps.jsonwebtoken = "^9.0.3";
     deps.bcryptjs = "^3.0.3";
   }
+  if (set.has("log")) {
+    deps["@pangza/log"] = "^1.1.0";
+  }
   if (set.has("schedule")) {
+    deps["@pangza/schedule"] = "^1.1.0";
     deps["node-cron"] = "^4.6.0";
   }
+  if (set.has("encrypt")) {
+    deps["@pangza/encrypt"] = "^1.1.0";
+  }
 
   return deps;
 }
@@ -142,74 +153,177 @@ function resolveDirs(moduleIds) {
   return dirs;
 }
 
+const DB_YAML = {
+  mysql: {
+    type: "mysql",
+    port: 3306,
+    user: "root",
+    database: "pangza",
+  },
+  postgresql: {
+    type: "postgresql",
+    port: 5432,
+    user: "postgres",
+    database: "pangza",
+  },
+  mssql: {
+    type: "sqlserver",
+    port: 1433,
+    user: "sa",
+    database: "pangza",
+  },
+};
+
 /**
- * 生成空项目入口：只起 HTTP，模块相关注释提示用户自行接入。
+ * 按所选模块生成 application.yaml（始终含 server.port=5270）。
+ * @param {string[]} moduleIds
+ * @param {string} [dbType]
+ */
+function generateApplicationYaml(moduleIds, dbType = "mysql") {
+  const set = new Set(moduleIds);
+  const lines = [
+    "# Generated by create-pangza init",
+    "# profile: PANGZA_PROFILE / APP_ENV / NODE_ENV（默认 development）",
+    "",
+    "server:",
+    "  port: 5270",
+    "  trustProxy: false",
+  ];
+
+  if (set.has("redis") || set.has("auth")) {
+    lines.push(
+      "",
+      "redis:",
+      "  host: 127.0.0.1",
+      "  port: 6379",
+      "  password: \"\"",
+      "  db: 0",
+      "  keyPrefix: \"pangza:\"",
+      "  mode: standalone",
+    );
+  }
+
+  if (set.has("orm")) {
+    const db = DB_YAML[dbType] || DB_YAML.mysql;
+    lines.push(
+      "",
+      "datasource:",
+      "  default:",
+      `    type: ${db.type}`,
+      "    host: 127.0.0.1",
+      `    port: ${db.port}`,
+      `    user: ${db.user}`,
+      "    password: \"\"",
+      `    database: ${db.database}`,
+      "    connectionLimit: 10",
+      "",
+      "orm:",
+      "  logicDelete: true",
+      "  logicDeleteField: delete_flag",
+      "  logicDeleteValue: 1",
+      "  logicNotDeleteValue: 0",
+      "  idType: ASSIGN_ID",
+      "  mapUnderscoreToCamelCase: true",
+      "  mapperLocations: []",
+      "  sqlLog:",
+      "    enabled: false",
+    );
+  }
+
+  if (set.has("encrypt")) {
+    lines.push(
+      "",
+      "# encrypt: 密钥建议放代码或环境变量，勿提交生产密钥到仓库",
+    );
+  }
+
+  if (set.has("schedule")) {
+    lines.push("", "# schedule: 任务写在 src/schedule，由 Application.scan 加载");
+  }
+
+  if (set.has("log")) {
+    lines.push("", "# log: 在入口 registry(Log({ writer })) 中配置落库");
+  }
+
+  if (set.has("auth")) {
+    lines.push(
+      "",
+      "# auth: jwtSecret 等在入口 Auth({ ... }) 配置，勿写进 yaml 明文（除非自管）",
+    );
+  }
+
+  lines.push("");
+  return lines.join("\n");
+}
+
+/**
+ * 生成空项目入口：只起 HTTP；选了 redis/orm 才 Enable*，否则启动不连库。
  * @param {string[]} moduleIds
  */
 function generateMainTs(moduleIds) {
   const set = new Set(moduleIds);
+
   const imports = [
     'import "reflect-metadata";',
     'import cors from "cors";',
     'import { json } from "express";',
-    'import { Application, Logger } from "@pangza/express";',
+    'import { Application } from "@pangza/application";',
+    'import { Logger } from "@pangza/core";',
   ];
 
-  const notes = [];
   if (set.has("orm")) {
-    notes.push(
-      "// ORM: 配置 .env 中的数据库变量后即可使用 @Mapper / QueryWrapper",
-    );
+    imports.push('import { EnableOrm } from "@pangza/orm";');
   }
   if (set.has("redis") || set.has("auth")) {
-    notes.push("// Redis: 配置 REDIS_* 后由框架自动连接（见文档）");
+    imports.push('import Redis, { EnableRedis } from "@pangza/redis";');
   }
   if (set.has("auth")) {
-    notes.push(
-      '// Auth: Application.registry(Auth({ ignore: ["/api/pub/**"] }))',
-    );
+    imports.push('import Auth from "@pangza/auth";');
   }
   if (set.has("log")) {
-    notes.push("// Log: configureLog({ writer }) 后配合 @Log 装饰器");
+    imports.push('import Log from "@pangza/log";');
   }
+
+  const notes = [];
   if (set.has("schedule")) {
-    notes.push("// Schedule: 在 src/schedule 编写任务并由扫描加载");
+    notes.push("// Schedule: 在 src/schedule 编写任务并由扫描加载（@pangza/schedule）");
   }
   if (set.has("encrypt")) {
-    notes.push("// Encrypt: 从 @pangza/express 导入 AESUtil 等");
+    notes.push("// Encrypt: import { AESUtil } from \"@pangza/encrypt\"");
   }
   if (set.has("validate")) {
-    notes.push("// Validate: 在 Controller 参数上使用校验装饰器");
+    notes.push("// Validate: 在 Controller 参数上使用 @pangza/core 校验装饰器");
   }
 
-  const body = [
-    ...imports,
-    "",
-    ...(notes.length ? [...notes, ""] : []),
-    "Application.registry(Logger({ level: \"info\" }))",
+  const chain = [
+    'Application.registry(Logger({ level: "info" }))',
     "  .registry(cors())",
     "  .registry(json())",
-    '  .scan("src")',
-    "  .start();",
-    "",
   ];
-  return body.join("\n");
-}
-
-function generateGitkeepReadme(moduleIds) {
-  const set = new Set(moduleIds);
-  const files = {
-    "src/controller/.gitkeep": "",
-  };
   if (set.has("orm")) {
-    files["src/entity/.gitkeep"] = "";
-    files["src/mapper/.gitkeep"] = "";
-    files["src/service/.gitkeep"] = "";
+    chain.push("  .registry(EnableOrm())");
   }
-  if (set.has("schedule")) {
-    files["src/schedule/.gitkeep"] = "";
+  if (set.has("redis") || set.has("auth")) {
+    chain.push("  .registry(EnableRedis())");
+  }
+  if (set.has("auth")) {
+    chain.push(
+      '  .registry(Auth({ ignore: ["/api/pub/**"], redis: Redis }))',
+    );
   }
-  return files;
+  if (set.has("log")) {
+    chain.push("  .registry(Log())");
+  }
+  chain.push('  .scan("src")');
+  chain.push("  .start();");
+
+  return [
+    ...imports,
+    "",
+    ...(notes.length ? [...notes, ""] : []),
+    ...chain,
+    "",
+  ].join("\n");
 }
 
 module.exports = {
@@ -218,6 +332,6 @@ module.exports = {
   resolveDependencies,
   resolveEnvLines,
   resolveDirs,
+  generateApplicationYaml,
   generateMainTs,
-  generateGitkeepReadme,
 };

package/lib/scaffold.js

@@ -6,8 +6,8 @@ const {
   resolveDependencies,
   resolveEnvLines,
   resolveDirs,
+  generateApplicationYaml,
   generateMainTs,
-  generateGitkeepReadme,
 } = require("./modules");
 
 const ROOT = path.join(__dirname, "..");
@@ -45,7 +45,6 @@ function scaffold(opts) {
 
   ensureDir(targetDir);
 
-  // base static files
   copyFile(
     path.join(BASE_TEMPLATE, "tsconfig.json"),
     path.join(targetDir, "tsconfig.json"),
@@ -66,7 +65,7 @@ function scaffold(opts) {
     description: "Pangza Express app",
     scripts: {
       dev: "ts-node -r tsconfig-paths/register src/main.ts",
-      build: "tsc -p tsconfig.json",
+      build: "tsc -p tsconfig.json && tsc-alias -p tsconfig.json",
       start: "node dist/main.js",
     },
     dependencies: resolveDependencies(modules, dbType),
@@ -75,6 +74,7 @@ function scaffold(opts) {
       "@types/express": "^5.0.6",
       "@types/node": "^22.0.0",
       "ts-node": "^10.9.2",
+      "tsc-alias": "^1.8.16",
       "tsconfig-paths": "^4.2.0",
       typescript: "^5.9.3",
     },
@@ -88,13 +88,12 @@ function scaffold(opts) {
     path.join(targetDir, ".env.example"),
     resolveEnvLines(modules, dbType).join("\n") + "\n",
   );
+  writeFile(
+    path.join(targetDir, "application.yaml"),
+    generateApplicationYaml(modules, dbType),
+  );
   writeFile(path.join(targetDir, "src", "main.ts"), generateMainTs(modules));
 
-  const extras = generateGitkeepReadme(modules);
-  for (const [rel, content] of Object.entries(extras)) {
-    writeFile(path.join(targetDir, rel), content);
-  }
-
   writeFile(
     path.join(targetDir, "README.md"),
     `# ${projectName}
@@ -109,10 +108,14 @@ ${modules.includes("orm") ? `Database: **${dbType}**\n` : ""}
 ## Run
 
 \`\`\`bash
-cp .env.example .env
+cp .env.example .env   # 可选；端口与库配置以 application.yaml 为准
 npm install
 npm run dev
 \`\`\`
+
+- 默认端口：\`application.yaml\` → \`server.port: 5270\`
+- 路径别名：\`@/*\` → \`src/*\`（dev 用 tsconfig-paths，build 用 tsc-alias）
+- 需要 Redis / 数据库时，入口已按模块写入 \`EnableRedis()\` / \`EnableOrm()\`
 `,
   );
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "create-pangza",
-  "version": "1.0.0",
-  "description": "Scaffold & generate for @pangza/express (init / g controller|service|mapper|entity|all)",
+  "version": "1.1.0",
+  "description": "Scaffold & generate for @pangza/* (init / g controller|service|mapper|entity|all)",
   "bin": {
     "create-pangza": "./bin/create-pangza.js"
   },

package/template/base/tsconfig.json

@@ -4,6 +4,10 @@
     "module": "CommonJS",
     "outDir": "dist",
     "rootDir": "src",
+    "baseUrl": ".",
+    "paths": {
+      "@/*": ["src/*"]
+    },
     "strict": true,
     "esModuleInterop": true,
     "skipLibCheck": true,