done-coding-component
v0.4.9
Published
组件命令行工具
Readme
@done-coding/cli-component
组件生成命令行工具 - 快速创建和管理项目组件
安装
独立安装
npm install @done-coding/cli-component
# 或
pnpm add @done-coding/cli-component作为 done-coding CLI 的一部分
npm install -g @done-coding/cli
# 然后使用
DC component [command]快速开始
# 独立使用
dc-component [command]
# 作为主 CLI 的子命令
DC component [command]
# 查看帮助
dc-component --help功能特性
- ✅ 组件创建: 使用
add命令创建新组件 - 🗂️ 组件管理: 使用
list命令查看已创建的组件 - 🗑️ 组件删除: 使用
remove命令删除不需要的组件 - 🔧 智能命名: 自动处理组件名称的格式转换
API 文档
基础命令
dc-component add <name>
新增一个组件
# 创建一个名为 Button 的组件
dc-component add Button
# 创建一个名为 UserCard 的组件
dc-component add UserCard参数说明:
name: 组件名称(必需)
dc-component remove [name]
删除一个组件
# 删除指定组件
dc-component remove Button
# 不指定名称时可能提供交互式选择
dc-component remove参数说明:
name: 组件名称(可选)
dc-component list
展示组件列表
# 显示所有已创建的组件
dc-component list使用示例
基础使用场景
# 1. 查看当前组件列表
dc-component list
# 2. 创建新组件
dc-component add MyButton
# 3. 再次查看组件列表确认创建
dc-component list
# 4. 删除不需要的组件
dc-component remove MyButton作为主 CLI 的一部分
# 使用主 CLI 命令
DC component add Button
DC component list
DC component remove Button
# 使用替代命令
dc-cli component add Button
done-coding component list故障排除
常见问题
Q: 组件创建失败
# 检查当前目录
pwd
# 查看详细错误信息
dc-component add MyButtonQ: 组件列表为空
# 确认是否在正确的项目目录
ls -la
# 检查是否已创建过组件
dc-component listQ: 删除组件失败
# 确认组件名称正确
dc-component list
# 检查文件权限
ls -la src/components/贡献指南
我们欢迎贡献!请遵循以下步骤:
- Fork 本仓库
- 创建功能分支:
git checkout -b feature/amazing-feature - 提交更改:
git commit -m "feat: add amazing feature" - 推送分支:
git push origin feature/amazing-feature - 创建 Pull Request
开发环境设置
# 克隆仓库
git clone https://gitee.com/done-coding/done-coding-cli.git
cd done-coding-cli/packages/component
# 安装依赖
pnpm install
# 开发模式
pnpm dev
# 构建
pnpm build
# 本地开发测试
node es/cli.mjs --help
# 注意:本地使用 node + 入口文件,发布后使用 bin 命令名
# 功能完全一致,只是调用方式不同许可证
MIT © JustSoSu
