lchao-cli
v1.0.58
Published
chao的脚手架
Readme
欢迎使用 Chao 的脚手架
Chao 脚手架是一个用于快速生成项目、管理依赖、绑定 Git 仓库和生成 API 请求文件的工具集。支持多种常用的开发操作,提高开发效率。
指令列表
1. 生成新项目
指令:
lchao create描述: 从线上仓库生成项目到当前目录(不包含 .git)。
执行此命令后,脚手架会从指定的线上仓库生成新项目,并自动设置目录结构。
2. 清理项目缓存
指令:
lchao clear描述: 删除当前目录下的 node_modules 文件夹和 package-lock.json 文件。
使用示例:执行此命令后,会清理掉当前项目中的依赖缓存,为重新安装依赖提供干净的环境。
3. 切换 npm 镜像源
指令:
lchao set-npm描述: 交互式切换 npm 镜像源。
执行此命令后,你将被引导选择要使用的 npm 镜像源,例如 淘宝镜像 或 官方源。
4. 绑定 Git 远程仓库
指令:
lchao bind-git描述: 绑定线上仓库地址到当前项目,并处理文件冲突。
执行此命令后,你可以选择绑定远程 Git 仓库地址,方便后续的代码推送。
5. 生成 API 请求结构和 TS 接口
指令:
lchao create-api描述: 生成 API 请求结构和 TypeScript 接口文件。
执行此命令后,会根据项目需求生成一个基础的 API 请求文件和相应的 TypeScript 接口,便于开发时的类型检查和代码提示。
6. 显示支持的指令列表
指令:
lchao ls描述: 显示当前支持的指令列表。
执行此命令后,会输出当前支持的所有指令,帮助用户了解可用的操作。
输出示例:
指令列表:
lchao create - 从线上仓库生成项目到当前目录(不包含 .git)
lchao clear - 删除当前目录下的 node_modules 和 package-lock.json
lchao set-npm - 交互式切换 npm 镜像源
lchao bind-git - 绑定线上仓库地址到当前项目
lchao create-api - 生成 API 请求结构和 TS 接口
lchao ls - 显示当前支持的指令列表使用指南
安装
确保你已经安装了Node.js和npm,然后在项目中运行以下命令来安装该脚手架工具:npm install -g chao-cli初始化新项目
使用lchao create命令生成新项目。清理缓存
使用lchao clear清理项目中的node_modules和package-lock.json。切换镜像源
使用lchao set-npm命令交互式选择需要使用的 npm 镜像源。绑定 Git 仓库
使用lchao bind-git将 Git 仓库与项目绑定。生成 API 请求文件
使用lchao create-api生成 API 请求结构和接口文件。
开发者文档
更新日志
2025年4月
- 2025/4/25: 优化 GET 参数传递。
- 2025/4/20: 修改生成后台接口代码。
- 2025/4/17: 修改生成后台接口代码(多次优化)。
- 2025/4/16: 修改生成后台接口代码(优化性能和字段映射)。
- 2025/4/15: 优化接口生成逻辑。
- 2025/3/25: 增加 Vue3 生成接口代码。
- 2025/3/24: 配置自动生成接口代码。
- 2025/3/21: 配置自动生成接口代码(多次调整)。
- 2025/3/05: 更新 MD 文档。
- 2025/2/27: 增加项目快速搭建功能和绑定 Git 仓库功能。
- 2025/2/27: 发布 Chao 脚手架初始版本。
- 2025/5/12: 修改git请求ts报错
