Gossip - 脚手架Yue-cli实现03-download功能

这是系列文章前端脚手架实现的第三篇，本文核心解决当我们通过模板来初始化项目时如何把选定版本的模板文件下载到对应文件夹中的问题。

当我们在拉取模板文件的时候，存在两种情况，一种是直接把初始化项目的模板文件下载下来保存到指定文件目录即可，另一种是模板文件需要先渲染，我们需要通过终端交互的方式来输入必要信息以完成模板文件的渲染操作，渲染完成后再下载到本地指定文件目录。模板文件是否需要渲染我们可以通过一个指定的文件来进行配置和说明。

在进行上述操作的时候，我需要通过用到一些node模块并提供两个模板仓库来供我们存放模板文件。

安装download-git-repo模块以实现下载文件的操作。

1
2
3

$ npm install download-git-repo

let downloadGitRepo = require('download-git-repo');

安装并引入util模块，该模块的promisify用来把异步 Api 转换为 Promise。

$ npm install util

const { promisify } = require('util');
downloadGitRepo = promisify(downloadGitRepo);

安装ncp模块用于拷贝文件到指定的目录。

1
2
3

$ npm install ncp

const ncp = require('ncp');

模板下载

我在自己的 github 帐号下面创建了Yong-Template组织，在该组织中创建了两个仓库，其中的仓库 vue-simple-template 中包含了用于创建 Vue项目的初始化项目(模板)文件，另一个仓库 vue-render-template 则需要通过终端询问的方式来先渲染再下载。

当我们通过 github 提供的 API： https://api.github.com/orgs/Yong-template/repos 来访问组织的时候可以获取仓库相关的 JSON 文件。下面利用安装的download-git-repo来下载项目文件。

/* constants.js 文件内容 */
const downloadDirectory = 
    `${process.env[process.platform === 'darwin' ? 'HOME' : 'USERPROFILE']}/.template`;

module.exports = {
    downloadDirectory,
};

/* create.js 文件内容 */
/* 1.安装和导入模板 */
const { promisify } = require('util');
let downloadGitRepo = require('download-git-repo');
downloadGitRepo = promisify(downloadGitRepo); /* 把异步 API 转换为 Promise */

const { downloadDirectory } = require('../util/constants.js');

/* 2.封装下载函数 */
const downloadTask = async(repo, tag) => {
    const dest = `${downloadDirectory}/${repo}`;

    let url = `Yong-template/${repo}`;
    if (tag) url += `#${tag}`
    
    console.log("dest", dest, "url", url);
    /* dest:/Users/文顶顶/.template/vue-simple-template */
    /* url :Yong-template/vue-simple-template#v1.0.0 */

    await downloadGitRepo(url, dest);
    return dest; // 下载的最终目录
};

/* 3.传入仓库名和版本号执行下载操作 */
/* 假设此处的仓库名repo：vue-simple-template 版本号：v2.0.0 */
const dest = await loading(downloadTask, "download template ...")(repo, tag);
console.log("template", dest);

/* path.resolve(projectName) 在执行指令的当前目录下面创建projectName为名的文件夹 */
console.log("path.resolve(projectName)", path.resolve(projectName));
await ncp(dest, path.resolve(projectName));

当 create 文件中上面代码完成后，执行Yue-cli create app指令就能够下载文件到当前目录了。

wendingding:Yue-cli wendingding$ Yue-cli create app
执行 action-> create
[ '/usr/local/bin/node',
  '/usr/local/bin/Yue-cli',
  'create',
  'app' ]
✔ fetching template ...
? please choice a template to create project ! vue-simple-template
✔ fetching tags ...
? please choices tags to create project v2.0.0
⠋ download template ...
dest /Users/文顶顶/.template/vue-simple-template url Yong-template/vue-simple-template#v2.0
✔ download template ...
template /Users/文顶顶/.template/vue-simple-template
path.resolve(projectName) /Users/文顶顶/Documents/花田半亩 /Yue-cli/app

模板渲染

有时候用户在利用脚手架工具创建项目的时候，可能需要自己来输入描述信息、协议、和作者等信息，那么这种情况我们可以在项目的模板文件中提供一个文件用来保存这些信息，而 package.json文件中相关的字段用 ejs 模板的方式来处理，我们要做的就是在下载安装的时候，先询问用户，然后根据用户的选择来渲染并生成最终的package.json文件最后下载到本地。

我们先看下询问文件的信息和package.json文件的内容。

/* render.js 文件的内容 */
module.exports = [{
        type: 'confirm',
        name: 'private',
        message: 'This register is private ?',
    },
    {
        type: 'input',
        name: 'author',
        message: "Please set the author name ?",
    },
    {
        type: 'input',
        name: 'description',
        message: 'Please enter description information ?',
    },
    {
        type: 'input',
        name: 'license',
        message: 'Please enter license ?',
    },
]

/* package.json文件的内容 */
{
    "name": "vue-template-simple",
    "version": "0.1.2",
    "private": "<%=private%>",
    "scripts": {
        "serve": "vue-cli-service serve",
        "build": "vue-cli-service build"
    },
    "dependencies": {
        "vue": "^2.6.10"
    },
    "author": "<%=author%>",
    "description": "<%=description%>",
    "devDependencies": {
        "@vue/cli-service": "^3.11.0",
        "vue-template-compiler": "^2.6.10"
    },
    "license": "<%=license%>"
}

