@fastcar/cli 0.0.7 → 0.0.8

package/README.md

@@ -1,41 +1,221 @@
-# fastcar 脚手架工具
+# @fastcar/cli 脚手架工具
 
-## 快速安装
+Fastcar 脚手架工具，用于快速初始化项目模板。
 
-npm install fastcar-cli
+## 特性
 
-## 全局安装
+- 🚀 通过 npm 包管理模板，动态获取最新版本
+- 📦 支持多种项目模板（web、rpc、cos、micro、static）
+- 🎯 交互式模板选择
+- ⚡ 自动合并依赖和配置
+- 🗜️ 项目打包（自动排除 devDependencies、日志文件）
+- 🔄 数据库表逆向生成
 
-npm install -g fastcar-cli
+## 安装
 
-## 常用命令
+### 全局安装（推荐）
 
-fastcar-cli -v //显示版本 fastcar-cli version 1.0.0
+```bash
+npm install -g @fastcar/cli
+```
 
-fastcar-cli -help //显示所有命令
+### 使用 npx（无需安装）
 
-fastcar-cli  init web //初始化web模板
+```bash
+npx @fastcar/cli init
+```
 
-fastcar-cli  init rpc //初始化rpc模板
+## 使用命令
 
-fastcar-cli  clean node_modules //清除多余依赖库(一般使用不到)
+### 查看版本
 
-fastcar-cli  compress node_modules //压缩依赖库(一般使用不到)
+```bash
+fastcar-cli -v
+# 或
+fastcar-cli --version
+```
 
-## web框架快速示例
+### 查看帮助
 
-* 安装环境 全局安装 typescript ts-node (确保ts和调试正常)
+```bash
+fastcar-cli --help
+```
 
-* 创建文件夹 mkdir demo
+### 初始化项目
 
-* 切换至该目录下 cd demo/
+```bash
+# 交互式选择模板
+fastcar-cli init
 
-* 执行初始化流程  fastcar-cli init web
+# 直接指定模板
+fastcar-cli init web
+fastcar-cli init rpc
+fastcar-cli init cos
+fastcar-cli init micro
+fastcar-cli init static
+```
 
-* 安装项目依赖  yarn install 或者 npm install
+### 项目打包
 
-* 项目启动  npm run debug
+将项目打包成 zip 文件，自动排除 `devDependencies`、`node_modules`、`dist`、`logs` 和 `*.log` 文件。
 
