koa3-cli 1.0.2 → 1.0.4

package/README.md

@@ -38,7 +38,7 @@ npm run dev
 ## 项目结构
 
 ```
-koa2-cli/
+koa3-cli/
 ├── app/                    # 应用代码目录
 │   ├── controller/        # 控制器目录
 │   │   ├── home.js        # 首页控制器
@@ -99,18 +99,6 @@ npm start
 - API 示例: http://localhost:3000/api/user
 - 文档: http://localhost:3000/index.html
 
-### 文档开发
-
-启动 VuePress 文档开发服务器：
-```bash
-npm run docs:dev
-```
-
-构建文档为静态文件：
-```bash
-npm run docs:build
-```
-
 ## 环境配置
 
 项目支持多环境配置，通过 `NODE_ENV` 环境变量控制：
@@ -196,8 +184,8 @@ router.get('/api/product', productController.list);
 
 ## 技术栈
 
-- **Koa2**: Web 框架
-- **koa-router**: 路由
+- **Koa3**: Web 框架
+- **@koa/router**: 路由
 - **koa-bodyparser**: 请求体解析
 - **koa-static**: 静态资源服务
 - **koa-views**: 模板引擎支持

package/app/controller/home.js

@@ -7,7 +7,7 @@ class HomeController {
    */
   async index(ctx) {
     ctx.body = {
-      message: 'Welcome to Koa2 CLI',
+      message: 'Welcome to Koa3 CLI',
       version: '1.0.0',
       timestamp: new Date().toISOString()
     };

package/app/model/user.js

@@ -1,70 +1,27 @@
 /**
- * 用户数据模型
- * 负责与数据库交互
+ * 用户数据格式定义
+ * 仅描述数据结构，不包含数据访问方法
  */
 
-// 示例：模拟数据存储（实际项目中应该连接真实数据库）
-let users = [
-  { id: 1, name: '张三', email: 'zhangsan@example.com', createdAt: new Date() },
-  { id: 2, name: '李四', email: 'lisi@example.com', createdAt: new Date() }
-];
-
-class UserModel {
-  /**
-   * 查找所有用户
-   */
-  async findAll() {
-    // 实际项目中应该查询数据库
-    return users;
-  }
-
-  /**
-   * 根据ID查找用户
-   */
-  async findById(id) {
-    return users.find(user => user.id === parseInt(id));
-  }
-
-  /**
-   * 创建用户
-   */
-  async create(userData) {
-    const newUser = {
-      id: users.length > 0 ? Math.max(...users.map(u => u.id)) + 1 : 1,
-      ...userData,
-      createdAt: new Date()
-    };
-    users.push(newUser);
-    return newUser;
-  }
-
-  /**
-   * 更新用户
-   */
-  async update(id, userData) {
-    const index = users.findIndex(user => user.id === parseInt(id));
-    if (index === -1) {
-      return null;
-    }
-    users[index] = {
-      ...users[index],
-      ...userData,
-      updatedAt: new Date()
-    };
-    return users[index];
-  }
+/** @typedef {Object} User
+ * @property {number} id - 用户ID
+ * @property {string} name - 用户名
+ * @property {string} email - 邮箱
+ * @property {Date} [createdAt] - 创建时间
+ * @property {Date} [updatedAt] - 更新时间
+ */
 
-  /**
-   * 删除用户
-   */
-  async delete(id) {
-    const index = users.findIndex(user => user.id === parseInt(id));
-    if (index === -1) {
-      return false;
-    }
-    users.splice(index, 1);
-    return true;
-  }
-}
+/**
+ * 用户数据格式（用于校验、文档与默认值）
+ */
+const userSchema = {
+  id: null,
+  name: '',
+  email: '',
+  createdAt: null,
+  updatedAt: null
+};
 
-module.exports = new UserModel();
+module.exports = {
+  userSchema
+};

package/app/service/user.js

@@ -1,49 +1,51 @@
 /**
  * 用户服务层
- * 处理业务逻辑，与数据模型交互
+ * 处理业务逻辑与数据访问（示例为内存存储，实际可替换为数据库）
  */
-const userModel = require('../model/user');
+// 示例：内存存储（实际项目中应连接数据库）
+let users = [
+  { id: 1, name: '张三', email: 'zhangsan@example.com', createdAt: new Date() },
+  { id: 2, name: '李四', email: 'lisi@example.com', createdAt: new Date() }
+];
 
 class UserService {
-  /**
-   * 获取用户列表
-   */
   async getUserList() {
-    // 这里应该从数据库获取数据
-    // 示例：返回模拟数据
-    return await userModel.findAll();
+    return users;
   }
 
-  /**
-   * 根据ID获取用户
-   */
   async getUserById(id) {
-    return await userModel.findById(id);
+    return users.find(user => user.id === parseInt(id, 10));
   }
 
-  /**
-   * 创建用户
-   */
   async createUser(userData) {
-    // 数据验证
     if (!userData.name || !userData.email) {
       throw new Error('Name and email are required');
     }
-    return await userModel.create(userData);
+    const newUser = {
+      id: users.length > 0 ? Math.max(...users.map(u => u.id)) + 1 : 1,
+      ...userData,
+      createdAt: new Date()
+    };
+    users.push(newUser);
+    return newUser;
   }
 
-  /**
-   * 更新用户
-   */
   async updateUser(id, userData) {
-    return await userModel.update(id, userData);
+    const index = users.findIndex(user => user.id === parseInt(id, 10));
+    if (index === -1) return null;
+    users[index] = {
+      ...users[index],
+      ...userData,
+      updatedAt: new Date()
+    };
+    return users[index];
   }
 
-  /**
-   * 删除用户
-   */
   async deleteUser(id) {
-    return await userModel.delete(id);
+    const index = users.findIndex(user => user.id === parseInt(id, 10));
+    if (index === -1) return false;
+    users.splice(index, 1);
+    return true;
   }
 }
 

package/app.js

@@ -1,5 +1,4 @@
 const Koa = require('koa');
-const { Router } = require('@koa/router');
 const bodyParser = require('koa-bodyparser');
 const static = require('koa-static');
 const views = require('@ladjs/koa-views');
@@ -33,7 +32,7 @@ const router = require('./app/router');
 const app = new Koa();
 
 // 应用配置
-app.keys = config.keys || ['koa2-cli-secret-key'];
+app.keys = config.keys || ['koa3-cli-secret-key'];
 
 // 静态资源
 if (config.static && config.static.enable !== false) {

package/config/config.default.js

@@ -4,7 +4,7 @@
  */
 module.exports = {
   // 应用名称
-  name: 'koa2-cli',
+  name: 'koa3-cli',
   
   // 运行环境: development, production, test
   env: process.env.NODE_ENV || 'development',
@@ -13,7 +13,7 @@ module.exports = {
   port: process.env.PORT || 3000,
   
   // 密钥，用于加密cookie等
-  keys: process.env.KEYS ? process.env.KEYS.split(',') : ['koa2-cli-secret-key'],
+  keys: process.env.KEYS ? process.env.KEYS.split(',') : ['koa3-cli-secret-key'],
   
   // 静态资源配置
   static: {

package/package.json

@@ -1,43 +1,43 @@
-{
-  "name": "koa3-cli",
-  "version": "1.0.2",
-  "description": "Koa3脚手架",
-  "main": "app.js",
-  "bin": {
-    "koa3-cli": "./bin/cli.js"
-  },
-  "preferGlobal": true,
-  "scripts": {
-    "start": "node app.js",
-    "dev": "nodemon app.js",
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "keywords": [
-    "koa3",
-    "scaffold",
-    "cli"
-  ],
-  "author": "hikerw <965366906@qq.com>",
-  "repository": {
-    "type": "git",
-    "url": "https://gitee.com/wangziwl/koa3-cli"
-  },
-  "homepage": "https://atwzc.cn/",
-  "license": "MIT",
-  "dependencies": {
-    "@koa/router": "^15.2.0",
-    "@ladjs/koa-views": "^9.0.0",
-    "dotenv": "^17.2.3",
-    "ejs": "^3.1.10",
-    "koa": "^3.1.1",
-    "koa-bodyparser": "^4.4.1",
-    "koa-cors": "^0.0.16",
-    "koa-static": "^5.0.0"
-  },
-  "devDependencies": {
-    "nodemon": "^3.1.11"
-  },
-  "volta": {
-    "node": "20.18.1"
-  }
-}
+{
+  "name": "koa3-cli",
+  "version": "1.0.4",
+  "description": "Koa3脚手架",
+  "main": "app.js",
+  "bin": {
+    "koa3-cli": "bin/cli.js"
+  },
+  "preferGlobal": true,
+  "scripts": {
+    "start": "node app.js",
+    "dev": "nodemon app.js",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [
+    "koa3",
+    "scaffold",
+    "cli"
+  ],
+  "author": "hikerw <965366906@qq.com>",
+  "repository": {
+    "type": "git",
+    "url": "https://gitee.com/wangziwl/koa3-cli"
+  },
+  "homepage": "https://atwzc.cn/",
+  "license": "MIT",
+  "dependencies": {
+    "@koa/router": "^15.2.0",
+    "@ladjs/koa-views": "^9.0.0",
+    "dotenv": "^17.2.3",
+    "ejs": "^3.1.10",
+    "koa": "^3.1.1",
+    "koa-bodyparser": "^4.4.1",
+    "koa-cors": "^0.0.16",
+    "koa-static": "^5.0.0"
+  },
+  "devDependencies": {
+    "nodemon": "^3.1.11"
+  },
+  "volta": {
+    "node": "20.18.1"
+  }
+}

package/public/index.html

@@ -173,21 +173,21 @@ class UserController {
   }
 }</code></pre>
         <h4>service/</h4>
-        <p>服务层目录，处理业务逻辑。</p>
+        <p>服务层目录，处理业务逻辑与数据访问。</p>
         <pre><code class="language-javascript">// app/service/user.js
 class UserService {
   async getUserList() {
-    return await userModel.findAll();
+    return users; // 或数据库查询
   }
 }</code></pre>
         <h4>model/</h4>
-        <p>数据模型目录，处理数据访问。</p>
+        <p>数据模型目录，仅定义数据格式（结构、字段）。</p>
         <pre><code class="language-javascript">// app/model/user.js
-class UserModel {
-  async findAll() {
-    // 数据库查询逻辑
-  }
-}</code></pre>
+const userSchema = {
+  id: null, name: '', email: '',
+  createdAt: null, updatedAt: null
+};
+module.exports = { userSchema };</code></pre>
         <h4>middleware/</h4>
         <p>中间件目录，处理请求预处理和后处理。</p>
         <pre><code class="language-javascript">// app/middleware/index.js