@dongdong12138/dh-cli
v0.0.1
Published
BarryDong 的 cli 工具
Readme
DH-CLI
BarryDong 的 CLI 工具,用于快速创建各框架的前端项目。
环境要求
- Node.js: >= 18.0.0
- pnpm: >= 8.0.0
安装
# 如果没有 pnpm,先安装 pnpm
npm install -g pnpm
# 克隆项目
git clone <repository-url>
cd dh-cli
# 安装依赖
pnpm install
# 构建项目(必须先构建)
pnpm run build
# 全局链接
pnpm link --global使用方法
创建项目
dh-cli create <project-name>例如:
dh-cli create my-app运行后会提示你选择框架:
- Vue
- React
- uni-app
选择完成后,工具会显示你的选择并创建项目。
开发
# 开发模式(直接运行 TypeScript)
pnpm run dev
# 类型检查
pnpm run type-check
# 构建(压缩版本)
pnpm run build
# 构建(开发版本,不压缩)
pnpm run build:dev
# 测试
pnpm run start技术栈
- Commander.js: 命令行参数解析
- Inquirer.js: 交互式命令行界面
- TypeScript: 类型安全的 JavaScript
- esbuild: 快速的 TypeScript 编译和代码压缩
- ts-node: TypeScript 开发时运行时支持
- pnpm: 快速、节省磁盘空间的包管理工具
项目结构
dh-cli/
├── bin/
│ └── cli.js # CLI 可执行文件(编译后的 JavaScript)
├── src/
│ └── index.ts # TypeScript 源码
├── package.json
├── tsconfig.json
└── README.md重要说明
bin/cli.js:TypeScript 通过 esbuild 编译并压缩到这个文件,它是最终的可执行文件- 构建必须:每次修改
src/index.ts后都必须运行pnpm run build来重新编译 - 简洁架构:没有额外的
dist目录,源码直接编译到可执行文件 - 代码压缩:使用 esbuild 进行代码压缩,文件大小仅 840 字节
- 性能优化:使用编译后的文件避免了运行时 TypeScript 编译,提高了性能
- 类型安全:使用
pnpm run type-check进行类型检查,确保代码质量
许可证
ISC
