首页 > 其他分享> > 手摸手教你搭个脚手架

手摸手教你搭个脚手架

2021-07-12 10:02:11 作者：互联网

const inquirer = require("inquirer");

inquirer
    .prompt([
        {
            type: "input",
            name: "project",
            message: "项目名称",
        },
        {
            type: "list",
            name: "tpl",
            message: "请选择模板",
            choices: ["vue", "react"],
        }
    ])
    .then((res) => {
        console.log(res);
        const { project, tpl } = res;
        // project就是用户输入的项目名称
        // tpl就是用户选择的模板
    });

这段代码就是为用户提供了一个input输入选项，来输入项目名称，以及一个list列表选项，来选择要下载的模板（之后我们再根据这个模板名称去对应的仓库地址进行下载）。

inquirer交互效果

inquirer还有更多的选项功能，感兴趣的小伙伴可以去官方文档上自由探索：https://github.com/SBoudrias/Inquirer.js。

4、拉取远程仓库代码

现在我们已经知道用户要下载的是哪个模板代码，也知道这些模板代码对应的下载地址：

const stores = [
    {
        name: "vue",
        url: "https://github.com/vuejs/vue.git"
    },
    {
        name: "react",
        url: "https://github.com/facebook/react.git"
    }
]

拉取github或者gitlab远程仓库代码的第三方模块也有好几个，我选用的是nodegit，这个项目在github上目前有4.9k的star，用起来也很简单：

const Git = require("nodegit");

/** 克隆远程仓库代码 */
// url: 源码仓库地址; path: 要下载的目标路径; cb: 下载结束后的回调函数
const gitClone = (url, path, cb)=>{
    console.log("正在下载远程仓库代码...")
    console.log(url)
    Git.Clone(url, path)
       .then(function(res) {
            console.log("下载完成")
            cb(true)
        })
        .catch(function(err) { console.log("下载失败"+err);cb(false) });
}

nodegit官网地址：
https://github.com/nodegit/nodegit

至此三个基本功能都已实现！

5、优化

深谙摸鱼之道的我想了想，觉得还能更进一步，比如下载完源码，再帮我自动安装下依赖包啦：

const process = require('child_process');

/** 安装依赖包 */
const install = (path)=>{ // path是源码模板中package.json所在的路径
    console.log("正在安装依赖包...")
    const cmd = 'cd '+path+' && yarn';
    process.exec(cmd, function(error, stdout, stderr) {
        console.log(error);
        console.log(stdout);
        console.log(stderr);
        console.log("安装完成")
    });
}

愉快地摸会儿鱼

之前看到很多脚手架出场都自带拉风的艺术字，作为一个有追求的切图仔，这个必须安排！
这个也是用到了一个第三方模块figlet（https://github.com/patorjk/figlet.js）：

const figlet = require('figlet');   
figlet('My CLI!', {horizontalLayout:"full"}, function(err, data) {
    if (err) {
        console.log('Something went wrong...');
        console.dir(err);
        return;
    }
    console.log(data)
    // do something...
});

瞬间高大上有木有o

很多脚手架还提供了参数配置、帮助信息等功能，这个大多是通过commander模块实现的（https://github.com/tj/commander.js，20.7k star），这里就不详细展开了，我在demo项目里也简单实现了下，确实很强大很好用。

Demo已开源：https://github.com/youzouzou/testcli。

这个demo只是简单地实现了脚手架的基本功能，探索了一下几个node模块的用法，还有很多需要优化的点。进一步学习的最好办法就是去看那些成熟的脚手架源码，然后去模仿去实践，再结合实际情况，摸索出最适合自己团队的方案。

6、总结

工欲善其事，必先利其器。

实际上脚手架并不拘泥于上面的实现形式，凡是能提高效率的工具，在某种意义上都可以称之为脚手架。

模仿只是最初级的阶段，创新才是真正的开始。

标签：npm,vue,console,log,全局,搭个,手教,脚手架
来源： https://www.cnblogs.com/wl-blog/p/15000803.html

手摸手教你搭个脚手架

目录

1、脚手架

2、全局命令

2.1 基本原理

2.2 全局命令的实现

3、交互式输入

4、拉取远程仓库代码

5、优化

6、总结