-* 访问根目录 <http://localhost:1234/>
+```bash
+# 自动检测包管理器（根据 lock 文件）
+fastcar-cli pack
 
-* 查看api文档 <http://localhost:1234/api.docs>
+# 指定包管理器
+fastcar-cli pack npm
+fastcar-cli pack yarn
+fastcar-cli pack pnpm
+```
+
+打包后的文件位于 `dist/{name}-{version}.zip`，解压后目录名为当前项目文件夹名。
+
+### 数据库逆向生成
+
+根据数据库表结构生成 Model 和 Mapper 文件。
+
+```bash
+# 生成配置文件
+fastcar-cli reverse:init
+
+# 执行逆向生成
+fastcar-cli reverse
+```
+
+配置文件 `reverse.config.json` 示例：
+
+```json
+{
+  "tables": ["test"],
+  "modelDir": "/path/to/models",
+  "mapperDir": "/path/to/mappers",
+  "dbConfig": {
+    "host": "localhost",
+    "port": 3306,
+    "user": "root",
+    "password": "password",
+    "database": "test_db"
+  },
+  "style": {
+    "tabWidth": 4,
+    "printWidth": 200,
+    "trailingComma": "es5",
+    "useTabs": true,
+    "parser": "typescript",
+    "endOfLine": "crlf"
+  },
+  "ignoreCamelcase": false
+}
+```
+
+### 其他命令
+
+```bash
+# 清除多余依赖库
+fastcar-cli clean node_modules
+
+# 压缩依赖库
+fastcar-cli compress node_modules
+```
+
+## 快速开始
+
+### 创建 Web 项目示例
+
+```bash
+# 创建项目目录
+mkdir my-project
+cd my-project
+
+# 初始化项目（交互式选择模板）
+fastcar-cli init
+
+# 或者直接指定 web 模板
+fastcar-cli init web
+
+# 安装依赖
+npm install
+
+# 启动项目
+npm run dev
+```
+
+### 打包项目示例
+
+```bash
+# 进入项目目录
+cd my-project
+
+# 打包项目（自动检测包管理器）
+fastcar-cli pack
+
+# 使用 yarn 打包
+fastcar-cli pack yarn
+
+# 输出: dist/my-project-1.0.0.zip
+```
+
+## 可用模板
+
+| 模板名称 | 包名 | 说明 |
+|---------|------|------|
+| web | @fastcar/template-web | Web 应用模板 |
+| rpc | @fastcar/template-rpc | RPC 服务模板 |
+| cos | @fastcar/template-cos | COS 存储模板 |
+| micro | @fastcar/template-microservices | 微服务模板 |
+| static | @fastcar/template-static | 静态资源模板 |
+
+## 自定义模板
+
+### 创建模板包
+
+1. 初始化 npm 项目
+
+```bash
+mkdir template-mytemplate
+cd template-mytemplate
+npm init
+```
+
+2. 创建 `template/` 目录并放入项目文件
+
+3. 发布到 npm
+
+```bash
+npm publish --access public
+```
+
+详细说明请参考 [template-example/README.md](./template-example/README.md)
+
+### 注册模板
+
+在 `src/templates.json` 中添加模板配置：
+
+```json
+{
+  "mytemplate": {
+    "name": "mytemplate",
+    "description": "我的自定义模板",
+    "package": "@fastcar/template-mytemplate",
+    "tags": ["custom"]
+  }
+}
+```
+
+## 模板包规范
+
+模板包必须遵循以下结构：
+
+```
+template-xxx/
+├── package.json          # 模板包的 package.json
+├── README.md            # 模板说明文档
+└── template/            # 模板文件目录（必需）
+    ├── package.json     # 项目模板中的 package.json
+    └── ...              # 其他项目文件
+```
+
+## 许可证
+
+MIT

package/bin/cli.js

@@ -1,53 +1,138 @@
-#!/usr/bin/env node
+#!/usr/bin/env node
 
 const init = require("../src/init");
 const setModules = require("../src/setModules");
+const { reverseGenerate, initReverseConfig } = require("../src/reverse");
+const { packProject } = require("../src/pack");
 const packageINFO = require("../package.json");
+const templates = require("../src/templates.json");
 
