网站首页 » » 前端脚手架基础知识

前端脚手架基础知识

January 22, 2021

初始化项目:

npm init
npm install commander download-git-repo inquirer handlebars ora chalk log-symbols -S


index.js 初始化init命令:

#!/usr/bin/env node
const program = require('commander');

program.version('1.0.0', '-v, --version')
  .command('init <name>')
  .action((name) => {
      console.log(name);
  });
program.parse(process.argv);

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

node index.js init HelloWorld

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

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

下载模板

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

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

const inquirer = require('inquirer');
inquirer.prompt([
  {
    name: 'description',
    message: 'Input the object description'
  },
  {
    name: 'author',
    message: 'Input the object author'
  }
  ]).then((answers) => {
  console.log(answers.author);

})

{
"name": "{{name}}",
"version": "1.0.0",
"description": "{{description}}",
"scripts": {
 "test": "echo \"Error: no test specified\" && exit 1"
},
"author": "{{author}}",
"license": "ISC"

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

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

const ora = require('ora');
// 开始下载
const spinner = ora('正在下载模板...');
spinner.start();

// 下载失败调用
spinner.fail();

// 下载成功调用
spinner.succeed();

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

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

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

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

#!/usr/bin/env node

// 处理用户输入的命令
const program = require('commander');
// 下载模板
const download = require('download-git-repo');
// 问题交互
const inquirer = require('inquirer');
// node 文件模块
const fs = require('fs');
// 填充信息至文件
const handlebars = require('handlebars');
// 动画效果
const ora = require('ora');
// 字体加颜色
const chalk = require('chalk');
// 显示提示图标
const symbols = require('log-symbols');
// 命令行操作
var shell = require("shelljs");

program.version('1.0.1', '-v, --version')
.command('init ')
.action((name) => {

if (!fs.existsSync(name)) {
  inquirer.prompt([
    {
      name: 'description',
      message: 'Input the object description'
    },
    {
      name: 'author',
      message: 'Input the object author'
    }
  ]).then((answers) => {
    const spinner = ora('Downloading...');
    spinner.start();
    download('zxpsuper/suporka-parcel-vue', name, (err) => {
      if (err) {
        spinner.fail();
        console.log(symbols.error, chalk.red(err));
      } else {
        spinner.succeed();
        const fileName = `${name}/package.json`;
        const meta = {
          name,
          description: answers.description,
          author: answers.author
        }
        if (fs.existsSync(fileName)) {
          const content = fs.readFileSync(fileName).toString();
          const result = handlebars.compile(content)(meta);
          fs.writeFileSync(fileName, result);
        }
        console.log(symbols.success, chalk.green('The vue object has downloaded successfully!'));
        inquirer.prompt([
          {
            type: 'confirm',
            name: 'ifInstall',
            message: 'Are you want to install dependence now?',
            default: true
          }
        ]).then((answers) => {
          if (answers.ifInstall) {
            inquirer.prompt([
              {
                type: 'list',
                name: 'installWay',
                message: 'Choose the tool to install',
                choices: [
                  'npm', 'cnpm'
                ]
              }
            ]).then(ans => {
              if (ans.installWay === 'npm') {
                let spinner = ora('Installing...');
                spinner.start();
                // 命令行操作安装依赖
                shell.exec("cd " + name + " && npm i", function (err, stdout, stderr) {
                  if (err) {
                    spinner.fail();
                    console.log(symbols.error, chalk.red(err));
                  }
                  else {
                    spinner.succeed();
                    console.log(symbols.success, chalk.green('The object has installed dependence successfully!'));
                  }
                });
              } else {
                let spinner = ora('Installing...');
                spinner.start();
                shell.exec("cd " + name + " && cnpm i", function (err, stdout, stderr) {
                  if (err) {
                    spinner.fail();
                    console.log(symbols.error, chalk.red(err));
                  }
                  else {
                    spinner.succeed();
                    console.log(symbols.success, chalk.green('The object has installed dependence successfully!'));
                  }
                })
              }
            })
          } else {
            console.log(symbols.success, chalk.green('You should install the dependence by yourself!'));
          }
        })
      }
    })
  })
} else {
  // 错误提示项目已存在,避免覆盖原有项目
  console.log(symbols.error, chalk.red('The object has exist'));
}

});
program.parse(process.argv);