create-skweb 3.1.1 → 3.3.0

package/.turbo/turbo-test.log

@@ -1,4 +1,69 @@
 
-> create-skweb@1.2.1 test
+> create-skweb@3.2.0 test
 > mocha test/**/*.mjs
 
+
+
+  create-skweb
+    createProject()
+      ✔ should create TypeScript project from template
+      ✔ should create MJS project from template
+      ✔ should create CJS project from template
+      ✔ should reject non-empty destination directory
+      ✔ should include winston in all templates
+      ✔ should include @dotenvx/dotenvx in all templates
+      ✔ should include pm2 ecosystem in all templates
+      ✔ should replace {{name}} placeholder in package.json
+    printBanner()
+
+╔════════════════════════════════════════════════════════════════════╗
+║                     Create SKWeb Project                           ║
+╚════════════════════════════════════════════════════════════════════╝
+
+      ✔ should not throw
+    printSuccess()
+
+╔════════════════════════════════════════════════════════════════════╗
+║                         项目创建成功！                               ║
+╚════════════════════════════════════════════════════════════════════╝
+
+项目名称: my-app
+项目路径: /tmp/my-app/my-app
+
+接下来可以执行:
+
+  cd my-app
+
+  # 复制环境变量模板并按需修改
+  cp .env.example .env
+
+  # 开发模式运行
+  npm run start:dev
+
+  # 生产模式运行 (需要先构建)
+  npm run build
+  npm run start
+
+  # 查看日志
+  npm run logs
+
+  # 停止服务
+  npm run stop
+
+  # 重启服务
+  npm run restart
+
+项目特性:
+  ✅ TypeScript/MJS/CJS 支持
+  ✅ @dotenvx/dotenvx 环境变量管理
+  ✅ PM2 进程管理
+  ✅ SKWeb Express 集成
+  ✅ Keycloak/JWKS 鉴权 (可选)
+  ✅ ESLint 代码检查
+  ✅ Mocha 测试框架
+
+      ✔ should not throw
+
+
+  10 passing (179ms)
+

package/CHANGELOG.md

@@ -1,5 +1,54 @@
 # create-skweb
 
+## 3.3.0
+
+### Minor Changes
+
+- 重构模板结构：入口文件重命名为 web-app/cron-app，新增 web-framework/cron-framework 单例文件，移除冗余的 index 和 services/database
+
+## 3.2.0
+
+### Minor Changes
+
+- c5338b9: feat(templates): honor `--auth` option at generation time, not at runtime
+
+  Previously `app.js` / `app.ts` always contained both the static and jwks
+  JWT branches and decided which to use at runtime via `process.env.AUTH_PROVIDER`.
+  That meant the `--auth` CLI option was effectively a hint, not a real
+  choice: every generated project shipped both code paths and the
+  `AUTH_PROVIDER=...` line in `.env.example`, even projects that explicitly
+  chose static or jwks.
+
+  Now `createProject` reads the `auth` option and writes only the
+  matching files:
+
+  - `app.auth-static.{js,ts}` → `app.{js,ts}` (static only)
+  - `app.auth-jwks.{js,ts}` → `app.{js,ts}` (jwks only)
+  - `config.auth-static.{js,ts}` → `config.{js,ts}` (exports `checkJwtSecret`)
+  - `config.auth-jwks.{js,ts}` → `config.{js,ts}` (exports `checkOIDCConfig`)
+  - `swagger.auth-static.{js,ts}` → `swagger.{js,ts}` (HTTP bearer security)
+  - `swagger.auth-jwks.{js,ts}` → `swagger.{js,ts}` (OIDC openIdConnect)
+  - `.env.example.auth-static` → `.env.example` (JWT_SECRET only)
+  - `.env.example.auth-jwks` → `.env.example` (OIDC\_\* only)
+
+  Generated projects are now leaner: a static-only project contains no
+  JWKS code or env vars, and vice versa. The `checkJwtSecret` /
+  `checkOIDCConfig` split also keeps the JWT_SECRET default-value
+  warning from leaking into the cron worker process.
+
+## 3.1.2
+
+### Patch Changes
+
+- 03ebe56: refactor(templates): separate JWT secret validation from generic env check
+
+  `validateConfig` (in templates/cjs/mjs/ts `src/utils/config.{js,ts}`) no longer
+  warns about `JWT_SECRET` default value. The JWT-specific check is moved to a
+  new `checkJwtSecret()` helper that is now only invoked from the web bootstrap
+  (`src/app.{js,ts}`), not from `cronWorker.js` or CLI commands. This removes the
+  spurious "JWT_SECRET is using default value" warning in the cron worker
+  process, which never uses JWT.
+
 ## 3.1.1
 
 ### Patch Changes

