使用Node.js开发简单的脚手架工具

前言

像我们熟悉的 vue-cli，react-native-cli 等脚手架，只需要输入简单的命令 vue init webpack project，即可快速帮我们生成一个初始项目。在实际工作中，我们可以定制一个属于自己的脚手架，来提高自己的工作效率。

成都创新互联主要从事成都网站设计、网站建设、网页设计、企业做网站、公司建网站等业务。立足成都服务丹凤,10余年网站建设经验,价格优惠、服务专业,欢迎来电咨询建站服务:028-86922220

为什么需要需要脚手架？

  • 减少重复性的工作，不再需要复制其他项目再删除无关代码，或者从零创建一个项目和文件。
  • 根据交互动态生成项目结构和配置文件等。
  • 多人协作更为方便，不需要把文件传来传去。

思路

要开发脚手架，首先要理清思路，脚手架是如何工作的？我们可以借鉴 vue-cli 的基本思路。vue-cli 是将项目模板放在 git 上，运行的时候再根据用户交互下载不同的模板，经过模板引擎渲染出来，生成项目。这样将模板和脚手架分离，就可以各自维护，即使模板有变动，只需要上传最新的模板即可，而不需要用户去更新脚手架就可以生成最新的项目。那么就可以按照这个思路来进行开发了。

第三方库

首先来看看会用到哪些库。

  • commander.js，可以自动的解析命令和参数，用于处理用户输入的命令。
  • download-git-repo，下载并提取 git 仓库，用于下载项目模板。
  • Inquirer.js，通用的命令行用户界面集合，用于和用户进行交互。
  • handlebars.js，模板引擎，将用户提交的信息动态填充到文件中。
  • ora，下载过程久的话，可以用于显示下载中的动画效果。
  • chalk，可以给终端的字体加上颜色。
  • log-symbols，可以在终端上显示出 √ 或 × 等的图标。

初始化项目

首先创建一个空项目，暂时命名为 okii-cli，然后新建一个 index.js 文件，再执行 npm init 生成一个 package.json 文件。最后安装上面需要用到的依赖。

 
 
 
    
  
  
  
  1. npm install commander download-git-repo inquirer handlebars ora chalk log-symbols -S 
    2.

处理命令行

node.js 内置了对命令行操作的支持，在 package.json 中的 bin 字段可以定义命令名和关联的执行文件。所以现在 package.json 中加上 bin 的内容：

 
 
 
    
  
  
  
  1. { 
    2.   
  
  
  2.   "name": "okii-cli", 
    3.   
  
  
  3.   "version": "1.0.0", 
    4.   
  
  
  4.   "description": "基于node的脚手架工具", 
    5.   
  
  
  5.   "bin": { 
    6.   
  
  
  6.     "okii": "index.js" 
    7.   
  
  
  7.   }, 
    8.   
  
  
  8.   ... 
    9.   
  
  
  9. } 
    10.

然后在 index.js 中来定义 init 命令：

 
 
 
    
  
  
  
  1. #!/usr/bin/env node 
    2.   
  
  
  2. const program = require('commander'); 
    3.   
  
  
  3.  
    4.   
  
  
  4. program.version('1.0.0', '-v, --version') 
    5.   
  
  
  5.        .command('init ') 
    6.   
  
  
  6.        .action((name) => { 
    7.   
  
  
  7.            console.log(name); 
    8.   
  
  
  8.        }); 
    9.   
  
  
  9. program.parse(process.argv); 
    10.

调用 version('1.0.0', '-v, --version') 会将 -v 和 --version 添加到命令中，可以通过这些选项打印出版本号。
调用 command('init ') 定义 init 命令，name 则是必传的参数，为项目名。
action() 则是执行 init 命令会发生的行为，要生成项目的过程就是在这里面执行的，这里暂时只打印出 name。
其实到这里，已经可以执行 init 命令了。我们来测试一下，在 okii-cli 的同级目录下执行：

 
 
 
    
  
  
  
  1. node ./okii-cli/index.js init HelloWorld 
    2.

