脚手架的本质就是在终端输入命令,然后去github中拉去对应的模板到本地的过程。所以我们要开发一个脚手架的话,其实就是创建一个项目,然后将这个项目发布到npm的库中。在使用的时候,就是使用npm安装对应的库,然后键入对应的指令让库帮我们拉去设置好的模板到本地。
第一步,创建一个项目模板
一个项目重要有路口文件的和对应的依赖配置文件的。
所以我们在对面的文件夹下面创建index.js
。
在对应的文件夹下使用npm init
生成对应的配置package.json文件。
第二步,电脑能识别我们的指令
在使用vue-cli脚手架创建对应的项目的时候,我们使用的命令是vue create
,而我们电脑是如何知道这个命令对应的意思就是给我们创建一个vue开发模板的呢?这就是我们脚手架要定义的了。
首先在我们的项目的入口文件使用shebang来找到对应的解释器来解释我们的代码,这里我们使用node环境,所以在index.js
的第一行,就是要输入以下代码。
#!usr/bin/env node
console.log('zzlw cli');
接着在package.json
的文件中的bin
属性内部,创建对应的指令和要执行的文件。
{
"name": "create-mycli",
"version": "1.0.0",
"description": "",
"main": "index.js",
"bin": {
"zlw": "index.js"
},
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"author": "",
"license": "ISC"
}
最后使用npm link
将对应的指令管理在一起。
现在我们在命令行中输入,zlw
命令,就会输出zzlw cli
了。其本质就是在输入zlw
的时候,去找到对应的文件index.js
因为在index.js
的第一行使用shebang
声明了会使用node
执行以下的代码,所以输出了zzlw cli
。所以现在zlw
命令 就是类似于node index.js
。
ok,现在我们已经设置了一个指令,这个指令可以做对应的事情了,虽然我们还有原理不明白的地方,例如#!
, npm link
的细节。but,anyway ,先这样呗。
第三步,丰富我们的指令的选项
目前,我们绑定了我们的主指令zlw
,但是如果我们需要带入其它的附属参数【例如 -V 查看版本】的话,则还需要借助其它的工具来完成。这里使用到的工具是commander
,这个工具在vue-cli也被使用。
在这个库中,给我们分装了一个方法,通过对应的方法,我们可以自定义对应指令的返回值,和拿到指令传入的参数等。在这里,我们已参看版本的指令,help指令为例。看看这个库是怎么使用的。
https://github.com/tj/commander.js/blob/master/Readme_zh-CN.md commander 的仓库以及对应的教程
首先我们在index.js
文件下,导入对应的库,和编写对应的指令。
//主要就是使用program.option 来定义命令后面的选项 -D 这些
#!/usr/bin/env node
const { program } = require('commander')
//--version 定义显示模块的版本号。拿到json中的版本号
program.version(require('./package.json').version);
// Commander 使用.option()方法来定义选项,
// 同时可以附加选项的简介。
// 每个选项可以定义一个短选项名称
// (-后面接单个字符)和一个长选项名称(--后面接一个或多个单词),
// 使用逗号、空格或 | 分隔。
// option 的简单使用
program.option("-z", 'this is a description about this cli, iam a cli ')
// 如果使用了这个指令会传入参数,这个参数被存在program.opts()下面
program.option("-d --dest <type>", 'a destination folder ,for example :-d /src/components')
// 自定义事件监听.
program.on("--help", () => {
console.log();
console.log("Other: ");
console.log(" design by myself!");
})
// 解析字符串数组,默认是process.argv;一般放在最后
program.parse(process.argv);
const options = program.opts()
if (options.dest) {
console.log('input dest = ', options.dest);
}
为了简化index.js 下面的代码,我们将一些指令定义的代码放到其它的文件夹中,比如lib/core/help.js 中。以后要添加选项的代码都可以在这里面添加。
const path = require('path')
const { program } = require('commander')
function defineOption() {
//--version 定义显示模块的版本号。拿到json中的版本号
const packageJsonFilePath = path.resolve(path.resolve(), './package.json');
program.version(require(packageJsonFilePath).version);
// Commander 使用.option()方法来定义选项,
// 同时可以附加选项的简介。
// 每个选项可以定义一个短选项名称
// (-后面接单个字符)和一个长选项名称(--后面接一个或多个单词),
// 使用逗号、空格或 | 分隔。
// option 的简单使用
program.option("-z", 'this is a description about this cli, iam a cli ')
// 如果使用了这个指令会传入参数,这个参数被存在program.opts()下面
program.option("-d --dest <type>", 'a destination folder ,for example :-d /src/components')
// 自定义事件监听.
program.on("--help", () => {
console.log();
console.log("Other: ");
console.log(" design by myself!");
})
// 解析字符串数组,默认是process.argv;一般放在最后
program.parse(process.argv);
const options = program.opts()
if (options.dest) {
console.log('input dest = ', options.dest);
}
}
module.exports = { defineOption }
#!/usr/bin/env node
const { program } = require('commander')
const { defineOption } = require('./lib/core/help')
defineOption()
第四步,创建clone模板的命令
在文章的最开始就说了,其实vue-cli给我们创建的模板就是定义了vue create
命令,然后在使用该命令去对应的地址把模板clone下来。所以现在我们就定义一个命令来帮我们clone对应的代码。
同样的操作方法和定义选项配置是类似的,在commander中都给我们封装好了对应的api,我们可以直接使用。
通过.command()或.addCommand()可以配置命令,有两种实现方式:为命令绑定处理函数,或者将命令单独写成一个可执行文件(详述见后文)。子命令支持嵌套(示例代码)。
.command()的第一个参数为命令名称。命令参数可以跟在名称后面,也可以用.argument()单独指定。参数可为必选的(尖括号表示)、可选的(方括号表示)或变长参数(点号表示,如果使用,只能是最后一个参数)。
program
.command('这里命令的名称')
.description('这里是命令的描述')
.action(()=>{'这里是该指令具体的执行,所有操作都写在这个函数中'})
ok 上面就是创建一个命令的基本方式,下面我们就简单写一下怎么创建命令把。
首先,我们将所有创建的命令的代码写在lib/core/createCommands
下面,
而每个命令具体的做的事情(action)则都封装在lib/core/actions
下面。
const program = require('commander')
const { cloneTemplateAction } = require('./actions')
// 使用program.command()方法来创建指定的命令。例如:vue create 就是指令而 -D这就叫它选项
const cloneTemplateCommand = () => {
program
.command("create <project> [others]")
.description('clone a template from repository into a folder')
.action(cloneTemplateAction)
}
module.exports = {
cloneTemplateCommand
}
const cloneTemplateAction = (project, others) => {
//到时候就在这里就行template的clone
console.log('cloneTemplateAction');
console.log(project);
console.log(others);
}
module.exports = {
cloneTemplateAction
}
可以看到现在我们这个create 命令生效了。而且命令的第一个默认是zlw 开始的。
第五步,clone对应的模板
在前一步,我们已经创建了对应的命令zlw create
命令, 现在我们就要使用这个命令来进行了下载模板。就像vue-cli帮我们做的一样,下载一个对应的模板到本地,然后安装对应的依赖,将对应的模板跑起来,然后打开浏览器。所以在具体的action的我们要的事情就是以下四步
- clone 项目模板
- 执行npm install 安装模板对应的依赖
- npm run serve 让模板跑在服务上
- 打开浏览器,显示主页面
这里我们先讲第一步,clone github上面的模板(这个模板也是我们传上去的),要做这件使用使用的是一个库download-git-repo
可以帮助我们去对应的地址,将对应的内容clone下来。
const download = require('download-git-repo') //导入的是一个函数
//我们要使用这个函数直接对url链接进行下载其对应的凡是如下:
download('direct:对应的url', '安装到该文件下的目录', function (err) {
console.log('下载完成之后的回调)
console.log(err ? 'Error' : 'Success')
})
/*可以看到download会自动将对应的url资源下载下来,下载完成之后,就会执行回调内的内容。
因为该方法比较老旧了,所以不支持promise 所以这里我们可以使用node 内置的库util中的promisify
方法将download转化成promise的形式。方式如下*/
const { promisify } = require('util') //promisify可以将东西包裹成promise
const download = promisify(require('download-git-repo'))
//这样download返回的就是一个promise了,我们在对应的then中写对应的处理即可。
const { promisify } = require('util') //promisify可以将东西包裹成promise
// download-git-repo 导出的是一个函数,使用promisify包裹成promise,这样相较于回调更好使用
// download的具体用法看官网教程
const download = promisify(require('download-git-repo'))
const { vueRepo } = require('../config/repo-config') //对应模板的github地址
//这里我们使用async 和 await
const cloneTemplateAction = async (project, others) => {
// 1.clone项目
// vueRepo是要clone的网址,project是clone到的位置,
await download(vueRepo, project, { clone: true })
// 2.执行npm install
// 3.npm run serve
// 4.打开浏览器
}
module.exports = {
cloneTemplateAction
}
第六步,安装依赖,开启服务,开启浏览器
在前面已经把对应的模板下载下来了,所以接下去,我们就是要执行npm install
来帮我们将模板中的依赖进行安装,npm run serve
让项目跑起来。而执行这些命令都是在终端中执行的,所以现在问题就是,我们如何在代码中执行这些命令呢? 其实使用的是node 的child_process 来开启对对应的子进程,在开启这些子进程的时候,我们就是使用命令开启的,我们在开启子进程的时候输入对应的命令即可。
所以现在我们要做的事情就是使用这么模块进行开启对应的子进程,依据我们封装的思想,我们在utils文件下创建一个对应的文件,来写开启子进程的代码。 lib/utils/terminal.js
先来看下,在child_process
中开启子进程的spawn
方法.
child_process.spawn(command[, args][, options])
//使用给定的 command 和 args 中的命令行参数衍生新进程。 如果省略,args 默认为空数组。
command <string> 要运行的命令。
args <string[]> 字符串参数列表。
options <Object>
cwd <string> | <URL> 子进程的当前工作目录。
。。。还有很多,具体看node教程
所以我们在lib/utils/terminal.js
下声明对应的开启子进程的代码
/*
执行终端命令的方
*/
const { spawn } = require('child_process')
const { resolve } = require('path')
const commandSpawn = (...args) => {
return new Promise((resolve, reject) => {
// 直接开启子进程
/*
spawn(command[, args][, options])
command:要运行的命令,我们这里是npm
[,args] 是我们要执行命令的字符串参数列表,我们这里应该是["install"] / ["run", "server"]
*/
//也就是说我们传入参数的时候要按照spawn对应参数传入
const childProcess = spawn(...args);
// 现在我们在子进程中,我们用下面的方法,将子进程的输出传到主线程下
childProcess.stdout.pipe(process.stdout)
childProcess.stderr.pipe(process.stderr)
childProcess.on('close', () => {
//进程结束的时候promise fufilled ,此时await等到,可以继续往下执行
resolve()
})
})
}
module.exports = {
commandSpawn
}
在actions中,执行对应的四步曲的后三步。
const { promisify } = require('util') //promisify可以将东西包裹成promise
const download = promisify(require('download-git-repo'))
const open = require('open')
const { vueRepo } = require('../config/repo-config')
const { commandSpawn } = require('../utils/terminal')
const cloneTemplateAction = async (project, others) => {
// 1.clone项目
await download(vueRepo, project, { clone: true })
// 2.执行npm install
const command = process.platform === "win32" ? "npm.cmd" : "npm"
console.log("zlw starts to install demo dependencies ");
await commandSpawn(command, ["install"], { cwd: `./${project}` });
console.log('installed');
// 3.npm run serve
await commandSpawn(command, ["run", "serve"], { cwd: `./${project}` });
// 4.打开浏览器
open('localhost:8080/')
}
module.exports = {
cloneTemplateAction
}
因为在window下面,其实执行npm等指令的其本质是npm.cwd,所以我们 上面先判断了下平台,在决定是npm.cwd还是npm open是一个帮助开启浏览器的库,其实这里我是打不开浏览器的,因为第三步开启服务后,这个进程没有结束,所以await永远不会等到resolve,所以不会接着往下执行。
第七步,添加组件的命令
🆗 ,目前为止已经可以通过命令将对应的模板clone到本地了,也就是说我们这个脚手架的大致功能已经完成了。接下来为了丰富脚手架的功能,准备给脚手架添加vue组件的命令,添加page的命令,添加store的命令等。
其实添加的操作都是类似的,这里详细说下怎么添加vue组件。
我们的目的是通过命令来帮我们加载自动的生成组件,其实它的本质也是加载对应的模板。当使用者输入对应名字的时候,我们只是将这个模板中的一些关键字改为使用者传入的对应组件的名字。
这里我们使用的ejs
来编写vue组件的模板,可以看到大致的样式如下,只是我们使用ejs的时候,可以再编译的时候传入特定的一些参数,然后在模板中使用<% = %>
,语法来拿到
<template>
<div class="<%= data.lowerName%>">
{{ msg }}
</div>
</template>
<script>
export default {
name: "<% = data.name %>",
props: {},
components: {},
mixins: [],
data() {
return {
msg: "<%= data.name %>",
};
},
created() {},
mounted() {},
computed: {},
methods: {},
};
</script>
<style scoped>
.<%= data.lowerName % > {
}
</style>
组件模板写好之后, 我们就可以通过ejs
库来对模板进行编译。编译之后,在输出到对应的目录下,我们这里都将这些方法封装在utils.js
文件夹下。
const fs = require('fs');
const path = require('path');
const ejs = require('ejs');
/**
* 依据传入的模板名,拿到对应的模板,然后编译成html string
* @param {string} templateName
* @param {object} data
* @returns html string
*/
const compileTemplate = (templateName, data) => {
return new Promise((resolve, reject) => {
// 1.依据传入的文件名,拿到对应的模板路径
const templatePath = path.resolve(__dirname, `../templates/${templateName}`);
//2.使用对应的api将ejs转化为html 的string ; str => Rendered HTML string
ejs.renderFile(templatePath, { data }, {}, (err, str) => {
if (err) {
reject(err)
}
resolve(str)
})
})
}
const writeToFile = (content, fileDestPath) => {
return fs.promises.writeFile(fileDestPath, content)
}
module.exports = {
compileTemplate,
writeToFile,
}
🆗 ,现在将这些方法都写好之后,就是在对应的action中进行调用了。对应的actions.js
文件中,对应的action如下。
/**
*
* @param {string} templateName 生成的模板的名称
* @param {string} dest 生成的模板的位置
*/
const addComponentAction = async (templateName, dest) => {
// 1.通过编译拿到编译后的html string
const result = await compileTemplate("vue-component.ejs", { name: templateName, lowerName: templateName.toLowerCase() })
// 2.写入文件的操作
const targetPath = path.resolve(dest, `${templateName}.vue`);
writeToFile(result, targetPath)
}
而action是在定义命令时候调用的,所以最外面其实还是在定义命令的代码。我们将这些定义的命令都封装在一个方法内,所以下面还有clone项目的代码。
const cloneDemoCommand = () => {
// 1.clone模板
program
.command("create <project> [others]")
.description('clone a template from repository into a folder')
.action(cloneDemoAction)
// 2.添加vue组件命令
program
.command("addcpn <name>")
.description('add vue component, 例如: zlw addcpn HelloWorld [-d src/components]')
.action((name) => {
addComponentAction(name, options.dest || 'src/components');
})
}
下面就是我们各个方法封装的位置。
第八步,添加其它的命令
到目前为止,我们已经完成了大部分的内容了,在第七步中说了,对于添加的命令我们不满足于对vue组件的添加,还要进行router,store的添加。但是总体来说和第七步是类似的。
首先我们需要模板,然后编译模板,然后输出到对于的位置上。
这里我们先定义对于的page和router的模板。这里page的意思是要添加到route的vue组件页面,所以我们直接使用上面vue组件的模板即可。
// 普通加载路由
// import <%= data.name %> from './<%= data.name %>.vue'
// 懒加载路由
const <%= data.name %> = () => import('./<%= data.name %>.vue')
export default {
path: '/<%= data.lowerName %>',
name: '<%= data.name %>',
component: <%= data.name %>,
children: [
]
}
store的模板和store 的types的模板
import * as types from './types.js'
export default {
namespaced: true,
state: {
},
mutations: {
},
actions: {
},
getters: {
}
}
export {
}
然后是action的文件
const { promisify } = require('util') //promisify可以将东西包裹成promise
const path = require('path')
const download = promisify(require('download-git-repo'))
const open = require('open')
const { vueRepo } = require('../config/repo-config')
const { commandSpawn } = require('../utils/terminal')
const { compileTemplate, writeToFile, createDirSync } = require('../utils/utils')
const cloneDemoAction = async (project, others) => {
// 1.clone项目
await download(vueRepo, project, { clone: true })
// 2.执行npm install
const command = process.platform === "win32" ? "npm.cmd" : "npm"
console.log("zlw starts to install demo dependencies ");
await commandSpawn(command, ["install"], { cwd: `./${project}` });
console.log('installed');
// 3.npm run serve
await commandSpawn(command, ["run", "serve"], { cwd: `./${project}` });
// 4.打开浏览器
open('localhost:8080/')
}
/**
*
* @param {string} templateName 生成的模板的名称
* @param {string} dest 生成的模板的位置
*/
const addComponentAction = async (templateName, dest) => {
// 1.通过编译拿到编译后的html string
const result = await compileTemplate("vue-component.ejs", { name: templateName, lowerName: templateName.toLowerCase() })
// 2.写入文件的操作
const targetPath = path.resolve(dest, `${templateName}.vue`);
writeToFile(result, targetPath)
}
const addPageAction = async (templateName, dest) => {
// 1.在page中,我们需要编译两个模板,一个是vue组件,一个是对于的router
const pageResult = await compileTemplate("vue-component.ejs", { name: templateName, lowerName: templateName.toLowerCase() })
const routerResult = await compileTemplate("vue-router.ejs", { name: templateName })
const targetPath = path.resolve(dest, templateName)
createDirSync(targetPath);
// console.log(targetPath);
writeToFile(pageResult, `${targetPath}/${templateName}.vue`);
writeToFile(routerResult, `${targetPath}/router.js`);
}
const addStoreAction = async (templateName, dest) => {
const storeResult = await compileTemplate("vue-store.ejs", {})
const typeResult = await compileTemplate("vue-types.ejs", {})
const targetPath = path.resolve(dest, templateName)
createDirSync(targetPath);
writeToFile(storeResult, `${targetPath}/${templateName}.vue`);
writeToFile(typeResult, `${targetPath}/types.js`);
}
module.exports = {
cloneDemoAction,
addComponentAction,
addPageAction,
addStoreAction
}
可以看到这里我们使用了检查文件夹的函数,这个函数定义在utils/utils.js
const fs = require('fs');
const path = require('path');
const ejs = require('ejs');
/**
* 依据传入的模板名,拿到对应的模板,然后编译成html string
* @param {string} templateName
* @param {object} data
* @returns html string
*/
const compileTemplate = (templateName, data) => {
return new Promise((resolve, reject) => {
// 1.依据传入的文件名,拿到对应的模板路径
const templatePath = path.resolve(__dirname, `../templates/${templateName}`);
//2.使用对应的api将ejs转化为html 的string ; str => Rendered HTML string
ejs.renderFile(templatePath, { data }, {}, (err, str) => {
if (err) {
reject(err)
}
resolve(str)
})
})
}
/**
* 可以递归的生成一个文件路径上的所有文件夹
* @param {string} dest 文件的路径 ,例如 src/components/home.vue
*/
const createDirSync = (dest) => {
// 如果该文件的父级文件夹存在,则直接返回
if (fs.existsSync(dest)) {
return true
}
// 当不存在的时候,就会递归的看每一级的文件夹是否存在
if (createDirSync(path.dirname(dest))) {
// 找到父级存在的了
fs.mkdirSync(dest)
return true
}
}
const writeToFile = (content, fileDestPath) => {
return fs.promises.writeFile(fileDestPath, content)
}
module.exports = {
compileTemplate,
writeToFile,
createDirSync
}
最后外面就是定义命令的代码,在creatCommand
中
const program = require('commander')
const {
cloneDemoAction,
addComponentAction,
addPageAction,
addStoreAction,
} = require('./actions')
const options = program.opts();
// 使用program.command()方法来创建指定的命令。例如:vue create 就是指令而 -D这就叫它选项
const cloneDemoCommand = () => {
// 1.clone模板
program
.command("create <project> [others]")
.description('clone a template from repository into a folder')
.action(cloneDemoAction)
// 2.添加vue组件
program
.command("addcpn <name>")
.description('add vue component, 例如: zlw addcpn HelloWorld [-d src/components]')
.action((name) => {
addComponentAction(name, options.dest || 'src/components');
})
// 3.添加page
program
.command("addpage <name>")
.description('add vue page and router config, 例如: zlw addpage Home [-d src/pages]')
.action((name) => {
addPageAction(name, options.dest || 'src/pages')
})
// 4.添加store的
program
.command("addstore <name>")
.description('add vue page and store config, 例如: zlw addstore Home [-d src/pages]')
.action((name) => {
addStoreAction(name, options.dest || 'src/store/modules')
})
}
module.exports = {
cloneDemoCommand
}