# create-quick
**Repository Path**: xuanxiaoqian/create-quick
## Basic Information
- **Project Name**: create-quick
- **Description**: 约定代替编码的脚手架搭建工具
- **Primary Language**: NodeJS
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 12
- **Forks**: 5
- **Created**: 2023-01-23
- **Last Updated**: 2025-04-22
## Categories & Tags
**Categories**: Uncategorized
**Tags**: Cli, 脚手架, 工具
## README
create-quick
约定代替编码，更灵活、迅速的脚手架搭建工具
项目历程
---
## 介绍
create-quick对脚手架核心业务进行封装，使用者只需关心脚手架的内容，约定代替编码的方式更灵活、迅速的创建脚手架
## 演示
```sh
npm create quick
# or
npm init quick
# or
npx create-quick
```
## 案例
提供一个自用的脚手架，基于`create-quick`开发，你们可以参照这个来理解更详细的参数。
create-xuanxiaoqian
## 使用
如果我们只需要使用这个仓库快速创建脚手架，我们只需要关心`templates`文件夹。
仓库会自动扫描`templates`文件夹下的内容去提供使用者选择，所以我们就不需要手动写询问代码
`template`文件夹第一层是大项目名称，例如Vue3、React18这种命名。进入其中一个大项目文件夹，里面还有三个文件夹。
`base`文件夹：里面的内容就是一个项目的基本构架，里面所有内容都是直接复制到初始化路径
`ejs`文件夹：里面的内容是用于更精细化的配置可选配置
`options`文件夹：就是用于给用户选择第三方库的权利，例如Axios、Pinia等等
## 约定
`templates`文件夹就是我们脚手架模板存放的地方，里面使用约定代替配置的方式，有着以下约定
- templates文件夹里面的第一层为模板名，例如：templates/vue3、templates/nest
- 模板名里面有着三个文件夹，分别是`base`、`options`、`ejs`（可通过配置变量自定义命名）
- options文件夹里面的各种选项里面的文件目录需要跟base目录一一对应
- options里面的`package.json`会和base的`package.json`进行合并，其他文件全是替换
- options里面的`ejsData.js`为参数变量，用于给ejs模板引擎渲染的，同时里面可以定义一个回调函数，到该options执行完成之后会调用回调函数，可以接收两个值，一个是新项目路径，一个是config参数。该文件也不会添加到base里（可通过配置变量自定义命名）
- ejs文件夹为模板引擎，里面的文件目录也是和base目录一一对应，例如：`main.ts.ejs`文件名最终合并到base里面的名字为`main.ts`，也会覆盖base
核心函数`createTemplate`接收三个参数：
```ts
const config: configType = { // 渲染参数
projectName: 'default-project',
template: 'vue3',
ejsVarAilas: 'config-text.js',
options: ['pinia', 'prettier', 'vue-router']
}
const templatesRoot = path.resolve(__dirname, './templates') // 模板文件夹path
createTemplate(config, templatesRoot, ({ newProjectPath }) => {
// 渲染完成的回调函数
console.log(`创建完成,新项目路径为${newProjectPath}`)
})
```
仓库里面的入口文件`index.ts`询问方式可以自定义，你只需要将数据给到createTemplate渲染函数即可
## 渲染流程
~~~text
1. 数据传递createTemplate函数
2. createTemplate函数内部设置参数默认值
3. 复制Base文件夹进入目标路径
4. 递归Options文件夹下面的所有ejsData.js文件并获得它们的Key，因为ejs模板存在不存在的Key会报错（考虑换一个）
5. 根据数据里的options渲染指定的插件，并且加载插件目录下的ejsData.js数据
6. 渲染Ejs文件夹
7. 调用收尾函数 （重置package.json文件）
8. 调用用户的回调函数
~~~
renderTemplate下面有三个文件夹 `base`、`ejs`、`options`
第一步：直接递归复制`base`
第二步：递归options里面所有的`ejsData.js`数据，但是并不赋值，将Key记录，因为ejs不能渲染不存在的Key
第三步：传递过来的options数据选择需要的进行`options`文件夹进行复制，并且读取里面的`ejsData.js`数据
第四步：根据`ejsData.js`数据进行渲染ejs文件夹所有文件
第五步：调用内部收尾函数
第六步：调用渲染函数的回调函数
TODO：修改渲染代码，`ejsData.js`里的回调函数数据不全、文档未完善
TODO2: 2023/6/4 options只有一个可选项的时候会跳过选择、给可选文件夹加关键字然后就可以自动选中、项目中断创建还是会导致创建
## 快速上手
前往最小化demo仓库 create-mini-quick
## 疑问交流
QQ群: qian-cli(746382337)