# xmov-cli

**Repository Path**: mrwang8034/xmov-cli

## Basic Information

- **Project Name**: xmov-cli
- **Description**: 脚手架
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-06-13
- **Last Updated**: 2024-06-13

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 🔮 xmov-cli 魔珐前端 CLI 工具
## 简介
### 特性

- ✅ 内置默认模板，快速便捷地初始化项目
- ✅ 解耦模板管理，支持自定义模板
- ✅ es6 + ts、友好的交互支持
- ✅ 集成 x-utils 等内置工具库
- ✅ 自定义项目配置，实现插件化扩展

### 施工中

- 🚧 规范项目代码和提交格式(80%)
### TODO

- ⚗ 针对不同平台的项目提供不同的推荐插件

## 安装

1. `npm i @xmov/cli -g`
2. `xmov`

## 使用

**打开终端，输入 `xmov`**

> ### Options:
> - `-v, --version` 查看当前版本
> - `-h, --help `   显示命令帮助
>
> ### Commands:
> - `init|i [options] <project_name>`     使用模板初始化项目
> - `list|ls`                             查看当前所有模板
> - `add-tmpl`                            添加自定义模板
> - `rm-tmpl [options] <template_name>`   删除自定义模板：模板名
> - `create|c [options] <project_name>`   创建一个基于 vite + vue3 + ts 的项目
>

### 关于模板
- xmov 计划默认提供的两套初始模板
    - **[vue-default](https://git.xmov.ai/frontend/template-vue-default)**
    - **vue-Electron** (todo)
- 通过 `xmov ls` 命令可以查看当前所有模板
- 通过 `add-tmpl` 命令可以添加自定义模板
    - 添加自定义模板需要在 Gitlab 的 [frontend](https://git.xmov.ai/frontend) 组内创建对应模板仓库
    - **添加自定义模板时，模板名称与仓库地址为必填项，其他仓库地址的格式为 `frontend/xxx.git`** （xxx 为你的仓库名称）
- 通过 `rm-tmpl <template_name>` 命令可以删除自定义模板，默认模板不能删除
- 自定义模板在重装脚手架工具后需要重新配置，如果觉得可复用性很高，可以联系我们将其内置为默认模板，同时后期需要维护该模板
### 关于私有依赖包
- 创建与初始化项目时，可以选择是否需要安装私有 npm 包
- **发布新的 npm 包之后，想在 xmov cli 使用时可以选择安装，需要修改包的 package.json 文件里的 `repository`字段，在其对象中加入`"utils": true`**

```json
"repository": {
    "type": "git",
    "url": "", // gitlab 仓库地址
    "utils": true 
}
```