create-skweb 2.0.0 → 2.1.0

package/.turbo/turbo-build.log

@@ -1,18 +1,18 @@
 
 
-> create-skweb@2.0.0 prebuild
+> create-skweb@2.1.0 prebuild
 > tsc --outDir dist --rootDir src
 
 ⠙
-> create-skweb@2.0.0 build
-> rollup -c rollup.config.mjs && node scripts/inject-shebang.cjs && chmod +x dist/cli.cjs
+> create-skweb@2.1.0 build
+> rollup -c rollup.config.mjs && node scripts/inject-shebang.mjs && chmod +x dist/cli.cjs
 
 ⠙
 src/index.ts → dist/index.js, dist/index.cjs...
-created dist/index.js, dist/index.cjs in 398ms
+created dist/index.js, dist/index.cjs in 372ms
 
 src/cli.ts → dist/cli.cjs...
 (!) Plugin replace: @rollup/plugin-replace: 'preventAssignment' currently defaults to false. It is recommended to set this option to `true`, as the next major version will default this option to `true`.
-created dist/cli.cjs in 245ms
-[inject-shebang] Shebang added to dist/cli.cjs
+created dist/cli.cjs in 295ms
+[inject-shebang] Shebang added to /Users/stayknight/projects/skweb-mono/tools/create-skweb/dist/cli.cjs
 ⠙

package/CHANGELOG.md

@@ -1,5 +1,32 @@
 # create-skweb
 
+## 2.1.0
+
+### Minor Changes
+
+- 4afc39b: 修复多个技术层与设计层问题：
+
+  **skweb-express**
+
+  - 修复 `setUserAuth` / `setVerifyAuth` 类型签名（增加 `key` 参数），与实现对齐
+  - `permission.ts` 加入互斥检查：`setUserAuth` 与 `setVerifyAuth` 不可同时调用
+  - `createAuthVerify` 修复 `authResult` 未写回 `req[key]` 的 bug，改用 `_.merge` 避免污染返回值
+  - `index.ts` 移除误挂载在 `app.useController` 上的方法
+  - `response.ts` 增强安全性：默认隐藏 5xx 内部错误消息，可通过 `app.set('hideISE', false)` 显式开启
+
+  **skweb-framework**
+
+  - `WebFramework` / `CronFramework` 新增 `stop()` 方法，支持 SIGINT/SIGTERM 优雅关闭（关闭 HTTP server / cron manager / DB 连接 / Redis）
+
+  **create-skweb**
+
+  - `sync-template-versions.mjs` 增强 dry-run 引导：启动时显式声明模式，新增 `--help` 与 STRICT 模式彩色输出
+  - `inject-shebang.cjs` 迁移为 `inject-shebang.mjs`（与 ESM 风格统一），支持目标文件参数，修复 `skweb-cli` 构建时 shebang 错位到 `create-skweb/dist/` 的 bug
+  - `skweb-cli/package.json` 修复 `inject-shebang` 路径错误（`../../scripts/` → `../create-skweb/scripts/`）
+  - 三个模板（cjs/mjs/ts）的 `.gitignore` 完全统一，补齐 `coverage/`、`.rollup.cache/`、IDE/日志/测试产物等通用项
+  - ts 模板补齐 `tslib` 与 `@rollup/plugin-json` 依赖，修复 `rollup.config.mjs` 缺 `json()` 插件
+  - ts 模板 `cronWorker.ts` 改用 `framework.dbInstance`（受保护的 `db` 改用公共 getter）
+
 ## 2.0.0
 
 ### Major Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-skweb",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "Create a new SKWeb project with TypeScript, CJS, or MJS support",
   "type": "module",
   "main": "dist/index.cjs",
@@ -13,11 +13,14 @@
     "clean": "rm -rf dist",
     "clean:temp": "rm -rf .rollup.cache",
     "prebuild": "tsc --outDir dist --rootDir src",
-    "build": "rollup -c rollup.config.mjs && node scripts/inject-shebang.cjs && chmod +x dist/cli.cjs",
-    "build:dev": "rollup -c rollup.config.mjs --environment NODE_ENV:development && node scripts/inject-shebang.cjs && chmod +x dist/cli.cjs",
+    "build": "rollup -c rollup.config.mjs && node scripts/inject-shebang.mjs && chmod +x dist/cli.cjs",
+    "build:dev": "rollup -c rollup.config.mjs --environment NODE_ENV:development && node scripts/inject-shebang.mjs && chmod +x dist/cli.cjs",
     "lint": "eslint --fix --ext .ts src",
     "check": "tsc --noEmit",