可以看到命令行工具也打印出了 HelloWorld，那么很清楚， action((name) => {}) 这里的参数 name，就是我们执行 init 命令时输入的项目名称。

命令已经完成，接下来就要下载模板生成项目结构了。

下载模板

download-git-repo 支持从 Github、Gitlab 和 Bitbucket 下载仓库，各自的具体用法可以参考官方文档。

由于是公司项目，所以把模板仓库放在了 Gitlab 上，那么在 action() 中进行操作下载模板：

 
 
 
    
  
  
  
  1. #!/usr/bin/env node 
    2.   
  
  
  2. const program = require('commander'); 
    3.   
  
  
  3. const download = require('download-git-repo'); 
    4.   
  
  
  4.  
    5.   
  
  
  5. program.version('1.0.0', '-v, --version') 
    6.   
  
  
  6.        .command('init ') 
    7.   
  
  
  7.        .action((name) => { 
    8.   
  
  
  8.            download('http://xxxxxx:9999:HTML5/H5Template#master', name, {clone: true}, (err) => { 
    9.   
  
  
  9.                 console.log(err ? 'Error' : 'Success') 
    10.   
  
  
  10.            }) 
    11.   
  
  
  11.        }); 
    12.   
  
  
  12. program.parse(process.argv); 
    13.

download() 第一个参数就是仓库地址，但是有一点点不一样。实际的仓库地址是 http://xxxxxx:9999/HTML5/H5Template#master ，可以看到端口号后面的 '/' 在参数中要写成 ':'，#master 代表的就是分支名，不同的模板可以放在不同的分支中，更改分支便可以实现下载不同的模板文件了。第二个参数是路径，上面我们直接在当前路径下创建一个 name 的文件夹存放模板，也可以使用二级目录比如 test/${name}

命令行交互

命令行交互功能可以在用户执行 init 命令后，向用户提出问题，接收用户的输入并作出相应的处理。这里使用 inquirer.js 来实现。

 
 
 
    
  
  
  
  1. const inquirer = require('inquirer'); 
    2.   
  
  
  2. inquirer.prompt([ 
    3.   
  
  
  3.     { 
    4.   
  
  
  4.         type: 'input', 
    5.   
  
  
  5.         name: 'author', 
    6.   
  
  
  6.         message: '请输入作者名称' 
    7.   
  
  
  7.     } 
    8.   
  
  
  8. ]).then((answers) => { 
    9.   
  
  
  9.     console.log(answers.author); 
    10.   
  
  
  10. }) 
    11.

通过这里例子可以看出，问题就放在 prompt() 中，问题的类型为 input 就是输入类型，name 就是作为答案对象中的 key，message 就是问题了，用户输入的答案就在 answers 中，使用起来就是这么简单。更多的参数设置可以参考官方文档。

通过命令行交互，获得用户的输入，从而可以把答案渲染到模板中。

渲染模板

这里用 handlebars 的语法对 HTML5/H5Template 仓库的模板中的 package.json 文件做一些修改

 
 
 
    
  
  
  
  1. { 
    2.   
  
  
  2.   "name": "{{name}}", 
    3.   
  
  
  3.   "version": "1.0.0", 
    4.   
  
  
  4.   "description": "{{description}}", 
    5.   
  
  
  5.   "scripts": { 
    6.   
  
  
  6.     "test": "echo \"Error: no test specified\" && exit 1" 
    7.   
  
  
  7.   }, 
    8.   
  
  
  8.   "author": "{{author}}", 
    9.   
  
  
  9.   "license": "ISC" 
    10.   
  
  
  10. } 
    11.

