xmo-cli v0.5.1

xmo-cli

旨在做最好的Vue3入门工具，且只关注 Vue3 + Vite 。

什么时候你能用得上 xmo-cli？

• 最近在学习 Vue3 且需要一（系列）开源项目帮助你真正入门。
• 想为 Vue3 项目添加质量管理配置，你可能听说过类似的概念，但缺少经验，因此无从下手。
• 想为 Vue3 项目添加 Docker 容器配置，你可能听说过类似的概念，但缺少经验，因此无从下手。
• 期待使用一个中文的 Vue3-cli 工具。
• 乐于为开源项目提供建议和 Debug ，并成为 Contributors （贡献者）的一员。

xmo-cli 可以为你的 Vue3 项目提供帮助。

介绍

Cli创建项目，支持创建最新版 Vue3 的模板项目。本项目旨在提供最易上手的搭配项目质量管理的 Vue3 入门最佳实践。

项目模板具备足量必用插件的简单示例，共有分4个分支（两个JavaScript、两个typescript），循序渐进，且都很简单易懂，还可以作为拉取热门的 Vue3 开源模板的工具。

本项目用到的插件如果你在开发中从来没有用过，那么说明你该用用了。

同时还支持为 Vue3 项目提供质量管理初始化和Docker容器初始化，一键添加相关配置，开箱即用。

由于默认使用yarn作为项目包管理工具，所以请事先安装yarn以保证功能齐全。

npm install -g yarn

安装教程

1. npm install xmo-cli -g

使用说明

📦 初始化项目

初始化Xmo-cli项目，项目细节请查看 https://github.com/darkXmo/xmo-cli 的除了 master 以外的各个分支。

1. xmo-cli init [dir]

   

2. 按照指引输入对应内容进行操作

⚓ 安装开源项目

xmo-cli 收录了 https://github.com/vitejs/awesome-vite#templates 中比较热门的 Vue3 项目，且提供了镜像下载的方案，防止遇到境内 github 下载困难。

1. xmo-cli create <dir>

⚙️ 添加项目配置

xmo-cli 提供为Vue3项目一键添加质量管理配置（需要初始化git）和Docker配置的功能。

1. 一键添加质量管理工具配置（包括 prettier + husky + lint-staged，可选项 commitlint 、eslint）

   # 在项目根目录
   xmo-cli init -q
   
   # 如果项目中已经有了质量管理配置，为了防止冲突，你可能需要先删除它们。
   xmo-cli init -qf

   Typescript 项目不提供 Eslint 质量管理配置方案。

   

   使用 commitizen 进行 git 提交，可以使提交message规范化。

2. 一键添加Docker配置（使用Nginx部署配置，暴露80端口，默认使用主机4000端口，详情查看生成的 .docker 文件夹）。

   # 在项目根目录
   xmo-cli init -d
   
   yarn docker:deploy

   

Help

默认情况下，所有新建项目都包含最新版 vue3、 prettier 及其默认配置、vue-router、pinia、axios。为保障最佳开发体验，推荐使用 Visual Studio Code 作为 IDE 进行开发。

所有项目拉取之后推荐第一时间阅读 README.md 和 CHANGELOG.md (如果有) 。

自动化构建通过读取并 clone 不同 git 分支下的内容后进行修改来实现项目初始化，当前支持从 gitee 和 github 上下载项目，请根据你的地理位置记性选择。

所有项目都推荐采用 yarn 作为依赖管理工具。

分支

🚀 默认推荐分支为 ts/primary 。(如果你使用xmo-cli init [dir] -y（添加-y参数）的话，将默认初始化该分支模板)

mini

vue3 + vue-router + pinia + axios。

难度系数 ★

知识面覆盖系数 ★★★

理解了这些代码，在不涉及特定UI框架的情况下，我认为可以覆盖90%的开发需求。

primary

vue3 + vue-router + pinia + axios + mitt + husky + eslint + commitlint + commitizen 。

难度系数 ★☆

知识面覆盖系数 ★★★★

理解了这些代码，在不涉及特定UI框架的情况下，我认为可以覆盖99%的开发需求和质量管理配置需求。

Typescript分支

将所有原项目改造成 typescript 版本。例如 mini => ts-mini。

初始化项目模板示例

Mini

1. setup 使用示例
2. 页面自适应示例
3. 侧边栏自适应示例
4. vue-router 使用示例
5. pinia 使用示例
6. axios 使用示例
7. prettier 配置示例
8. style 的 v-bind 示例

Primary

1. Mitt 示例
2. eslint + commitlint + commitizen + husky + prettier 项目质量管理示例
3. 导航栏跳转示例

Typescript

1. Vue3 配置 typescript 示例
2. api + interface 接口使用示例

其它

✨ 如果需要添加其它项目分支，或认为某个开源项目最佳实践值得添加到 cli 中，或希望 xmo-cli 添加任何新的功能，都可以提交 issue 清单告知我。

✨ 如果你对初始化模板中的某个功能实现存在疑问，认为需要添加注释或进行修改、优化，请告知我或自行添加然后提请Request。

感谢

感谢你的安装和使用。

如果你觉得好用或值得支持，请将它推荐给你身边的人，谢谢。

参与贡献

1. Fork 本仓库
2. 新建 Feat_xxx 分支
3. 提交代码
4. 新建 Pull Request
5. 欢迎添加其它项目分支