学习笔记──搭建脚手架(一)──系统创建

前言

通过借鉴同事的一个脚手架一步步实现如何去做一个脚手架。

• Node.js：整个脚手架的运行环境。
• es6：JavaScript的新语法。
• commander：TJ大神开发的工具，可以自动的解析命令和参数，用于处理用户输入的命令。
• download-git-repo，下载并提取 git 仓库，用于下载项目模板。
• Inquirer.js，通用的命令行用户界面集合，用于和用户进行交互。
• chalk：色彩丰富的终端工具，可以给终端的字体加上颜色。
• ora：典雅的终端微调器，控制终端输出，下载过程久的话，可以用于显示下载中的动画效果。

1、新建一个目录

新建一个目录 ls-cli并进入 cd ls-cli 。然后 npm init 初始化一下生成package.json文件,在文件中设置bin，可以全局使用。

"bin": {
    "ls-cli": "cli/bin/ls-cli.js"
},

在文件中写入依赖并执行 npm install，这里有第一阶段在是还没用到的。

"dependencies": {
    "chalk": "^2.4.2",
    "commander": "^2.20.0",
    "download-git-repo": "^2.0.0",
    "inquirer": "^6.5.1",
    "ora": "^2.1.0",
    "shelljs": "^0.8.3",
    "events": "^3.0.0",
    "execa": "^0.10.0",
    "fs-extra": "^7.0.0",
    "readline": "^1.3.0",
    "replace-in-file": "^3.4.4",
    "string.prototype.padstart": "^3.0.0",
    "validate-npm-package-name": "^3.0.0"
}

2、编写入口文件

我在根目录下建立 \cli\bin 文件夹，在里面建立一个 ls-cli.js 文件。这个 cli\bin/ls-cli.js 文件是整个脚手架的入口文件。

#!/usr/bin/env node
const program = require('commander')
const pkg = require('../../package.json')

program
  .version(pkg.version, '-v, --version')
  .usage('<command> [options]')
  .description('ls-cli脚手架工具简介,提供**功能，包括初始化工程、新增组件、模板列表、删除等常用命令')

program
  .command('create <projectName>')
  .description('create a new project')
  .option('-c, --create', 'create description')
  .action((name, cmd) => {
    console.log('create ' + name  + ' ' + (cmd.create ? cmd.create : '')) 
    // lsqu-cli create b -r --> 输出：create b  true
  })

program
  .command('add <componentName>')
  .description('添加一个新组件')
  .alias('a')
  .action((name, cmd) => {
    console.log('add ' + name)
  })

program
  .command('list')
  .description('展示模板列表')
  .alias('l')
  .action(() => {
    require('../command/list')()
  })

program.on('--help', function(){
  console.log('')
  console.log('Examples:');
  console.log('  $ custom-help --help');
  console.log('  $ custom-help -h');
})

program.parse(process.argv)

commander模块解析