-    "test": "mocha test/**/*.mjs"
+    "test": "mocha test/**/*.mjs",
+    "sync:versions": "node scripts/sync-template-versions.mjs",
+    "sync:versions:apply": "node scripts/sync-template-versions.mjs --apply",
+    "sync:versions:strict": "node scripts/sync-template-versions.mjs --strict"
   },
   "dependencies": {
     "commander": "^12.1.0",

package/scripts/inject-shebang.mjs

@@ -0,0 +1,39 @@
+#!/usr/bin/env node
+//
+// inject-shebang.mjs
+//
+// 给 rollup 产出的 CLI 文件加 shebang。
+// rollup 在某些场景下会丢失或重复 shebang（特别是使用 @rollup/plugin-replace
+// 替换 /usr/bin/env 时），这里统一收口。
+//
+// 用法：
+//   node scripts/inject-shebang.mjs                # 默认 ./dist/cli.cjs
+//   node scripts/inject-shebang.mjs dist/cli.cjs   # 相对 cwd 的目标
+//   node scripts/inject-shebang.mjs /abs/path/cli  # 绝对路径
+//
+// 说明：
+//   - 已存在 shebang 时跳过，不重复添加
+//   - 文件不存在时给出明确错误信息（避免静默失败）
+//
+
+import fs from 'node:fs'
+import path from 'node:path'
+
+const SHEBANG = '#!/usr/bin/env node\n'
+
+const arg = process.argv[2]
+const target = arg ? path.resolve(arg) : path.resolve('dist/cli.cjs')
+
+if (!fs.existsSync(target)) {
+  console.error(`[inject-shebang] target not found: ${target}`)
+  process.exit(1)
+}
+
+let content = fs.readFileSync(target, 'utf-8')
+if (content.startsWith('#!')) {
+  console.log(`[inject-shebang] Shebang already present in ${target}`)
+  process.exit(0)
+}
+
+fs.writeFileSync(target, SHEBANG + content, 'utf-8')
+console.log(`[inject-shebang] Shebang added to ${target}`)

package/scripts/sync-template-versions.mjs

@@ -0,0 +1,201 @@
+#!/usr/bin/env node
+//
+// sync-template-versions.mjs
+//
+// 把本工程 packages 下的 skweb-* 包版本号
+// 同步到 tools/create-skweb/templates 下的 package.json。
+//
+// 用法：
+//   node scripts/sync-template-versions.mjs            # 默认 dry-run，仅打印
+//   node scripts/sync-template-versions.mjs --apply    # 写回文件
+//   node scripts/sync-template-versions.mjs --strict   # 严格模式：发现不一致退出码 1
+//   node scripts/sync-template-versions.mjs --help     # 查看帮助
+//
+// 同步规则：
+//   - workspace 的 X.Y.Z 映射到模板的 ^X.Y.0
+//   - 仅修改 skweb-* 开头的依赖（其他依赖不动）
+//   - 仅处理 templates 目录下 .json 文件
+//
+// 退出码：
+//   0  全部一致，或已 --apply 写回
+//   1  --strict 模式下发现不一致且未 --apply
+//   2  执行过程异常
+//
+// 建议在以下时机执行：
+//   - 每次 changeset version 之后
+//   - 提交前
+//   - CI 发布前
+//
+
+import fs from 'node:fs'
+import path from 'node:path'
+import { fileURLToPath } from 'node:url'
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url))
+const ROOT = path.join(__dirname, '..', '..', '..') // -> skweb-mono/
+const PACKAGES_DIR = path.join(ROOT, 'packages')
+const TEMPLATES_DIR = path.join(__dirname, '..', 'templates')
+
+// ANSI 颜色（仅在 TTY 启用，避免污染 CI 日志）
+const useColor = process.stdout.isTTY && !process.env.NO_COLOR
+const color = (code) => (useColor ? `\x1b[${code}m` : '')
+const cBold = color('1')
+const cYellow = color('33')
+const cRed = color('31')
+const cGreen = color('32')
+const cCyan = color('36')
+const cReset = color('0')
+
+function showHelp() {
+  console.log(`${cBold}sync-template-versions${cReset}
+把 packages/ 下的 skweb-* 版本号同步到 templates/ 下的 package.json。
+
+${cBold}用法${cReset}
+  ${cCyan}node scripts/sync-template-versions.mjs${cReset}              ${cYellow}# 默认 dry-run${cReset}
+  ${cCyan}node scripts/sync-template-versions.mjs --apply${cReset}      # 写回文件
+  ${cCyan}node scripts/sync-template-versions.mjs --strict${cReset}     # 严格模式（CI 推荐）
+  ${cCyan}node scripts/sync-template-versions.mjs --help${cReset}       # 查看帮助
+
+${cBold}同步规则${cReset}
+  - workspace 的 X.Y.Z 映射到模板的 ^X.Y.0
+  - 仅修改 skweb-* 开头的依赖
+  - 仅处理 templates 目录下 *.json
+
+${cBold}退出码${cReset}
+  0  全部一致，或已 --apply 写回
+  1  --strict 模式下发现不一致且未 --apply
+  2  执行过程异常
+
+${cBold}同步规则说明${cReset}
+  使用 ${cCyan}--apply${cReset} 真正写入文件；不带 --apply 永远只打印，不会改动模板。`)
+}
+
+const APPLY = process.argv.includes('--apply')
+const STRICT = process.argv.includes('--strict')
+const HELP = process.argv.includes('--help') || process.argv.includes('-h')
+
+if (HELP) {
+  showHelp()
+  process.exit(0)
+}
+
+// 扫描 packages/ 下所有 package.json，返回 { 包名: 版本 } 映射。
+function loadWorkspaceVersions() {
+  const result = {}
+  if (!fs.existsSync(PACKAGES_DIR)) {
+    throw new Error(`packages dir not found: ${PACKAGES_DIR}`)
+  }
+  for (const dir of fs.readdirSync(PACKAGES_DIR)) {
+    const pkgJsonPath = path.join(PACKAGES_DIR, dir, 'package.json')
+    if (!fs.existsSync(pkgJsonPath)) continue
+    const pkg = JSON.parse(fs.readFileSync(pkgJsonPath, 'utf-8'))
+    if (pkg.name && pkg.version) {
+      result[pkg.name] = pkg.version
+    }
+  }
+  return result
+}
+
+// 把 X.Y.Z 转换为 ^X.Y.0 范围，允许 minor/patch 升级。
+function toRange(version) {
+  const parts = version.split('.')
+  if (parts.length < 2) {
+    throw new Error(`unexpected version format: ${version}`)
+  }
+  return `^${parts[0]}.${parts[1]}.0`
+}
+
+// 同步单个模板文件，返回变更列表。
+function syncTemplate(templatePath, workspaceVersions) {
+  const raw = fs.readFileSync(templatePath, 'utf-8')
+  const pkg = JSON.parse(raw)
+  const deps = pkg.dependencies || {}
+  const changes = []
+
+  for (const depName of Object.keys(deps)) {
+    if (!depName.startsWith('skweb-')) continue
+    if (!workspaceVersions[depName]) continue
+    const newRange = toRange(workspaceVersions[depName])
+    const oldRange = deps[depName]
+    if (oldRange !== newRange) {
+      changes.push({ dep: depName, old: oldRange, new: newRange })
+      deps[depName] = newRange
+    }
+  }
+
+  if (changes.length > 0 && APPLY) {
+    const updated = JSON.stringify(pkg, null, 2) + '\n'
+    fs.writeFileSync(templatePath, updated, 'utf-8')
+  }
+
+  return changes
+}
+
+function main() {
+  // 在最顶部打印运行模式，避免用户漏看后续信息
+  if (APPLY) {
+    console.log(`${cGreen}[sync] mode: APPLY (will write to files)${cReset}`)
+  } else {
+    console.log(`${cYellow}[sync] mode: DRY-RUN (no files will be modified; pass --apply to write)${cReset}`)
+  }
+  if (STRICT) {
+    console.log(`${cYellow}[sync] mode: STRICT (will exit 1 on pending changes)${cReset}`)
+  }
+  console.log('')
+
+  const workspaceVersions = loadWorkspaceVersions()
+  console.log(`[sync] workspace versions: ${Object.keys(workspaceVersions).length} packages`)
+  for (const [name, ver] of Object.entries(workspaceVersions)) {
+    console.log(`  ${name}: ${ver} -> ${toRange(ver)}`)
+  }
+  console.log('')
+
+  if (!fs.existsSync(TEMPLATES_DIR)) {
+    throw new Error(`templates dir not found: ${TEMPLATES_DIR}`)
+  }
+
+  let totalChanges = 0
+  const templateDirs = fs.readdirSync(TEMPLATES_DIR).filter(d => {
+    const full = path.join(TEMPLATES_DIR, d)
+    return fs.statSync(full).isDirectory()
+  })
+
+  for (const tpl of templateDirs) {
+    const pkgJson = path.join(TEMPLATES_DIR, tpl, 'package.json')
+    if (!fs.existsSync(pkgJson)) continue
+    const changes = syncTemplate(pkgJson, workspaceVersions)
+    if (changes.length === 0) {
+      console.log(`[sync] ${tpl}/package.json: in sync`)
+    } else {
+      totalChanges += changes.length
+      const tag = APPLY ? `${cGreen}[APPLIED]${cReset}` : `${cYellow}[dry-run]${cReset}`
+      console.log(`[sync] ${tpl}/package.json: ${changes.length} update(s) ${tag}`)
+      for (const c of changes) {
+        console.log(`    ${c.dep}: ${c.old} -> ${c.new}`)
+      }
+    }
+  }
+
+  console.log('')
+  if (totalChanges === 0) {
+    console.log(`${cGreen}[sync] All templates are in sync with workspace versions.${cReset}`)
+  } else if (APPLY) {
+    console.log(`${cGreen}[sync] Applied ${totalChanges} update(s).${cReset}`)
+  } else {
+    console.log(
+      `${cYellow}[sync] ${totalChanges} update(s) pending.${cReset} ` +
+      `${cBold}Re-run with ${cCyan}--apply${cReset}${cBold} to write.${cReset}`
+    )
+    if (STRICT) {
+      console.log(`${cRed}[sync] STRICT mode: exiting with code 1.${cReset}`)
+      process.exit(1)
+    }
+  }
+}
+
+try {
+  main()
+} catch (err) {
+  console.error('[sync] FAILED:', err.message)
+  process.exit(2)
+}