package/dist/cli.js

@@ -32,12 +32,25 @@ async function createProject(options) {
             await fs.mkdirs(path.join(targetDir, fileName));
             continue;
         }
+        // 跳过 auth- 后缀的文件（已合并到统一模板）
+        if (/\.auth-(static|jwks)(\.[^.]+)?$/.test(fileName)) {
+            continue;
+        }
+        // 跳过无 auth 后缀的 .env.example（改用条件模板）
+        if (fileName === '.env.example' || fileName.endsWith('/.env.example')) {
+            continue;
+        }
+        const outputName = fileName;
         let content = await fs.readFile(srcPath, 'utf-8');
+        // 处理条件块：{{#if_eq auth "static"}}...{{else}}...{{/if_eq}}
+        content = content.replace(/\{\{#if_eq auth "(static|jwks)"\}\}([\s\S]*?)(?:\{\{else\}\}([\s\S]*?))?\{\{\/if_eq\}\}/g, (_match, value, mainContent, elseContent) => {
+            return value === auth ? mainContent : (elseContent || '');
+        });
         content = content
             .replace(/\{\{name\}\}/g, name)
             .replace(/\{\{description\}\}/g, description)
             .replace(/\{\{auth\}\}/g, auth);
-        const destPath = path.join(targetDir, fileName);
+        const destPath = path.join(targetDir, outputName);
         await fs.writeFile(destPath, content);
     }
     await fs.mkdirs(path.join(targetDir, 'logs'));

package/dist/index.js

@@ -27,12 +27,25 @@ async function createProject(options) {
             await fs.mkdirs(path.join(targetDir, fileName));
             continue;
         }
+        // 跳过 auth- 后缀的文件（已合并到统一模板）
+        if (/\.auth-(static|jwks)(\.[^.]+)?$/.test(fileName)) {
+            continue;
+        }
+        // 跳过无 auth 后缀的 .env.example（改用条件模板）
+        if (fileName === '.env.example' || fileName.endsWith('/.env.example')) {
+            continue;
+        }
+        const outputName = fileName;
         let content = await fs.readFile(srcPath, 'utf-8');
+        // 处理条件块：{{#if_eq auth "static"}}...{{else}}...{{/if_eq}}
+        content = content.replace(/\{\{#if_eq auth "(static|jwks)"\}\}([\s\S]*?)(?:\{\{else\}\}([\s\S]*?))?\{\{\/if_eq\}\}/g, (_match, value, mainContent, elseContent) => {
+            return value === auth ? mainContent : (elseContent || '');
+        });
         content = content
             .replace(/\{\{name\}\}/g, name)
             .replace(/\{\{description\}\}/g, description)
             .replace(/\{\{auth\}\}/g, auth);
-        const destPath = path.join(targetDir, fileName);
+        const destPath = path.join(targetDir, outputName);
         await fs.writeFile(destPath, content);
     }
     await fs.mkdirs(path.join(targetDir, 'logs'));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-skweb",
-  "version": "3.1.1",
+  "version": "3.3.0",
   "description": "Create a new SKWeb project with TypeScript, CJS, or MJS support",
   "type": "module",
   "main": "dist/index.js",

package/src/index.ts

@@ -42,14 +42,34 @@ export async function createProject(options: CreateOptions): Promise<void> {
       continue
     }
 
+    // 跳过 auth- 后缀的文件（已合并到统一模板）
+    if (/\.auth-(static|jwks)(\.[^.]+)?$/.test(fileName)) {
+      continue
+    }
+
+    // 跳过无 auth 后缀的 .env.example（改用条件模板）
+    if (fileName === '.env.example' || fileName.endsWith('/.env.example')) {
+      continue
+    }
+
+    const outputName = fileName
+
     let content = await fs.readFile(srcPath, 'utf-8')
 