-function run(argv) {
+function showHelp() {
+  console.log(`
+Usage: fastcar-cli [command] [options]
 
-    //命令入口
-    if (!argv || argv.length == 0 || argv[0] === '-v' || argv[0] === '--version') {
-        console.log(`fastcar-cli version ${packageINFO.version}`);
-        return;
-    }
+Commands:
+  init [template] [name]   初始化项目
+                           template: 模板名称 (${Object.keys(templates).join(", ")})
+                           name: 项目名称（可选，默认使用当前目录名）
+
+  clean node_modules       删除冗余的 node_modules 目录
+  compress node_modules    压缩 node_modules 目录
+  reverse                  数据库表逆向生成
+  reverse:init             生成 reverse.config.json 配置文件
+  pack [pm]                打包项目（排除 devDependencies）
+                           pm: 包管理器 (npm/yarn/pnpm)，可选，默认自动检测
+
+Options:
+  -v, --version           显示版本号
+  -h, --help              显示帮助信息
 
-    let head = argv[0];
-    let body = argv.slice(1);
+Examples:
+  $ fastcar-cli init                  # 交互式选择模板
+  $ fastcar-cli init web              # 使用 web 模板
+  $ fastcar-cli init rpc              # 使用 rpc 模板
+  $ fastcar-cli init micro            # 使用 microservices 模板
+  $ fastcar-cli init cos              # 使用 cos 模板
+  $ fastcar-cli init static           # 使用 static 模板
+  $ fastcar-cli init my-project       # 创建 my-project 目录
+  $ fastcar-cli init web my-project   # 使用 web 模板创建 my-project
+  $ fastcar-cli clean node_modules
+  $ fastcar-cli reverse        # 数据库表逆向生成
+  $ fastcar-cli reverse:init   # 生成默认配置文件
+  $ fastcar-cli pack           # 打包项目（自动检测包管理器）
+  $ fastcar-cli pack yarn      # 使用 yarn 安装依赖
+  $ fastcar-cli pack pnpm      # 使用 pnpm 安装依赖
 
-    switch (head) {
+Reverse 命令参数说明:
+  通过配置文件传入参数，在项目根目录创建 reverse.config.json：
 
-        case "init": {
-            init(body);
-            break;
-        }
-        case "clean":
-        case "compress": {
+  {
+    "tables": ["test"],               // 要逆向生成的表名数组（必填）
+    "modelDir": "/path/to/models",    // Model 文件输出目录绝对路径（必填）
+    "mapperDir": "/path/to/mappers",  // Mapper 文件输出目录绝对路径（必填）
+    "dbConfig": {                     // MySQL 数据库配置（必填）
+      "host": "localhost",
+      "port": 3306,
+      "user": "root",
+      "password": "password",
+      "database": "test_db"
+    },
+    "style": {                        // Prettier 格式化配置（可选）
+      "tabWidth": 4,
+      "printWidth": 200,
+      "trailingComma": "es5",
+      "useTabs": true,
+      "parser": "typescript",
+      "endOfLine": "crlf"
+    },
+    "ignoreCamelcase": false          // 是否忽略驼峰命名转换（可选，默认 false）
+  }
 
-            if (!body[0]) {
+  也可以使用 reverse:init 命令生成默认配置文件:
+  $ fastcar-cli reverse:init
+`);
+}
 
-                body[0] = "node_modules";
-            }
+function showVersion() {
+  console.log(`fastcar-cli version ${packageINFO.version}`);
+}
 
-            if (body[0] == "node_modules") {
+function run(argv) {
+  // 命令入口
+  if (!argv || argv.length === 0) {
+    showHelp();
+    return;
+  }
 
-                setModules(body[0], head == "compress");
-            } else {
+  const head = argv[0];
+  const body = argv.slice(1);
 
-                console.log("Missing file path");
-            }
-            break;
-        }
-        default: {
-            //命令提示
-            console.log('  usage:\n');
-            console.log('  -v --version [show version]\n');
-            console.log('  init web [init web template]\n');
-            console.log('  init rpc [init rpc template]\n');
-            console.log('  clean node_modules [Delete redundant modules]\n');
-            console.log('  compress node_modules [compress modules]\n');
-        }
+  switch (head) {
+    case "-v":
+    case "--version": {
+      showVersion();
+      break;
+    }
+    case "-h":
+    case "--help": {
+      showHelp();
+      break;
+    }
+    case "init": {
+      init(body);
+      break;
+    }
+    case "clean":
+    case "compress": {
+      if (!body[0]) {
+        body[0] = "node_modules";
+      }
+
+      if (body[0] === "node_modules") {
+        setModules(body[0], head === "compress");
+      } else {
+        console.log("❌ 缺少文件路径");
+      }
+      break;
+    }
+    case "reverse": {
+      reverseGenerate(body);
+      break;
+    }
+    case "reverse:init": {
+      initReverseConfig();
+      break;
+    }
+    case "pack": {
+      const pm = body[0]; // 可选的包管理器参数
+      packProject(null, null, pm);
+      break;
+    }
+    default: {
+      console.log(`❌ 未知命令: ${head}\n`);
+      showHelp();
     }
+  }
 }
 
-run(process.argv.slice(2));
+run(process.argv.slice(2));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fastcar/cli",
-  "version": "0.0.7",
+  "version": "0.0.8",
   "homepage": "https://william_zhong.coding.net/public/fast-car/fastcar-cli/git/files",
   "description": "fastcar-cli 脚手架快速搭建",
   "bin": {
@@ -8,8 +8,7 @@
   },
   "files": [
     "bin",
-    "src",
-    "node_modules"
+    "src"
   ],
   "keywords": [
     "node",
@@ -28,6 +27,6 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://e.coding.net/william_zhong/fast-car/fastcar-cli.git"
+    "url": "https://github.com/williamDazhangyu/fastcar-cli.git"
   }
 }