欧美bbbwbbbw肥妇,免费乱码人妻系列日韩,一级黄片

詳解使用 Node.js 開發(fā)簡單的腳手架工具

 更新時間:2018年06月08日 11:18:54   作者:linshuai  
這篇文章主要介紹了詳解使用 Node.js 開發(fā)簡單的腳手架工具,小編覺得挺不錯的,現(xiàn)在分享給大家,也給大家做個參考。一起跟隨小編過來看看吧

前言

像我們熟悉的 vue-cli,react-native-cli 等腳手架,只需要輸入簡單的命令 vue init webpack project,即可快速幫我們生成一個初始項目。在實際工作中,我們可以定制一個屬于自己的腳手架,來提高自己的工作效率。

為什么需要需要腳手架?

  1. 減少重復(fù)性的工作,不再需要復(fù)制其他項目再刪除無關(guān)代碼,或者從零創(chuàng)建一個項目和文件。
  2. 根據(jù)交互動態(tài)生成項目結(jié)構(gòu)和配置文件等。
  3. 多人協(xié)作更為方便,不需要把文件傳來傳去。

思路

要開發(fā)腳手架,首先要理清思路,腳手架是如何工作的?我們可以借鑒 vue-cli 的基本思路。vue-cli 是將項目模板放在 git 上,運行的時候再根據(jù)用戶交互下載不同的模板,經(jīng)過模板引擎渲染出來,生成項目。這樣將模板和腳手架分離,就可以各自維護,即使模板有變動,只需要上傳最新的模板即可,而不需要用戶去更新腳手架就可以生成最新的項目。那么就可以按照這個思路來進行開發(fā)了。

第三方庫

首先來看看會用到哪些庫。

commander.js,可以自動的解析命令和參數(shù),用于處理用戶輸入的命令。
download-git-repo,下載并提取 git 倉庫,用于下載項目模板。
Inquirer.js,通用的命令行用戶界面集合,用于和用戶進行交互。
handlebars.js,模板引擎,將用戶提交的信息動態(tài)填充到文件中。
ora,下載過程久的話,可以用于顯示下載中的動畫效果。
chalk,可以給終端的字體加上顏色。
log-symbols,可以在終端上顯示出 √ 或 × 等的圖標。

初始化項目

首先創(chuàng)建一個空項目,暫時命名為 okii-cli,然后新建一個 index.js 文件,再執(zhí)行 npm init 生成一個 package.json 文件。最后安裝上面需要用到的依賴。

復(fù)制代碼 代碼如下:
npm install commander download-git-repo inquirer handlebars ora chalk log-symbols -S

處理命令行

node.js 內(nèi)置了對命令行操作的支持,在 package.json 中的 bin 字段可以定義命令名和關(guān)聯(lián)的執(zhí)行文件。所以現(xiàn)在

package.json 中加上 bin 的內(nèi)容:

{
 "name": "okii-cli",
 "version": "1.0.0",
 "description": "基于node的腳手架工具",
 "bin": {
  "okii": "index.js"
 },
 ...
}

然后在 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);

調(diào)用 version('1.0.0', '-v, --version') 會將 -v 和 --version 添加到命令中,可以通過這些選項打印出版本號。

調(diào)用 command('init <name>') 定義 init 命令,name 則是必傳的參數(shù),為項目名。

action() 則是執(zhí)行 init 命令會發(fā)生的行為,要生成項目的過程就是在這里面執(zhí)行的,這里暫時只打印出 name。

其實到這里,已經(jīng)可以執(zhí)行 init 命令了。我們來測試一下,在 okii-cli 的同級目錄下執(zhí)行:

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

可以看到命令行工具也打印出了 HelloWorld,那么很清楚, action((name) => {}) 這里的參數(shù) name,就是我們執(zhí)行 init 命令時輸入的項目名稱。

命令已經(jīng)完成,接下來就要下載模板生成項目結(jié)構(gòu)了。

下載模板

download-git-repo 支持從 Github、Gitlab 和 Bitbucket 下載倉庫,各自的具體用法可以參考官方文檔。

由于是公司項目,所以把模板倉庫放在了 Gitlab 上,那么在 action() 中進行操作下載模板:

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

program.version('1.0.0', '-v, --version')
    .command('init <name>')
    .action((name) => {
      download('http://xxxxxx:9999:HTML5/H5Template#master', name, {clone: true}, (err) => {
        console.log(err ? 'Error' : 'Success')
      })
    });