+    // 处理条件块：{{#if_eq auth "static"}}...{{else}}...{{/if_eq}}
+    content = content.replace(
+      /\{\{#if_eq auth "(static|jwks)"\}\}([\s\S]*?)(?:\{\{else\}\}([\s\S]*?))?\{\{\/if_eq\}\}/g,
+      (_match: string, value: string, mainContent: string, elseContent: string) => {
+        return value === auth ? mainContent : (elseContent || '')
+      }
+    )
+
     content = content
       .replace(/\{\{name\}\}/g, name)
       .replace(/\{\{description\}\}/g, description)
       .replace(/\{\{auth\}\}/g, auth)
 
-    const destPath = path.join(targetDir, fileName)
+    const destPath = path.join(targetDir, outputName)
     await fs.writeFile(destPath, content)
   }
 

package/templates/cjs/.env.example

@@ -38,29 +38,25 @@ REDIS_DB=0
 # (Production is always disabled to avoid exposing internal API details.)
 SWAGGER_ENABLED=true
 
-# ---------- Auth Provider ----------
-# 'static' (default): use a shared secret (HS256)
-# 'jwks': verify via JWKS endpoint (Keycloak / Auth0 / generic OIDC)
-AUTH_PROVIDER={{auth}}
-
-# ---------- JWT (static mode) ----------
+{{#if_eq auth "static"}}
+# ---------- Auth: static (HS256 shared secret) ----------
 # [REQUIRED in production] Use a strong random string, e.g. `openssl rand -hex 32`
 JWT_SECRET=please-change-this-in-production
 JWT_EXPIRES_IN=7d
-
-# ---------- JWT (jwks mode, OIDC compatible) ----------
+{{else}}
+# ---------- Auth: jwks (OIDC compatible) ----------
 # Works with any OIDC-compliant IdP. Common issuer formats:
 #   Keycloak:  https://kc.example.com/realms/myrealm
 #   Auth0:     https://your-tenant.auth0.com/
 #   Okta:      https://your-domain.okta.com/oauth2/default
 #   Authing:   https://your-app.authing.cn/oauth2/default
-#   Keycloak Realm: https://kc.example.com/auth/realms/myrealm
 # `audience` is the client id of this API in the IdP (recommended).
 # JWKS URI is auto-derived as ${OIDC_ISSUER}/.well-known/jwks.json
 # unless OIDC_JWKS_URI is set explicitly.
 OIDC_ISSUER=
 OIDC_AUDIENCE=
 OIDC_JWKS_URI=
+{{/if_eq}}
 
 # ---------- Logging ----------
 # error | warn | info | http | verbose | debug | silly

package/templates/cjs/ecosystem.config.js

@@ -2,7 +2,7 @@ module.exports = {
   apps: [
     {
       name: '{{name}}-web',
-      script: 'src/index.js',
+      script: 'src/web-app.js',
       instances: 'max',
       exec_mode: 'cluster',
       env: {
@@ -16,7 +16,7 @@ module.exports = {
     },
     {
       name: '{{name}}-cron',
-      script: 'src/cronWorker.js',
+      script: 'src/cron-app.js',
       instances: 1,
       exec_mode: 'fork',
       autorestart: true,

package/templates/cjs/package.json

@@ -9,8 +9,8 @@
     "restart": "pm2 restart all",
     "delete": "pm2 delete all",
     "logs": "pm2 logs",
-    "web:dev": "npx dotenvx run -- node --watch src/index.js",
-    "cron:dev": "npx dotenvx run -- node --watch src/cronWorker.js",
+    "web:dev": "npx dotenvx run -- node --watch src/web-app.js",
+    "cron:dev": "npx dotenvx run -- node --watch src/cron-app.js",
     "seed": "npx dotenvx run -- node src/commands/seed.js",
     "migrate": "npx dotenvx run -- node src/commands/migrate.js",
     "build": "cp -r src dist",
@@ -22,14 +22,14 @@
   "dependencies": {
     "@dotenvx/dotenvx": "^1.75.1",
     "http-errors": "^2.0.1",
-    "skweb-express": "^2.0.3",
+    "skweb-express": "^2.0.4",
     "skweb-express-jwt": "^3.0.0",
     "skweb-express-logger": "^2.0.0",
     "skweb-sequelize": "^2.0.0",
     "skweb-redis": "^2.0.0",
     "skweb-cron": "^2.0.0",
-    "skweb-framework": "^2.1.0",
-    "skweb-plugin": "^2.1.0",
+    "skweb-framework": "^2.1.1",
+    "skweb-plugin": "^2.1.1",
     "skweb-util": "^2.0.0",
     "winston": "^3.19.0",
     "sequelize": "^6.37.8",

package/templates/cjs/src/controllers/user.js

@@ -1,7 +1,7 @@
 const createHttpError = require('http-errors')
-const { db } = require('../services/database.js')
+const { framework } = require('../web-framework.js')
 
-const { SysUser } = db.sequelize.models
+const { SysUser } = framework.models
 
 /**
  * @swagger

package/templates/cjs/src/cron-app.js

@@ -0,0 +1,40 @@
+require('dotenv/config')
+
+const path = require('path')
+const { framework } = require('./cron-framework.js')
+const { logger } = require('./utils/logger.js')
+const { checkRequiredEnv } = require('./utils/config.js')
+
+async function startCronWorker() {
+  logger.info('[cron-worker] Starting cron worker process...')
+
+  if (!checkRequiredEnv()) {
+    logger.error('[cron-worker] Configuration validation failed, exiting...')
+    process.exit(1)
+  }
+
+  await framework.setup({
+    modelsDir: path.join(__dirname, './models'),
+    cronActionsDir: path.join(__dirname, './cronActions')
+  })
+  await framework.start()
+  logger.info('[cron-worker] Cron worker started')
+
+  process.on('uncaughtException', (err) => {
+    logger.error(`[cron-worker] uncaughtException: ${err.stack || err.message}`)
+    process.exit(1)
+  })
+  process.on('unhandledRejection', (reason) => {
+    logger.error(`[cron-worker] unhandledRejection: ${reason instanceof Error ? reason.stack : String(reason)}`)
+    process.exit(1)
+  })
+}
+
+if (require.main === module) {
+  startCronWorker().catch((err) => {
+    logger.error('[cron-worker] Fatal error:', err)
+    process.exit(1)
+  })
+}
+
+module.exports = { startCronWorker }

package/templates/cjs/src/cron-framework.js

@@ -0,0 +1,44 @@
+// @ts-nocheck
+const { CronFramework } = require('skweb-framework')
+const { logger } = require('./utils/logger.js')
+
+const framework = new CronFramework({
+  db: {
+    host: process.env.DB_HOST || '127.0.0.1',
+    port: Number(process.env.DB_PORT) || 3306,
+    username: process.env.DB_USER || 'root',
+    password: process.env.DB_PASS || '',
+    database: process.env.DB_NAME || 'test-project',
+    dialect: process.env.DB_DIALECT || 'mysql',
+    charset: process.env.DB_CHARSET || 'utf8mb4',
+    underscored: true,
+    logging: process.env.DEBUG_DB === 'true'
+  },
+  redis: {
+    host: process.env.REDIS_HOST || '127.0.0.1',
+    port: Number(process.env.REDIS_PORT) || 6379,
+    password: process.env.REDIS_PASSWORD || undefined
+  },
+  channel: 'cron:task:cmd',
+  logger,
+  onSaveTask: async (taskData) => {
+    const SysCronTask = framework.db?.sequelize?.models.SysCronTask
+    if (SysCronTask) {
+      await SysCronTask.update(
+        { cache: taskData.cache, data: taskData.data },
+        { where: { id: taskData.taskId } }
+      )
+    }
+  },
+  loadTasks: async () => {
+    const SysCronTask = framework.db?.sequelize?.models.SysCronTask
+    if (!SysCronTask) return []
+    return (await SysCronTask.findAll()).map((t) => ({
+      id: String(t.id),
+      cronTime: t.cronTime,
+      method: t.method
+    }))
+  }
+})
+
+module.exports = { framework }

package/templates/cjs/src/swagger.js

@@ -1,24 +1,9 @@
+// @ts-nocheck
 'use strict'
 
 const path = require('path')
 const swaggerJSDoc = require('swagger-jsdoc')
 
-/**
- * 构建 OpenAPI 3.0 规范对象。
- *
- * 控制器中应使用 @swagger JSDoc 注释描述端点，例如：
- *
- *   /**
- *    * @swagger
- *    * /api/users:
- *    *   get:
- *    *     summary: 获取用户列表
- *    *     tags: [Users]
- *    *     responses:
- *    *       200:
- *    *         description: OK
- *    *\/
- */
 function buildOpenApiSpec() {
   return swaggerJSDoc({
     definition: {
@@ -34,12 +19,22 @@ function buildOpenApiSpec() {
       ],
       components: {
         securitySchemes: {
+          {{#if_eq auth "static"}}
           bearerAuth: {
             type: 'http',
             scheme: 'bearer',
-            bearerFormat: 'JWT',
-            description: 'Paste a JWT token here (only needed when AUTH_PROVIDER=static)'
+            bearerFormat: 'JWT'
           }
+          {{else}}
+          oidcAuth: {
+            type: 'openIdConnect',
+            openIdConnectUrl: process.env.OIDC_JWKS_URI
+              ? process.env.OIDC_JWKS_URI.replace(/\/jwks\.json$/, '/.well-known/openid-configuration')
+              : (process.env.OIDC_ISSUER
+                  ? `${process.env.OIDC_ISSUER.replace(/\/$/, '')}/.well-known/openid-configuration`
+                  : undefined)
+          }
+          {{/if_eq}}
         }
       }
     },

package/templates/cjs/src/utils/config.js

@@ -1,3 +1,4 @@
+// @ts-nocheck
 const { logger } = require('./logger.js')
 
 function validateConfig() {
@@ -13,10 +14,6 @@ function validateConfig() {
     logger.warn('[config] DB_USER not set, using default: root')
   }
 
-  if (process.env.JWT_SECRET === 'please-change-this-in-production') {
-    logger.warn('[config] WARNING: JWT_SECRET is using default value, please change in production!')
-  }
-
   if (!process.env.REDIS_HOST) {
     logger.warn('[config] REDIS_HOST not set, using default: 127.0.0.1')
   }
@@ -42,24 +39,47 @@ function validateConfig() {
   }
 }
 
+{{#if_eq auth "static"}}
+function checkJwtSecret() {
+  if (process.env.JWT_SECRET === 'please-change-this-in-production' || !process.env.JWT_SECRET) {
+    if (process.env.NODE_ENV === 'production') {
+      logger.error('[config] JWT_SECRET must be set in production!')
+      return false
+    }
+    logger.warn('[config] WARNING: JWT_SECRET is using default value, please change in production!')
+  }
+  return true
+}
+{{else}}
+function checkOIDCConfig() {
+  const issuer = process.env.OIDC_ISSUER
+  const jwksUri = process.env.OIDC_JWKS_URI
+  if (!issuer && !jwksUri) {
+    logger.error('[config] OIDC_ISSUER or OIDC_JWKS_URI must be set for jwks auth')
+    return false
+  }
+  if (process.env.NODE_ENV === 'production' && !process.env.OIDC_AUDIENCE) {
+    logger.warn('[config] OIDC_AUDIENCE is not set; audience verification will be skipped')
+  }
+  return true
+}
+{{/if_eq}}
+
 function checkRequiredEnv() {
   const result = validateConfig()
-  
+
   if (result.errors.length > 0) {
     logger.error('[config] Configuration validation failed:')
     result.errors.forEach((err) => logger.error(`  - ${err}`))
     return false
   }
 
-  if (process.env.NODE_ENV === 'production') {
-    if (!process.env.JWT_SECRET || process.env.JWT_SECRET === 'please-change-this-in-production') {
-      logger.error('[config] JWT_SECRET must be set in production!')
-      return false
-    }
-  }
-
   logger.info('[config] Configuration validation passed')
   return true
 }
 
-module.exports = { validateConfig, checkRequiredEnv }
+{{#if_eq auth "static"}}
+module.exports = { validateConfig, checkJwtSecret, checkRequiredEnv }
+{{else}}
+module.exports = { validateConfig, checkOIDCConfig, checkRequiredEnv }
+{{/if_eq}}