package/templates/cjs/package.json

@@ -22,15 +22,15 @@
   "dependencies": {
     "@dotenvx/dotenvx": "^1.71.0",
     "http-errors": "^2.0.0",
-    "skweb-express": "^1.0.0",
-    "skweb-express-jwt": "^1.2.0",
-    "skweb-express-logger": "^1.0.0",
-    "skweb-sequelize": "^1.0.0",
-    "skweb-redis": "^1.0.0",
-    "skweb-cron": "^1.0.0",
-    "skweb-framework": "^1.0.0",
-    "skweb-plugin": "^1.0.0",
-    "skweb-util": "^1.0.0",
+    "skweb-express": "^1.1.0",
+    "skweb-express-jwt": "^2.0.0",
+    "skweb-express-logger": "^1.1.0",
+    "skweb-sequelize": "^1.1.0",
+    "skweb-redis": "^1.1.0",
+    "skweb-cron": "^1.1.0",
+    "skweb-framework": "^1.1.0",
+    "skweb-plugin": "^1.1.0",
+    "skweb-util": "^1.1.0",
     "winston": "^3.17.0",
     "sequelize": "^6.37.7",
     "swagger-jsdoc": "^6.2.8",

package/templates/mjs/package.json

@@ -22,15 +22,15 @@
   "dependencies": {
     "@dotenvx/dotenvx": "^1.71.0",
     "http-errors": "^2.0.0",
-    "skweb-express": "^1.0.0",
-    "skweb-express-jwt": "^1.2.0",
-    "skweb-express-logger": "^1.0.0",
-    "skweb-sequelize": "^1.0.0",
-    "skweb-redis": "^1.0.0",
-    "skweb-cron": "^1.0.0",
-    "skweb-framework": "^1.0.0",
-    "skweb-plugin": "^1.0.0",
-    "skweb-util": "^1.0.0",
+    "skweb-express": "^1.1.0",
+    "skweb-express-jwt": "^2.0.0",
+    "skweb-express-logger": "^1.1.0",
+    "skweb-sequelize": "^1.1.0",
+    "skweb-redis": "^1.1.0",
+    "skweb-cron": "^1.1.0",
+    "skweb-framework": "^1.1.0",
+    "skweb-plugin": "^1.1.0",
+    "skweb-util": "^1.1.0",
     "winston": "^3.17.0",
     "sequelize": "^6.37.7",
     "swagger-jsdoc": "^6.2.8",

package/templates/ts/package.json

@@ -24,15 +24,15 @@
   "dependencies": {
     "@dotenvx/dotenvx": "^1.71.0",
     "http-errors": "^2.0.0",
-    "skweb-express": "^1.0.0",
-    "skweb-express-jwt": "^1.2.0",
-    "skweb-express-logger": "^1.0.0",
-    "skweb-sequelize": "^1.0.0",
-    "skweb-redis": "^1.0.0",
-    "skweb-cron": "^1.0.0",
-    "skweb-framework": "^1.0.0",
-    "skweb-plugin": "^1.0.0",
-    "skweb-util": "^1.0.0",
+    "skweb-express": "^1.1.0",
+    "skweb-express-jwt": "^2.0.0",
+    "skweb-express-logger": "^1.1.0",
+    "skweb-sequelize": "^1.1.0",
+    "skweb-redis": "^1.1.0",
+    "skweb-cron": "^1.1.0",
+    "skweb-framework": "^1.1.0",
+    "skweb-plugin": "^1.1.0",
+    "skweb-util": "^1.1.0",
     "winston": "^3.17.0",
     "sequelize": "^6.37.7",
     "swagger-jsdoc": "^6.2.8",
@@ -48,10 +48,13 @@
     "mocha": "^11.7.5",
     "tsx": "^4.22.4",
     "typescript": "^5.9.3",
+    "tslib": "^2.8.1",
     "rollup": "^2.79.2",
     "@rollup/plugin-typescript": "^12.3.0",
+    "@rollup/plugin-json": "^6.1.0",
     "@rollup/plugin-node-resolve": "^16.0.3",
     "@rollup/plugin-commonjs": "^29.0.0",
+    "@rollup/plugin-terser": "^0.4.4",
     "eslint": "^9.39.1",
     "typescript-eslint": "^8.49.0"
   },

package/templates/ts/rollup.config.mjs

@@ -2,6 +2,7 @@ import resolve from '@rollup/plugin-node-resolve'
 import commonjs from '@rollup/plugin-commonjs'
 import typescript from '@rollup/plugin-typescript'
 import terser from '@rollup/plugin-terser'
+import json from '@rollup/plugin-json'
 
 const isProduction = process.env.NODE_ENV === 'production'
 
@@ -15,6 +16,7 @@ export default {
   plugins: [
     resolve(),
     commonjs(),
+    json(),
     typescript({ tsconfig: './tsconfig.json' }),
     isProduction && terser()
   ],

package/templates/ts/src/cronWorker.ts

@@ -37,7 +37,7 @@ async function startCronWorker(): Promise<void> {
     channel: 'cron:task:cmd',
     logger,
     onSaveTask: async (taskData: { taskId: string; cache: unknown; data: unknown }) => {
-      const SysCronTask = framework.db?.sequelize?.models.SysCronTask as any
+      const SysCronTask = framework.dbInstance?.sequelize?.models.SysCronTask as any
       if (SysCronTask) {
         await SysCronTask.update(
           { cache: taskData.cache, data: taskData.data },
@@ -46,7 +46,7 @@ async function startCronWorker(): Promise<void> {
       }
     },
     loadTasks: async () => {
-      const SysCronTask = framework.db?.sequelize?.models.SysCronTask as any
+      const SysCronTask = framework.dbInstance?.sequelize?.models.SysCronTask as any
       if (!SysCronTask) return []
       return (await SysCronTask.findAll()).map((t: any) => ({
         id: String(t.id),

package/scripts/inject-shebang.cjs

@@ -1,14 +0,0 @@
-const fs = require('fs')
-const path = require('path')
-
-const target = path.join(__dirname, '..', 'dist', 'cli.cjs')
-const shebang = '#!/usr/bin/env node\n'
-
-let content = fs.readFileSync(target, 'utf-8')
-if (!content.startsWith('#!')) {
-  content = shebang + content
-  fs.writeFileSync(target, content)
-  console.log('[inject-shebang] Shebang added to dist/cli.cjs')
-} else {
-  console.log('[inject-shebang] Shebang already present')
-}