create-pangza 1.0.0 → 1.0.1

package/README.md

@@ -10,7 +10,8 @@ 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`。
 
 ```bash
 npx create-pangza init my-app --modules=orm,auth,redis --db=mysql

package/lib/modules.js

@@ -81,7 +81,7 @@ const DB_ENV = {
 /** @param {string[]} moduleIds @param {string} [dbType] */
 function resolveDependencies(moduleIds, dbType = "mysql") {
   const deps = {
-    "@pangza/express": "^1.0.0",
+    "@pangza/express": "^1.0.1",
     cors: "^2.8.5",
     express: "^5.2.1",
     inversify: "^8.2.3",
@@ -143,35 +143,25 @@ function resolveDirs(moduleIds) {
 }
 
 /**
- * 生成空项目入口：只起 HTTP，模块相关注释提示用户自行接入。
+ * 生成空项目入口：只起 HTTP；选了 redis/orm 才 Enable*，否则启动不连库。
  * @param {string[]} moduleIds
  */
 function generateMainTs(moduleIds) {
   const set = new Set(moduleIds);
+  const named = ["Application", "Logger"];
+  if (set.has("orm")) named.push("EnableOrm");
+  if (set.has("redis") || set.has("auth")) named.push("EnableRedis");
+  if (set.has("auth")) named.push("Auth", "Redis");
+  if (set.has("log")) named.push("Log");
+
   const imports = [
     'import "reflect-metadata";',
     'import cors from "cors";',
     'import { json } from "express";',
-    'import { Application, Logger } from "@pangza/express";',
+    `import { ${named.join(", ")} } from "@pangza/express";`,
   ];
 
   const notes = [];
-  if (set.has("orm")) {
-    notes.push(
-      "// ORM: 配置 .env 中的数据库变量后即可使用 @Mapper / QueryWrapper",
-    );
-  }
-  if (set.has("redis") || set.has("auth")) {
-    notes.push("// Redis: 配置 REDIS_* 后由框架自动连接（见文档）");
-  }
-  if (set.has("auth")) {
-    notes.push(
-      '// Auth: Application.registry(Auth({ ignore: ["/api/pub/**"] }))',
-    );
-  }
-  if (set.has("log")) {
-    notes.push("// Log: configureLog({ writer }) 后配合 @Log 装饰器");
-  }
   if (set.has("schedule")) {
     notes.push("// Schedule: 在 src/schedule 编写任务并由扫描加载");
   }
@@ -182,34 +172,35 @@ function generateMainTs(moduleIds) {
     notes.push("// Validate: 在 Controller 参数上使用校验装饰器");
   }
 
-  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 = {
@@ -219,5 +210,4 @@ module.exports = {
   resolveEnvLines,
   resolveDirs,
   generateMainTs,
-  generateGitkeepReadme,
 };

package/lib/scaffold.js

@@ -7,7 +7,6 @@ const {
   resolveEnvLines,
   resolveDirs,
   generateMainTs,
-  generateGitkeepReadme,
 } = require("./modules");
 
 const ROOT = path.join(__dirname, "..");
@@ -45,7 +44,6 @@ function scaffold(opts) {
 
   ensureDir(targetDir);
 
-  // base static files
   copyFile(
     path.join(BASE_TEMPLATE, "tsconfig.json"),
     path.join(targetDir, "tsconfig.json"),
@@ -90,11 +88,6 @@ function scaffold(opts) {
   );
   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}
@@ -113,6 +106,8 @@ cp .env.example .env
 npm install
 npm run dev
 \`\`\`
+
+需要 Redis / 数据库时，请在入口 \`registry(EnableRedis())\` / \`registry(EnableOrm())\`（脚手架勾选对应模块时已自动写入）。
 `,
   );
 }

package/package.json

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