从零搭建脚手架详细记录(一) - 下载模板文件

Kapture 2018-05-15 at 18.15.13.gif

参考

我们无论是使用react 还是 vue,都会找到相关的脚手架工具,比如 react 的 create-react-app,vue的 vue-cli。我们可以非常方便的初始化一个项目,不用太去关心什么 webpack 配置啊,babel 配置之类的。今天搭了一个类似 vue-cli 的脚手架,记录一下搭建脚手架的详细过程。

简单来说,就是让用户选择,根据选择的内容从 GitHub 上下载相应的模板。可能后面还要做根据用户填写的内容修改模板,发布到 npm。这篇文章主要详细讲从 GitHub 上下载模板。

新建项目

首先新建一个项目,在新项目中执行npm init,暂时都使用默认配置。到这里会生成一个 package.json 的文件。在里面添加如下内容:


"bin": {

    " cli": "./command.js"

  },

cli 就是使用脚手架的命令,后面的文件则是要执行的文件。

入口文件 - command.js

在项目创建 command.js 文件 开头必须是 #! /usr/bin/env node,然后添加一条 log

image.png

现在,在终端项目文件夹下执行npm link,即可在该目录下使用cli 命令,你会看到在终端打印了

image.png

命令

我们在终端输入 node -v时会打印出 node 的版本号。这是怎么做到的呢?我们可以 用 commander来实现。首先安装](https://github.com/tj/commander.js)来实现。首先安装) npm install commander。在 command.js 中添加:


<pre style="margin: 8px 0px; background-color: rgb(38, 40, 51); color: rgb(193, 199, 221); font-size: 0.871rem;">const commander = require('commander');   commander.version('1.0.0') commander
 .command('init')
  .description('init extension project')
  .action(() => {
  console.log('init a project')
 }) commander.parse(process.argv)</pre>

现在就可以通过cli -V查看版本,cli -h查看帮助,cli init执行相应的命令了。

在终端与用户交互,获取输入信息

接下来使用 inquirer 在终端中与用户交互,获取信息。首先,安装 inquirer npm install inquirer。然后在 init 命令 action 中添加:


    const questions = [  

 {

  type: 'input',

  name: 'projectName',

  message: 'Please input your project name',

  filter: function(val) {

   return val;

  }

 },

 {

  type: 'list',

  name: 'type',

  message: 'What type do you need?',

  choices: [ 'frontend', 'backend' ],

  filter: function(val) {

   return val.toLowerCase();

  }

 }

]

.action(() => {

  inquirer.prompt(questions).then(answers => {

   const { projectName, type } = answers

   console.log(projectName)

   console.log(type)

 })

answers 就是用户输入的内容对象。至此,我们拿到了用户的输入,可进行下一步操作。

根据用户输入下载对应的模板

模板的准备就不再赘述,本文只说到下载模板文件,不涉及修改。模板文件可以用download-git-repo下载,并且支持 GitHub、gitlab、bitbucket,详见其文档。本文将模板文件放在了 github。


 .action(() => {

  inquirer.prompt(questions).then(answers => {

   const { projectName, type } = answers

   download(`xxx/${type}`, projectName, { clone: true }, function(err) {

    if (err) {

     console.log('err')

    } else {

     const startCmd = projectName === 'frontend' ? 'npm start' : 'npm run dev'

     conso.log(chalk.white('please run '), chalk.bgBlue(`cd ${projectName} && npm i && ${startCmd}`), chalk.white('to start it'))

    }

   })

  });

 })

chalk是一个日志的样式库,可以在终端上面调整日志的样式。这里只是给打印的信息添加一个颜色。

到这里,基本上已经完成主要功能了。

添加一个 loading 效果

接下来,要在clone 代码时展示一个 loading 的动画,提示用户。用到了ora,可以在终端实现Loading的效果。


.action(() => {

  inquirer.prompt(questions).then(answers => {

   const { projectName, type } = answers

   spinner.color = 'green';

   spinner.text = 'downloading template……';

   spinner.start()

   download(`xxx/${type}`, projectName, { clone: true }, function(err) {

    if (err) {

     spinner.text = `Error: ${err}`;

     spinner.fail()

    } else {

     const startCmd = projectName === 'frontend' ? 'npm start' : 'npm run dev'

     spinner.text = 'download success!';

     spinner.succeed()

     log(chalk.white('please run '), chalk.bgBlue(`cd ${projectName} && npm i && ${startCmd}`), chalk.white('to start it'))

     spinner.stop()

    }

   })

  });

 })

到这里,就完成了所有的功能。

后续内容:

  • 根据用户输入修改模板文件

  • 发布到 npm

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 205,033评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,725评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,473评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,846评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,848评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,691评论 1 282
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,053评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,700评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 42,856评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,676评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,787评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,430评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,034评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,990评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,218评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,174评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,526评论 2 343

推荐阅读更多精彩内容