koa3-cli 1.0.0 → 1.0.2

package/README.md

@@ -1,10 +1,40 @@
 # Koa3 CLI
 
-基于 Koa3 的脚手架项目。
+基于 Koa3 的脚手架项目，提供 CLI 工具快速创建项目。
 
 - 📖 文档地址：https://atwzc.cn/
 - 🔗 Gitee 地址：https://gitee.com/wangziwl/koa3-cli
 
+## 安装 CLI 工具
+
+### 全局安装（推荐）
+
+```bash
+npm install -g koa3-cli
+```
+
+### 使用 npx（无需安装）
+
+```bash
+npx koa3-cli create my-project
+```
+
+## 使用 CLI 创建项目
+
+```bash
+# 创建新项目
+koa3-cli create my-project
+
+# 进入项目目录
+cd my-project
+
+# 安装依赖
+npm install
+
+# 启动开发服务器
+npm run dev
+```
+
 ## 项目结构
 
 ```
@@ -34,7 +64,8 @@ koa2-cli/
 
 ## 特性
 
-- ✅ 基于 Koa2，轻量高效
+- ✅ 基于 Koa3，轻量高效
+- ✅ CLI 工具，一键创建项目
 - ✅ 项目结构，清晰规范
 - ✅ 支持多环境配置（development/production）
 - ✅ MVC 架构（Controller/Service/Model）

package/app/router.js

@@ -1,4 +1,4 @@
-const Router = require('koa-router');
+const { Router } = require('@koa/router');
 const router = new Router();
 
 // 加载控制器

package/app.js

@@ -1,8 +1,8 @@
 const Koa = require('koa');
-const Router = require('koa-router');
+const { Router } = require('@koa/router');
 const bodyParser = require('koa-bodyparser');
 const static = require('koa-static');
-const views = require('koa-views');
+const views = require('@ladjs/koa-views');
 const path = require('path');
 const fs = require('fs');
 

package/bin/README.md

@@ -0,0 +1,96 @@
+# Koa3 CLI 使用说明
+
+## 安装
+
+### 全局安装
+
+```bash
+npm install -g koa3-cli
+```
+
+安装后，可以在任何地方使用 `koa3-cli` 命令。
+
+### 使用 npx（无需安装）
+
+```bash
+npx koa3-cli create my-project
+```
+
+## 命令
+
+### 创建项目
+
+```bash
+koa3-cli create <project-name>
+```
+
+**示例：**
+
+```bash
+koa3-cli create my-app
+```
+
+这会在当前目录下创建一个名为 `my-app` 的新项目。
+
+### 查看帮助
+
+```bash
+koa3-cli --help
+# 或
+koa3-cli help
+```
+
+### 查看版本
+
+```bash
+koa3-cli --version
+# 或
+koa3-cli version
+```
+
+## 创建项目后的步骤
+
+1. 进入项目目录：
+   ```bash
+   cd my-app
+   ```
+
+2. 安装依赖：
+   ```bash
+   npm install
+   ```
+
+3. 启动开发服务器：
+   ```bash
+   npm run dev
+   ```
+
+4. 访问应用：
+   - 首页: http://localhost:3000
+   - API 示例: http://localhost:3000/api/user
+   - 文档: http://localhost:3000/index.html
+
+## 项目结构
+
+创建的项目包含以下结构：
+
+```
+my-app/
+├── app/                    # 应用代码目录
+│   ├── controller/        # 控制器目录
+│   ├── service/           # 服务层目录
+│   ├── model/             # 数据模型目录
+│   ├── middleware/        # 中间件目录
+│   └── router.js          # 路由配置
+├── config/                # 配置文件目录
+├── public/                # 静态资源目录
+├── app.js                 # 应用入口文件
+├── package.json           # 项目配置
+└── README.md             # 项目说明
+```
+
+## 注意事项
+
+- 项目名称不能包含空格和特殊字符
+- 如果目录已存在，CLI 会提示错误
+- 创建的项目会自动配置好所有必要的文件和目录结构

package/bin/cli.js

@@ -0,0 +1,220 @@
+#!/usr/bin/env node
+
+/**
+ * Koa3 CLI 工具
+ * 用于快速创建 Koa3 项目
+ */
+
+const fs = require('fs');
+const path = require('path');
+const { execSync } = require('child_process');
+
+// 获取命令行参数
+const args = process.argv.slice(2);
+const command = args[0];
+const projectName = args[1];
+
+// 显示帮助信息
+function showHelp() {
+  console.log(`
+Koa3 CLI - 快速创建 Koa3 项目脚手架
+
+用法:
+  koa3-cli create <project-name>  创建新项目
+
+示例:
+  koa3-cli create my-app
+
+更多信息: https://gitee.com/wangziwl/koa3-cli
+`);
+}
+
+// 显示版本信息
+function showVersion() {
+  const pkg = require('../package.json');
+  console.log(`koa3-cli v${pkg.version}`);
+}
+
+// 复制目录
+function copyDir(src, dest) {
+  if (!fs.existsSync(dest)) {
+    fs.mkdirSync(dest, { recursive: true });
+  }
+
+  const entries = fs.readdirSync(src, { withFileTypes: true });
+
+  for (const entry of entries) {
+    const srcPath = path.join(src, entry.name);
+    const destPath = path.join(dest, entry.name);
+
+    if (entry.isDirectory()) {
+      copyDir(srcPath, destPath);
+    } else {
+      // 跳过不需要的文件
+      if (shouldSkipFile(entry.name)) {
+        continue;
+      }
+      fs.copyFileSync(srcPath, destPath);
+    }
+  }
+}
+
+// 判断是否跳过文件
+function shouldSkipFile(filename) {
+  const skipFiles = [
+    'node_modules',
+    '.git',
+    '.DS_Store',
+    'package-lock.json',
+    '.env',
+    'logs',
+    'coverage',
+    '.nyc_output',
+    'dist',
+    'build',
+    'tmp',
+    'temp'
+  ];
+  
+  return skipFiles.some(skip => filename.includes(skip));
+}
+
+// 更新 package.json
+function updatePackageJson(projectPath, projectName) {
+  const packageJsonPath = path.join(projectPath, 'package.json');
+  const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'));
+  
+  packageJson.name = projectName;
+  packageJson.version = '1.0.0';
+  packageJson.description = `基于 Koa3 的 ${projectName} 项目`;
+  
+  // 移除 bin 字段（如果存在）
+  delete packageJson.bin;
+  
+  fs.writeFileSync(packageJsonPath, JSON.stringify(packageJson, null, 2) + '\n');
+}
+
+// 创建项目
+function createProject(projectName) {
+  if (!projectName) {
+    console.error('❌ 错误: 请提供项目名称');
+    console.log('\n用法: koa3-cli create <project-name>');
+    process.exit(1);
+  }
+
+  const currentDir = process.cwd();
+  const projectPath = path.join(currentDir, projectName);
+
+  // 检查项目目录是否已存在
+  if (fs.existsSync(projectPath)) {
+    console.error(`❌ 错误: 目录 "${projectName}" 已存在`);
+    process.exit(1);
+  }
+
+  console.log(`🚀 正在创建项目: ${projectName}...\n`);
+
+  try {
+    // 获取模板目录（当前项目的根目录）
+    const templateDir = path.join(__dirname, '..');
+
+    // 创建项目目录
+    fs.mkdirSync(projectPath, { recursive: true });
+
+    // 复制模板文件
+    console.log('📁 复制项目文件...');
+    const filesToCopy = [
+      'app',
+      'config',
+      'public',
+      'app.js',
+      'env.example',
+      'README.md',
+      'LICENSE',
+      '.gitignore',
+      '.npmignore'
+    ];
+
+    for (const file of filesToCopy) {
+      const srcPath = path.join(templateDir, file);
+      const destPath = path.join(projectPath, file);
+
+      if (!fs.existsSync(srcPath)) {
+        continue;
+      }
+
+      const stat = fs.statSync(srcPath);
+      if (stat.isDirectory()) {
+        copyDir(srcPath, destPath);
+      } else {
+        fs.copyFileSync(srcPath, destPath);
+      }
+    }
+
+    // 创建新的 package.json（不包含 bin 字段）
+    console.log('📝 创建 package.json...');
+    const templatePackageJson = require('../package.json');
+    const newPackageJson = {
+      ...templatePackageJson,
+      name: projectName,
+      version: '1.0.0',
+      description: `基于 Koa3 的 ${projectName} 项目`
+    };
+    delete newPackageJson.bin;
+    
+    fs.writeFileSync(
+      path.join(projectPath, 'package.json'),
+      JSON.stringify(newPackageJson, null, 2) + '\n'
+    );
+
+    // 创建 .env 文件
+    console.log('⚙️  创建环境配置文件...');
+    if (fs.existsSync(path.join(templateDir, 'env.example'))) {
+      fs.copyFileSync(
+        path.join(templateDir, 'env.example'),
+        path.join(projectPath, '.env')
+      );
+    }
+
+    console.log('\n✅ 项目创建成功！\n');
+    console.log('下一步:');
+    console.log(`  cd ${projectName}`);
+    console.log('  npm install');
+    console.log('  npm run dev\n');
+    console.log('📖 文档: https://atwzc.cn/');
+    console.log('🔗 Gitee: https://gitee.com/wangziwl/koa3-cli\n');
+
+  } catch (error) {
+    console.error('❌ 创建项目时出错:', error.message);
+    
+    // 清理已创建的目录
+    if (fs.existsSync(projectPath)) {
+      fs.rmSync(projectPath, { recursive: true, force: true });
+    }
+    
+    process.exit(1);
+  }
+}
+
+// 主函数
+function main() {
+  if (!command || command === 'help' || command === '-h' || command === '--help') {
+    showHelp();
+    return;
+  }
+
+  if (command === 'version' || command === '-v' || command === '--version') {
+    showVersion();
+    return;
+  }
+
+  if (command === 'create') {
+    createProject(projectName);
+  } else {
+    console.error(`❌ 未知命令: ${command}`);
+    console.log('\n使用 koa3-cli --help 查看帮助信息');
+    process.exit(1);
+  }
+}
+
+// 运行主函数
+main();

package/package.json

@@ -1,8 +1,12 @@
 {
   "name": "koa3-cli",
-  "version": "1.0.0",
+  "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",
@@ -21,14 +25,14 @@
   "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-router": "^12.0.0",
     "koa-bodyparser": "^4.4.1",
-    "koa-static": "^5.0.0",
-    "koa-views": "^8.0.0",
     "koa-cors": "^0.0.16",
-    "dotenv": "^17.2.3",
-    "ejs": "^3.1.10"
+    "koa-static": "^5.0.0"
   },
   "devDependencies": {
     "nodemon": "^3.1.11"

package/public/index.html

@@ -69,6 +69,10 @@
               <h3>✅ 错误处理</h3>
               <p>统一的错误处理机制</p>
             </div>
+            <div class="feature">
+              <h3>⚡ CLI 工具</h3>
+              <p>一键创建项目，快速上手</p>
+            </div>
           </div>
         </div>
       </div>
@@ -76,7 +80,19 @@
       <!-- 快速开始 -->
       <div id="getting-started" class="content-section">
         <h1>快速开始</h1>
-        <h2>安装依赖</h2>
+        <h2>使用 CLI 工具创建项目（推荐）</h2>
+        <h3>全局安装 CLI</h3>
+        <pre><code class="language-bash">npm install -g koa3-cli</code></pre>
+        <h3>创建新项目</h3>
+        <pre><code class="language-bash">koa3-cli create my-project
+cd my-project
+npm install
+npm run dev</code></pre>
+        <p>或者使用 npx（无需安装）：</p>
+        <pre><code class="language-bash">npx koa3-cli create my-project</code></pre>
+        <h2>手动安装项目</h2>
+        <p>如果你已经有一个项目，可以手动安装依赖：</p>
+        <h3>安装依赖</h3>
         <pre><code class="language-bash">npm install</code></pre>
         <h2>启动项目</h2>
         <h3>开发环境</h3>
@@ -91,6 +107,13 @@
           <li><strong>API 示例</strong>: http://localhost:3000/api/user</li>
           <li><strong>文档</strong>: http://localhost:3000/index.html</li>
         </ul>
+        <h2>CLI 命令</h2>
+        <p>CLI 工具支持以下命令：</p>
+        <ul>
+          <li><code>koa3-cli create &lt;project-name&gt;</code> - 创建新项目</li>
+          <li><code>koa3-cli --help</code> - 查看帮助信息</li>
+          <li><code>koa3-cli --version</code> - 查看版本信息</li>
+        </ul>
         <h2>环境配置</h2>
         <p>项目支持多环境配置，通过 <code>NODE_ENV</code> 环境变量控制：</p>
         <ul>
@@ -114,8 +137,7 @@
 ├── app/                    # 应用代码目录
 │   ├── controller/        # 控制器目录
 │   │   ├── home.js        # 首页控制器
-│   │   ├── user.js        # 用户控制器
-│   │   └── docs.js        # 文档控制器
+│   │   └── user.js        # 用户控制器
 │   ├── service/           # 服务层目录
 │   │   └── user.js        # 用户服务
 │   ├── model/             # 数据模型目录
@@ -126,14 +148,18 @@
 │   ├── router.js          # 路由配置
 │   └── view/              # 视图模板目录（可选）
 │       └── docs.ejs       # 页面模板
+├── bin/                   # CLI 工具目录（仅 CLI 包）
+│   └── cli.js             # CLI 入口文件
 ├── config/                # 配置文件目录
 │   ├── config.default.js  # 默认配置
 │   ├── config.local.js    # 本地开发配置
 │   └── config.prod.js     # 生产环境配置
 ├── public/                # 静态资源目录
-│   └── index.html         # 首页
+│   ├── docs/              # 文档资源
+│   └── index.html         # 文档首页
 ├── app.js                 # 应用入口文件
 ├── package.json           # 项目配置
+├── env.example            # 环境变量示例
 └── README.md             # 项目说明</code></pre>
         <h2>目录说明</h2>
         <h3>app/</h3>