create-skweb 2.1.0 → 3.0.3

package/templates/ts/src/controllers/user.ts

@@ -3,99 +3,212 @@ import { db } from '../services/database.js'
 
 const { SysUser } = db.sequelize.models
 
-export default [
-  {
-    method: 'get',
-    path: '/api/users',
-    async handler(req: any) {
-      const { page = 1, limit = 10 } = req.query
-      const users = await SysUser.findAndCountAll({
-        offset: (Number(page) - 1) * Number(limit),
-        limit: Number(limit)
-      })
-      return {
-        list: users.rows,
-        total: users.count
-      }
+/**
+ * @swagger
+ * /api/users:
+ *   get:
+ *     summary: 获取用户列表
+ *     tags: [Users]
+ *     parameters:
+ *       - in: query
+ *         name: page
+ *         schema: { type: integer, minimum: 1, default: 1 }
+ *         description: 页码
+ *       - in: query
+ *         name: limit
+ *         schema: { type: integer, minimum: 1, default: 10 }
+ *         description: 每页条数
+ *     responses:
+ *       200:
+ *         description: OK
+ */
+const userList = {
+  method: 'get',
+  path: '/api/users',
+  async handler(req: any) {
+    const { page = 1, limit = 10 } = req.query
+    const users = await SysUser.findAndCountAll({
+      offset: (Number(page) - 1) * Number(limit),
+      limit: Number(limit)
+    })
+    return {
+      list: users.rows,
+      total: users.count
     }
+  }
+}
+
+/**
+ * @swagger
+ * /api/users/{id}:
+ *   get:
+ *     summary: 获取单个用户
+ *     tags: [Users]
+ *     parameters:
+ *       - in: path
+ *         name: id
+ *         required: true
+ *         schema: { type: integer, minimum: 1 }
+ *     responses:
+ *       200:
+ *         description: OK
+ *       404:
+ *         description: 用户不存在
+ */
+const userGet = {
+  method: 'get',
+  path: '/api/users/:id',
+  paramsSchema: {
+    type: 'object',
+    required: ['id'],
+    properties: { id: { type: 'integer', minimum: 1 } }
   },
-  {
-    method: 'get',
-    path: '/api/users/:id',
-    paramsSchema: {
-      type: 'object',
-      required: ['id'],
-      properties: { id: { type: 'integer', minimum: 1 } }
-    },
-    async handler(req: any) {
-      const { id } = req.validatedParams
-      const user = await SysUser.findByPk(id)
-      if (!user) {
-        throw new createHttpError.NotFound('User not found')
-      }
-      return user
+  async handler(req: any) {
+    const { id } = req.validatedParams
+    const user = await SysUser.findByPk(id)
+    if (!user) {
+      throw new createHttpError.NotFound('User not found')
+    }
+    return user
+  }
+}
+
+/**
+ * @swagger
+ * /api/users:
+ *   post:
+ *     summary: 创建用户
+ *     tags: [Users]
+ *     requestBody:
+ *       required: true
+ *       content:
+ *         application/json:
+ *           schema:
+ *             type: object
+ *             required: [username, password]
+ *             properties:
+ *               username: { type: string, minLength: 3 }
+ *               password: { type: string, minLength: 6 }
+ *               email:    { type: string, format: email }
+ *               phone:    { type: string }
+ *     responses:
+ *       200:
+ *         description: 创建成功
+ */
+const userCreate = {
+  method: 'post',
+  path: '/api/users',
+  bodySchema: {
+    type: 'object',
+    required: ['username', 'password'],
+    properties: {
+      username: { type: 'string', minLength: 3 },
+      password: { type: 'string', minLength: 6 },
+      email: { type: 'string', format: 'email' },
+      phone: { type: 'string' }
     }
   },
-  {
-    method: 'post',
-    path: '/api/users',
-    bodySchema: {
-      type: 'object',
-      required: ['username', 'password'],
-      properties: {
-        username: { type: 'string', minLength: 3 },
-        password: { type: 'string', minLength: 6 },
-        email: { type: 'string', format: 'email' },
-        phone: { type: 'string' }
-      }
-    },
-    async handler(req: any) {
-      return await SysUser.create(req.validatedBody)
+  async handler(req: any) {
+    return await SysUser.create(req.validatedBody)
+  }
+}
+
+/**
+ * @swagger
+ * /api/users/{id}:
+ *   put:
+ *     summary: 更新用户
+ *     tags: [Users]
+ *     parameters:
+ *       - in: path
+ *         name: id
+ *         required: true
+ *         schema: { type: integer, minimum: 1 }
+ *     requestBody:
+ *       required: true
+ *       content:
+ *         application/json:
+ *           schema:
+ *             type: object
+ *             properties:
+ *               password: { type: string, minLength: 6 }
+ *               email:    { type: string, format: email }
+ *               phone:    { type: string }
+ *               status:   { type: integer }
+ *     responses:
+ *       200:
+ *         description: OK
+ *       404:
+ *         description: 用户不存在
+ */
+const userUpdate = {
+  method: 'put',
+  path: '/api/users/:id',
+  paramsSchema: {
+    type: 'object',
+    required: ['id'],
+    properties: { id: { type: 'integer', minimum: 1 } }
+  },
+  bodySchema: {
+    type: 'object',
+    properties: {
+      password: { type: 'string', minLength: 6 },
+      email: { type: 'string', format: 'email' },
+      phone: { type: 'string' },
+      status: { type: 'integer' }
     }
   },
-  {
-    method: 'put',
-    path: '/api/users/:id',
-    paramsSchema: {
-      type: 'object',
-      required: ['id'],
-      properties: { id: { type: 'integer', minimum: 1 } }
-    },
-    bodySchema: {
-      type: 'object',
-      properties: {
-        password: { type: 'string', minLength: 6 },
-        email: { type: 'string', format: 'email' },
-        phone: { type: 'string' },
-        status: { type: 'integer' }
-      }
-    },
-    async handler(req: any) {
-      const { id } = req.validatedParams
-      const user = await SysUser.findByPk(id)
-      if (!user) {
-        throw new createHttpError.NotFound('User not found')
-      }
-      await user.update(req.validatedBody)
-      return user
+  async handler(req: any) {
+    const { id } = req.validatedParams
+    const user = await SysUser.findByPk(id)
+    if (!user) {
+      throw new createHttpError.NotFound('User not found')
     }
+    await user.update(req.validatedBody)
+    return user
+  }
+}
+
+/**
+ * @swagger
+ * /api/users/{id}:
+ *   delete:
+ *     summary: 删除用户
+ *     tags: [Users]
+ *     parameters:
+ *       - in: path
+ *         name: id
+ *         required: true
+ *         schema: { type: integer, minimum: 1 }
+ *     responses:
+ *       200:
+ *         description: OK
+ *       404:
+ *         description: 用户不存在
+ */
+const userDelete = {
+  method: 'delete',
+  path: '/api/users/:id',
+  paramsSchema: {
+    type: 'object',
+    required: ['id'],
+    properties: { id: { type: 'integer', minimum: 1 } }
   },
-  {
-    method: 'delete',
-    path: '/api/users/:id',
-    paramsSchema: {
-      type: 'object',
-      required: ['id'],
-      properties: { id: { type: 'integer', minimum: 1 } }
-    },
-    async handler(req: any) {
-      const { id } = req.validatedParams
-      const user = await SysUser.findByPk(id)
-      if (!user) {
-        throw new createHttpError.NotFound('User not found')
-      }
-      await user.destroy()
-      return { message: 'User deleted' }
+  async handler(req: any) {
+    const { id } = req.validatedParams
+    const user = await SysUser.findByPk(id)
+    if (!user) {
+      throw new createHttpError.NotFound('User not found')
     }
+    await user.destroy()
+    return { message: 'User deleted' }
   }
-]
+}
+
+export default {
+  userList,
+  userGet,
+  userCreate,
+  userUpdate,
+  userDelete
+}

package/templates/ts/src/cronWorker.ts

@@ -66,16 +66,14 @@ async function startCronWorker(): Promise<void> {
   framework.start()
   logger.info('[cron-worker] Cron worker started')
 
-  process.on('SIGINT', async () => {
-    logger.info('[cron-worker] Received SIGINT, shutting down...')
-    await framework.stop()
-    process.exit(0)
+  // 未捕获异常：打印堆栈后直接退出。OS / 进程管理器负责回收资源。
+  process.on('uncaughtException', (err) => {
+    logger.error(`[cron-worker] uncaughtException: ${err.stack || err.message}`)
+    process.exit(1)
   })
-
-  process.on('SIGTERM', async () => {
-    logger.info('[cron-worker] Received SIGTERM, shutting down...')
-    await framework.stop()
-    process.exit(0)
+  process.on('unhandledRejection', (reason) => {
+    logger.error(`[cron-worker] unhandledRejection: ${reason instanceof Error ? reason.stack : String(reason)}`)
+    process.exit(1)
   })
 }
 

package/templates/ts/tsconfig.json

@@ -1,9 +1,9 @@
 {
   "compilerOptions": {
-    "target": "ES2020",
+    "target": "ES2022",
     "module": "ESNext",
-    "lib": ["ES2020"],
-    "moduleResolution": "Node",
+    "lib": ["ES2022"],
+    "moduleResolution": "Bundler",
     "strict": true,
     "esModuleInterop": true,
     "skipLibCheck": true,
@@ -12,8 +12,7 @@
     "declaration": true,
     "sourceMap": true,
     "rootDir": "src",
-    "outDir": "dist",
-    "baseUrl": "."
+    "outDir": "dist"
   },
   "include": ["src/**/*.ts"],
   "exclude": ["node_modules", "dist", "test"]

package/test/index.mjs

@@ -8,6 +8,12 @@ import { createProject, printBanner, printSuccess } from '../dist/index.js'
 const __filename = fileURLToPath(import.meta.url)
 const __dirname = path.dirname(__filename)
 
+// helper: createProject 把项目放在 <dest>/<name> 下，
+// 测试断言用的所有路径都要走 <dest>/<name>。
+function projectPath(tmpDir, name = 'my-app') {
+  return path.join(tmpDir, name)
+}
+
 describe('create-skweb', () => {
   describe('createProject()', () => {
     let tmpDir
@@ -21,42 +27,47 @@ describe('create-skweb', () => {
     })
 
     it('should create TypeScript project from template', async () => {
+      const root = projectPath(tmpDir)
       await createProject({
         name: 'my-app',
         template: 'ts',
         dest: tmpDir
       })
 
-      expect(fs.existsSync(path.join(tmpDir, 'package.json'))).to.be.true
-      expect(fs.existsSync(path.join(tmpDir, 'src', 'app.ts'))).to.be.true
-      expect(fs.existsSync(path.join(tmpDir, 'src', 'utils', 'logger.ts'))).to.be.true
+      expect(fs.existsSync(path.join(root, 'package.json'))).to.be.true
+      expect(fs.existsSync(path.join(root, 'src', 'app.ts'))).to.be.true
+      expect(fs.existsSync(path.join(root, 'src', 'utils', 'logger.ts'))).to.be.true
     })
 
     it('should create MJS project from template', async () => {
+      const root = projectPath(tmpDir)
       await createProject({
         name: 'my-app',
         template: 'mjs',
         dest: tmpDir
       })
 
-      expect(fs.existsSync(path.join(tmpDir, 'package.json'))).to.be.true
-      expect(fs.existsSync(path.join(tmpDir, 'src', 'app.js'))).to.be.true
+      expect(fs.existsSync(path.join(root, 'package.json'))).to.be.true
+      expect(fs.existsSync(path.join(root, 'src', 'app.js'))).to.be.true
     })
 
     it('should create CJS project from template', async () => {
+      const root = projectPath(tmpDir)
       await createProject({
         name: 'my-app',
         template: 'cjs',
         dest: tmpDir
       })
 
-      expect(fs.existsSync(path.join(tmpDir, 'package.json'))).to.be.true
-      expect(fs.existsSync(path.join(tmpDir, 'src', 'app.js'))).to.be.true
+      expect(fs.existsSync(path.join(root, 'package.json'))).to.be.true
+      expect(fs.existsSync(path.join(root, 'src', 'app.js'))).to.be.true
     })
 
     it('should reject non-empty destination directory', async () => {
-      // 在 tmpDir 中创建一个文件
-      fs.writeFileSync(path.join(tmpDir, 'existing.txt'), 'x')
+      // 在目标项目目录 (tmpDir/my-app) 里创建一个文件，createProject 应拒绝
+      const target = projectPath(tmpDir)
+      fs.mkdirsSync(target)
+      fs.writeFileSync(path.join(target, 'existing.txt'), 'x')
 
       try {
         await createProject({
@@ -79,7 +90,7 @@ describe('create-skweb', () => {
           template,
           dest: tmpDir
         })
-        const pkg = JSON.parse(fs.readFileSync(path.join(tmpDir, 'package.json'), 'utf-8'))
+        const pkg = JSON.parse(fs.readFileSync(path.join(projectPath(tmpDir), 'package.json'), 'utf-8'))
         expect(pkg.dependencies.winston, `${template} should have winston dep`).to.exist
       }
     })
@@ -93,7 +104,7 @@ describe('create-skweb', () => {
           template,
           dest: tmpDir
         })
-        const pkg = JSON.parse(fs.readFileSync(path.join(tmpDir, 'package.json'), 'utf-8'))
+        const pkg = JSON.parse(fs.readFileSync(path.join(projectPath(tmpDir), 'package.json'), 'utf-8'))
         expect(pkg.dependencies['@dotenvx/dotenvx'], `${template} should have dotenvx`).to.exist
       }
     })
@@ -107,7 +118,7 @@ describe('create-skweb', () => {
           template,
           dest: tmpDir
         })
-        expect(fs.existsSync(path.join(tmpDir, 'ecosystem.config.js')), `${template} should have pm2 ecosystem`).to.be.true
+        expect(fs.existsSync(path.join(projectPath(tmpDir), 'ecosystem.config.js')), `${template} should have pm2 ecosystem`).to.be.true
       }
     })
 
@@ -117,7 +128,7 @@ describe('create-skweb', () => {
         template: 'ts',
         dest: tmpDir
       })
-      const pkg = JSON.parse(fs.readFileSync(path.join(tmpDir, 'package.json'), 'utf-8'))
+      const pkg = JSON.parse(fs.readFileSync(path.join(projectPath(tmpDir, 'my-custom-app'), 'package.json'), 'utf-8'))
       expect(pkg.name).to.equal('my-custom-app')
       expect(pkg.name).to.not.match(/\{\{name\}\}/)
     })

package/tsconfig.json

@@ -1,20 +1,20 @@
 {
   "compilerOptions": {
-    "target": "ES2020",
+    "composite": true,
+    "target": "ES2022",
     "module": "ESNext",
-    "lib": ["ES2020"],
-    "moduleResolution": "Node",
+    "lib": ["ES2022"],
+    "moduleResolution": "Bundler",
     "strict": true,
     "esModuleInterop": true,
     "skipLibCheck": true,
     "forceConsistentCasingInFileNames": true,
     "resolveJsonModule": true,
     "declaration": true,
-    "declarationMap": true,
-    "sourceMap": true,
+    "declarationMap": false,
+    "sourceMap": false,
     "rootDir": "src",
     "outDir": "dist",
-    "baseUrl": ".",
     "types": ["node"]
   },
   "include": ["src/**/*.ts"],