create-skweb 1.1.5 → 2.1.0

package/templates/ts/src/swagger.ts

@@ -0,0 +1,54 @@
+import path from 'path'
+import { fileURLToPath } from 'url'
+import swaggerJSDoc from 'swagger-jsdoc'
+
+const __filename = fileURLToPath(import.meta.url)
+const __dirname = path.dirname(__filename)
+
+/**
+ * 构建 OpenAPI 3.0 规范对象。
+ *
+ * 控制器中应使用 @swagger JSDoc 注释描述端点，例如：
+ *
+ *   /**
+ *    * @swagger
+ *    * /api/users:
+ *    *   get:
+ *    *     summary: 获取用户列表
+ *    *     tags: [Users]
+ *    *     responses:
+ *    *       200:
+ *    *         description: OK
+ *    *\/
+ */
+export function buildOpenApiSpec(): object {
+  return swaggerJSDoc({
+    definition: {
+      openapi: '3.0.3',
+      info: {
+        title: process.env.APP_NAME || 'SKWeb API',
+        version: process.env.API_VERSION || '1.0.0',
+        description: process.env.APP_DESCRIPTION || 'SKWeb project API documentation',
+        contact: { name: 'API Support' }
+      },
+      servers: [
+        { url: `http://localhost:${process.env.PORT || 3000}`, description: 'Local development' }
+      ],
+      components: {
+        securitySchemes: {
+          bearerAuth: {
+            type: 'http',
+            scheme: 'bearer',
+            bearerFormat: 'JWT',
+            description: 'Paste a JWT token here (only needed when AUTH_PROVIDER=static)'
+          }
+        }
+      }
+    },
+    // 扫描 controllers 目录与 src 根下的 JSDoc 注释
+    apis: [
+      path.join(__dirname, 'controllers', '*.ts'),
+      path.join(__dirname, 'controllers', '*.js')
+    ]
+  })
+}

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')
-}