program.parse(process.argv);

download() 第一個參數(shù)就是倉庫地址,但是有一點點不一樣。實際的倉庫地址是 http://xxxxxx:9999/HTML5/H5Template#master ,可以看到端口號后面的 '/' 在參數(shù)中要寫成 ':',#master 代表的就是分支名,不同的模板可以放在不同的分支中,更改分支便可以實現(xiàn)下載不同的模板文件了。第二個參數(shù)是路徑,上面我們直接在當前路徑下創(chuàng)建一個 name 的文件夾存放模板,也可以使用二級目錄比如 test/${name}

命令行交互

命令行交互功能可以在用戶執(zhí)行 init 命令后,向用戶提出問題,接收用戶的輸入并作出相應(yīng)的處理。這里使用 inquirer.js 來實現(xiàn)。

const inquirer = require('inquirer');
inquirer.prompt([
  {
    type: 'input',
    name: 'author',
    message: '請輸入作者名稱'
  }
]).then((answers) => {
  console.log(answers.author);
})

通過這里例子可以看出,問題就放在 prompt() 中,問題的類型為 input 就是輸入類型,name 就是作為答案對象中的 key,message 就是問題了,用戶輸入的答案就在 answers 中,使用起來就是這么簡單。更多的參數(shù)設(shè)置可以參考官方文檔。

通過命令行交互,獲得用戶的輸入,從而可以把答案渲染到模板中。

渲染模板

這里用 handlebars 的語法對 HTML5/H5Template 倉庫的模板中的 package.json 文件做一些修改

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

并在下載模板完成之后將用戶輸入的答案渲染到 package.json 中

program.version('1.0.0', '-v, --version')
.command('init <name>')
.action((name) => {
  inquirer.prompt([
  {
    name: 'description',
    message: '請輸入項目描述'
  },
  {
    name: 'author',
    message: '請輸入作者名稱'
  }
  ]).then((answers) => {
    download('xxxxx#master',name,{clone: true},(err) => {
      const meta = {
        name,
        description: answers.description,
        author: answers.author
      }
      const fileName = `${name}/package.json`;
      const content = fs.readFileSync(fileName).toString();
      const result = handlebars.compile(content)(meta);
      fs.writeFileSync(fileName, result);
    })
  })
});

這里使用了 node.js 的文件模塊 fs,將 handlebars 渲染完后的模板重新寫入到文件中。

視覺美化

在用戶輸入答案之后,開始下載模板,這時候使用 ora 來提示用戶正在下載中。

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

// 下載失敗調(diào)用
spinner.fail();

// 下載成功調(diào)用
spinner.succeed();

然后通過 chalk 來為打印信息加上樣式,比如成功信息為綠色,失敗信息為紅色,這樣子會讓用戶更加容易分辨,同時也讓終端的顯示更加的好看。

const chalk = require('chalk');
console.log(chalk.green('項目創(chuàng)建成功'));
console.log(chalk.red('項目創(chuàng)建失敗'));

除了給打印信息加上顏色之外,還可以使用 log-symbols 在信息前面加上 √ 或 × 等的圖標

const chalk = require('chalk');
const symbols = require('log-symbols');
console.log(symbols.success, chalk.green('項目創(chuàng)建成功'));
console.log(symbols.error, chalk.red('項目創(chuàng)建失敗'));

完整示例

#!/usr/bin/env node
const fs = require('fs');
const program = require('commander');
const download = require('download-git-repo');
const handlebars = require('handlebars');
const inquirer = require('inquirer');
const ora = require('ora');
const chalk = require('chalk');
const symbols = require('log-symbols');

program.version('1.0.0', '-v, --version')
  .command('init <name>')
  .action((name) => {
    if(!fs.existsSync(name)){
      inquirer.prompt([
        {
          name: 'description',
          message: '請輸入項目描述'
        },
        {
          name: 'author',
          message: '請輸入作者名稱'
        }
      ]).then((answers) => {
        const spinner = ora('正在下載模板...');
        spinner.start();
        download('http://xxxxxx:9999:HTML5/H5Template#master', name, {clone: true}, (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('項目初始化完成'));
          }
        })
      })
    }else{
      // 錯誤提示項目已存在,避免覆蓋原有項目
      console.log(symbols.error, chalk.red('項目已存在'));
    }
  })