并在下载模板完成之后将用户输入的答案渲染到 package.json 中

 
 
 
    
  
  
  
  1. program.version('1.0.0', '-v, --version') 
    2.   
  
  
  2. .command('init ') 
    3.   
  
  
  3. .action((name) => { 
    4.   
  
  
  4.     inquirer.prompt([ 
    5.   
  
  
  5.     { 
    6.   
  
  
  6.         name: 'description', 
    7.   
  
  
  7.         message: '请输入项目描述' 
    8.   
  
  
  8.     }, 
    9.   
  
  
  9.     { 
    10.   
  
  
  10.         name: 'author', 
    11.   
  
  
  11.         message: '请输入作者名称' 
    12.   
  
  
  12.     } 
    13.   
  
  
  13.     ]).then((answers) => { 
    14.   
  
  
  14.         download('xxxxx#master',name,{clone: true},(err) => { 
    15.   
  
  
  15.             const meta = { 
    16.   
  
  
  16.                 name, 
    17.   
  
  
  17.                 description: answers.description, 
    18.   
  
  
  18.                 author: answers.author 
    19.   
  
  
  19.             } 
    20.   
  
  
  20.             const fileName = `${name}/package.json`; 
    21.   
  
  
  21.             const content = fs.readFileSync(fileName).toString(); 
    22.   
  
  
  22.             const result = handlebars.compile(content)(meta); 
    23.   
  
  
  23.             fs.writeFileSync(fileName, result); 
    24.   
  
  
  24.         }) 
    25.   
  
  
  25.     }) 
    26.   
  
  
  26. }); 
    27.

这里使用了 node.js 的文件模块 fs，将 handlebars 渲染完后的模板重新写入到文件中。

视觉美化

在用户输入答案之后，开始下载模板，这时候使用 ora 来提示用户正在下载中。

 
 
 
    
  
  
  
  1. const ora = require('ora'); 
    2.   
  
  
  2. // 开始下载 
    3.   
  
  
  3. const spinner = ora('正在下载模板...'); 
    4.   
  
  
  4. spinner.start(); 
    5.   
  
  
  5.  
    6.   
  
  
  6. // 下载失败调用 
    7.   
  
  
  7. spinner.fail(); 
    8.   
  
  
  8.  
    9.   
  
  
  9. // 下载成功调用 
    10.   
  
  
  10. spinner.succeed(); 
    11.

然后通过 chalk 来为打印信息加上样式，比如成功信息为绿色，失败信息为红色，这样子会让用户更加容易分辨，同时也让终端的显示更加的好看。

 
 
 
    
  
  
  
  1. const chalk = require('chalk'); 
    2.   
  
  
  2. console.log(chalk.green('项目创建成功')); 
    3.   
  
  
  3. console.log(chalk.red('项目创建失败')); 
    4.

除了给打印信息加上颜色之外，还可以使用 log-symbols 在信息前面加上 √ 或 × 等的图标

 
 
 
    
  
  
  
  1. const chalk = require('chalk'); 
    2.   
  
  
  2. const symbols = require('log-symbols'); 
    3.   
  
  
  3. console.log(symbols.success, chalk.green('项目创建成功')); 
    4.   
  
  
  4. console.log(symbols.error, chalk.red('项目创建失败')); 
    5.