我们把用户的选择融入到package.json模板文件中最后生成完整的package.json文件需要用到ejs模板，此外还需要安装metalsmith等模块来遍历文件夹，下面给出安装的关键指令和最终的代码。

1
2
3

$ npm install metalsmith
$ npm install ejs
$ npm install consolidate

/* 列出 create.js 文件的内容 */
/* 导入模块 */
const axios = require('axios');
const ora = require('ora');
const fs = require('fs');
const ncp = require('ncp');
const path = require('path');
const inquirer = require('inquirer');
const { promisify } = require('util');
const MetalSmith = require('metalsmith');
let { render } = require('consolidate').ejs; /* 模板引擎 */
render = promisify(render);


let downloadGitRepo = require('download-git-repo');
downloadGitRepo = promisify(downloadGitRepo); /* 把异步 API 转换为 Promise */
const { downloadDirectory } = require('../util/constants.js');

/* 封装函数获取存放模板信息的数据 */
async function getRepositoryList() {
    const { data } = await axios.get("https://api.github.com/orgs/Yong-template/repos");
    return data;
}

const getTagList = async(repo) => {
// https: //api.github.com/repos/Yong-template/vue-simple-template/tags
const { data } = await axios.get(`https://api.github.com/repos/Yong-template/${repo}/tags`);
return data;
};

const loading = (fn, message) => async(...args) => {
    const spinner = ora(message);
    spinner.start();
    const result = await fn(...args);
    spinner.succeed();
    return result;
};

const downloadTask = async(repo, tag) => {
    let url = `Yong-template/${repo}`;
    if (tag) url += `#${tag}`
    const dest = `${downloadDirectory}/${repo}`;
    console.log("dest", dest, "url", url);
    await downloadGitRepo(url, dest);
    return dest; // 下载的最终目录
};

module.exports = async(projectName) => {

    let repoList = await loading(getRepositoryList, "fetching template ...")();
    const { repo } = await inquirer.prompt({
        name: "repo",
        type: "list",
        message: "please choice a template to create project !",
        choices: repoList.map(item => item.name)
    })

    let tagList = await loading(getTagList, "fetching tags ...")(repo);

    const { tag } = await inquirer.prompt({
        name: 'tag',
        type: 'list',
        message: 'please choices tags to create project',
        choices: tagList.map(item => item.name),
    });

    const dest = await loading(downloadTask, "download template ...")(repo, tag);
    console.log("template", dest);

    // console.log("tag ->", tag)
    /* 根据选择的仓库 + 版本号，下载模板文件到当前项目中指定的文件夹 */

    /* dest:/Users/文顶顶/.template/vue-simple-template */
    /* url :Yong-template/vue-simple-template#v1.0.0 */

    /* path.resolve(projectName) 表示在执行指令的当前目录下面创建projectName为名的文件夹 */
    console.log("path.resolve(projectName)", path.resolve(projectName));
    await ncp(dest, path.resolve(projectName));

    if (!fs.existsSync(path.join(dest, 'render.js'))) {
        await ncp(dest, path.resolve(projectName));
    } else {
        await new Promise((resolve, reject) => {
            MetalSmith(__dirname) // 如果你传入路径 他默认会遍历当前路径下的src文件夹
                .source(dest)
                .destination(path.resolve(projectName))
                .use(async(files, metal, done) => {
                    const args = require(path.join(dest, 'render.js'));
                    const obj = await inquirer.prompt(args);
                    const meta = metal.metadata();
                    Object.assign(meta, obj);
                    delete files['render.js'];
                    done();
                })
                .use((files, metal, done) => {
                    const obj = metal.metadata();
                    Reflect.ownKeys(files).forEach(async(file) => {
                        if (file.includes('js') || file.includes('json')) {
                            let content = files[file].contents.toString(); // 文件的内容
                            if (content.includes('<%')) {
                                content = await render(content, obj);
                                files[file].contents = Buffer.from(content); // 渲染
                            }
                        }
                    });
                    done();
                })
                .build((err) => {
                    if (err) {
                        reject();
                    } else {
                        resolve();
                    }
                });
        });
    }
};

测试指令的执行情况。

wendingding$ Yue-cli c myApp
执行 action-> create
[ '/usr/local/bin/node', '/usr/local/bin/Yue-cli', 'c', 'myApp' ]
✔ fetching template ...
? please choice a template to create project ! vue-render-template
✔ fetching tags ...
? please choices tags to create project v1.0.0
⠋ download template ...
dest /Users/文顶顶/.template/vue-render-template url Yong-template/vue-render-template#v1.0
✔ download template ...
template /Users/文顶顶/.template/vue-render-template
path.resolve(projectName) /Users/文顶顶/Documents/花田半亩 /Yue-cli/myApp
? this register is private ? No
? author? Yong
? description ? 测试
? license ? MIT

wendingding$ Tree -L 2
.
├── LICENSE
├── README.md
├── bin
│   └── www
├── dist
├── myApp
│   ├── README.md
│   ├── package.json
│   ├── postcss.config.js
│   ├── public
│   ├── render.js
│   ├── src
│   └── yarn.lock
├── node_modules
│   ├── ...
│   └── yauzl
├── note.md
├── package-lock.json
├── package.json
├── src
│   ├── create.js
│   ├── dist
│   └── main.js
└── util
    ├── constants.js
    └── dist

Posted by 博客园·文顶顶 | 花田半亩
联系作者简书·文顶顶新浪微博·Coder_文顶顶
原创文章，版权声明：自由转载-非商用-非衍生-保持署名 | 文顶顶