program.parse(process.argv);


效果如下:

完成之后,就可以把腳手架發(fā)布到 npm 上面,通過 -g 進行全局安裝,就可以在自己本機上執(zhí)行 okii init [name] 來初始化項目,這樣便完成了一個簡單的腳手架工具了。

以上就是本文的全部內(nèi)容,希望對大家的學(xué)習(xí)有所幫助,也希望大家多多支持腳本之家。

相關(guān)文章

  • CentOS 安裝NodeJS V8.0.0的方法

    CentOS 安裝NodeJS V8.0.0的方法

    這篇文章主要介紹了CentOS 安裝NodeJS V8.0.0的方法,需要的朋友可以參考下
    2017-06-06
  • linux 后臺運行node服務(wù)指令方法

    linux 后臺運行node服務(wù)指令方法

    今天小編就為大家分享一篇linux 后臺運行node服務(wù)指令方法,具有很好的參考價值,希望對大家有所幫助。一起跟隨小編過來看看吧
    2018-05-05
  • 用NODE.JS中的流編寫工具是要注意的事項

    用NODE.JS中的流編寫工具是要注意的事項

    Nodejs讀寫流流的傳輸過程默認是以buffer的形式傳輸?shù)?除非你給他設(shè)置其他編碼形式, 小伙伴可以參考下。
    2016-03-03
  • 關(guān)于Mac下安裝nodejs、npm和cnpm的教程

    關(guān)于Mac下安裝nodejs、npm和cnpm的教程

    本文通過圖文并茂的形式給大家介紹了Mac下安裝nodejs、npm和cnpm的教程,非常不錯,具有參考借鑒價值,需要的朋友參考下吧
    2018-04-04
  • 使用Node.js配合Nginx實現(xiàn)高負載網(wǎng)絡(luò)

    使用Node.js配合Nginx實現(xiàn)高負載網(wǎng)絡(luò)

    這篇文章主要介紹了使用Node.js配合Nginx實現(xiàn)高負載網(wǎng)絡(luò),Node的異步加上Nginx的反向代理在性能上實在是給力!需要的朋友可以參考下
    2015-06-06
  • node.js中的fs.unlinkSync方法使用說明

    node.js中的fs.unlinkSync方法使用說明

    這篇文章主要介紹了node.js中的fs.unlinkSync方法使用說明,本文介紹了fs.unlinkSync的方法說明、語法、接收參數(shù)、使用實例和實現(xiàn)源碼,需要的朋友可以參考下
    2014-12-12
  • npm安裝依賴報錯ERESOLVE?unable?to?resolve?dependency?tree的解決方法

    npm安裝依賴報錯ERESOLVE?unable?to?resolve?dependency?tree的解決方

    當我們拿到一個前端項目的時候,想要把它運行起來,首先是要給它安裝依賴,下面這篇文章主要給大家介紹了關(guān)于npm安裝依賴報錯ERESOLVE?unable?to?resolve?dependency?tree的解決方法,需要的朋友可以參考下
    2023-04-04
  • node.js中process進程的概念和child_process子進程模塊的使用方法示例

    node.js中process進程的概念和child_process子進程模塊的使用方法示例

    這篇文章主要介紹了node.js中process進程的概念和child_process子進程模塊的使用方法,結(jié)合實例形式分析了node.js中process進程和child_process子進程模塊相關(guān)概念、原理、使用方法及操作注意事項,需要的朋友可以參考下
    2020-02-02
  • node 版本切換的實現(xiàn)

    node 版本切換的實現(xiàn)

    這篇文章主要介紹了node 版本切換的實現(xiàn),文中通過示例代碼介紹的非常詳細,對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧
    2020-02-02
  • Ubuntu 16.04 64位中搭建Node.js開發(fā)環(huán)境教程

    Ubuntu 16.04 64位中搭建Node.js開發(fā)環(huán)境教程

    如果想要在Ubuntu 16.04上安裝Node.js的話,這篇文章對你來說肯定很重要。Node.js從本質(zhì)上來說就是一個運行在服務(wù)端上的封裝好了輸入輸出流的javascript程序。本文給大家詳細介紹了在Ubuntu 16.04 64位搭建Node.js開發(fā)環(huán)境的步驟,有需要的朋友們可以參考學(xué)習(xí)。
    2016-10-10

最新評論