完整示例

 
 
 
    
  
  
  
  1. #!/usr/bin/env node 
    2.   
  
  
  2. const fs = require('fs'); 
    3.   
  
  
  3. const program = require('commander'); 
    4.   
  
  
  4. const download = require('download-git-repo'); 
    5.   
  
  
  5. const handlebars = require('handlebars'); 
    6.   
  
  
  6. const inquirer = require('inquirer'); 
    7.   
  
  
  7. const ora = require('ora'); 
    8.   
  
  
  8. const chalk = require('chalk'); 
    9.   
  
  
  9. const symbols = require('log-symbols'); 
    10.   
  
  
  10.  
    11.   
  
  
  11. program.version('1.0.0', '-v, --version') 
    12.   
  
  
  12.     .command('init ') 
    13.   
  
  
  13.     .action((name) => { 
    14.   
  
  
  14.         if(!fs.existsSync(name)){ 
    15.   
  
  
  15.             inquirer.prompt([ 
    16.   
  
  
  16.                 { 
    17.   
  
  
  17.                     name: 'description', 
    18.   
  
  
  18.                     message: '请输入项目描述' 
    19.   
  
  
  19.                 }, 
    20.   
  
  
  20.                 { 
    21.   
  
  
  21.                     name: 'author', 
    22.   
  
  
  22.                     message: '请输入作者名称' 
    23.   
  
  
  23.                 } 
    24.   
  
  
  24.             ]).then((answers) => { 
    25.   
  
  
  25.                 const spinner = ora('正在下载模板...'); 
    26.   
  
  
  26.                 spinner.start(); 
    27.   
  
  
  27.                 download('http://xxxxxx:9999:HTML5/H5Template#master', name, {clone: true}, (err) => { 
    28.   
  
  
  28.                     if(err){ 
    29.   
  
  
  29.                         spinner.fail(); 
    30.   
  
  
  30.                         console.log(symbols.error, chalk.red(err)); 
    31.   
  
  
  31.                     }else{ 
    32.   
  
  
  32.                         spinner.succeed(); 
    33.   
  
  
  33.                         const fileName = `${name}/package.json`; 
    34.   
  
  
  34.                         const meta = { 
    35.   
  
  
  35.                             name, 
    36.   
  
  
  36.                             description: answers.description, 
    37.   
  
  
  37.                             author: answers.author 
    38.   
  
  
  38.                         } 
    39.   
  
  
  39.                         if(fs.existsSync(fileName)){ 
    40.   
  
  
  40.                             const content = fs.readFileSync(fileName).toString(); 
    41.   
  
  
  41.                             const result = handlebars.compile(content)(meta); 
    42.   
  
  
  42.                             fs.writeFileSync(fileName, result); 
    43.   
  
  
  43.                         } 
    44.   
  
  
  44.                         console.log(symbols.success, chalk.green('项目初始化完成')); 
    45.   
  
  
  45.                     } 
    46.   
  
  
  46.                 }) 
    47.   
  
  
  47.             }) 
    48.   
  
  
  48.         }else{ 
    49.   
  
  
  49.             // 错误提示项目已存在，避免覆盖原有项目 
    50.   
  
  
  50.             console.log(symbols.error, chalk.red('项目已存在')); 
    51.   
  
  
  51.         } 
    52.   
  
  
  52.     }) 
    53.   
  
  
  53. program.parse(process.argv); 
    54.

效果如下：
[[232433]]

完成之后，就可以把脚手架发布到 npm 上面，通过 -g 进行全局安装，就可以在自己本机上执行 okii init [name] 来初始化项目，这样便完成了一个简单的脚手架工具了。

本文题目：使用Node.js开发简单的脚手架工具
标题网址：http://www.36103.cn/qtweb/news30/27280.html

网站建设、网络推广公司-创新互联，是专注品牌与效果的网站制作，网络营销seo公司；服务项目有等

广告

声明：本网站发布的内容（图片、视频和文字）以用户投稿、用户转载内容为主，如果涉及侵权请尽快告知，我们将会在第一时间删除。文章观点不代表本网站立场，如需处理请联系客服。电话：028-86922220；邮箱：631063699@qq.com。内容未经允许不得转载，或转载时需注明来源： 创新互联

猜你还喜欢下面的内容

自适应网站知识

分类信息网站

手机APP开发　　 　网站SEO优化　　 　乐山网站建设　　 　宜宾冠赛网站　　 　品牌网站建设　　 　高端网站设计推广　　 　网站seo　　 　IDC机房托管　　 　成都网站建设　　 　响应式网站设计　　 　四川晃众门窗　　 　成都网站制作　　 　成都铺面装修　　 　江油网站建设　　 　营销型网站建设　　 　网站营销　　 　成都添翼二手车　　 　网站定制　　 　电信服务器托管　　 　域名注册