快捷導(dǎo)航

node通過(guò)npm寫一個(gè)cli命令行工具

更新時(shí)間：2017年10月12日 14:13:04 作者：不止前端

本篇文章主要介紹了node通過(guò)npm寫一個(gè)cli命令行工具，小編覺(jué)得挺不錯(cuò)的，現(xiàn)在分享給大家，也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧

前言

如果你想寫一個(gè)npm插件，如果你想通過(guò)命令行來(lái)簡(jiǎn)化自己的操作，如果你也是個(gè)懶惰的人，那么這篇文章值得一看。

po主的上一篇文章介紹了定制自己的模版，但這樣po主還是不滿足啊，項(xiàng)目中我們頻繁的需要新建一些頁(yè)面，邏輯樣式等文件，每次都手動(dòng)new一個(gè)，然后復(fù)制一些基本代碼進(jìn)去非常的麻煩，所以就有了這篇文章。接下來(lái)就讓po主為大家一步一步演示怎么做一個(gè)npm命令行插件。

注冊(cè)npm賬戶

發(fā)布npm插件，首先肯定要有個(gè)npm帳號(hào)了，過(guò)程就不啰嗦了，走你。

npm官網(wǎng)

有了賬號(hào)后，我們通過(guò)npm init 生成一個(gè)package配置文件，填寫一些你的信息，然后就可以開(kāi)始寫邏輯代碼了。

編寫命令入口

首先看一下項(xiàng)目結(jié)構(gòu)

.
├── bin      //命令配置
├── README.md   //說(shuō)明文檔
├── index.js   //主入口
├── src      //功能文件
├── package.json //包信息
└── test     //測(cè)試用例

實(shí)例命令代碼都是寫在bin目錄下，我們現(xiàn)在配置文件package文件中啟用命令,添加一個(gè)配置項(xiàng)bin

 "bin": {
    "xu": "./bin/xu.js"
  },

然后安裝一個(gè)依賴，TJ大神寫的commander插件，

npm i commander --save

有了這個(gè)工具我們可以很方便的編寫命令代碼

xu.js

#!/usr/bin/env node

process.title = 'xu';

require('commander')
.version(require('../package').version)
.usage('<command> [options]')
.command('generate', 'generate file from a template (short-cut alias: "g")')
.parse(process.argv)


require('./xu-generate');  >>引入

這個(gè)文件可以看作是入口文件，第一行代碼是必須添加的，腳本用env啟動(dòng)的原因，是因?yàn)槟_本解釋器在linux中可能被安裝于不同的目錄，env可以在系統(tǒng)的PATH目錄中查找。同時(shí)，env還規(guī)定一些系統(tǒng)環(huán)境變量。這種寫法主要是為了讓你的程序在不同的系統(tǒng)上都能適用。

在這一步，你可以簡(jiǎn)單測(cè)試你自己的npm插件

$ node ./bin/xu.js

>>> 輸出一些插件usage。help信息

關(guān)于commander，大家可以去作者的Github先學(xué)習(xí)了解，這里不對(duì)參數(shù)講解。

xu-generate.js

#!/usr/bin/env node

const program = require('commander');
const chalk = require('chalk')
const xu = require('../src/generate');


/**
 * Usage.
 */

program
.command('generate')
.description('quick generate your file')
.alias('g')
.action(function(type, name){
  xu.run(type, name);
});
program.parse(process.argv);

這就是功能命令，定義了一個(gè)generate命令，.alias('g')是該命令的縮寫，然后.action(function(type, name){xu.run(type, name); });返回一個(gè)函數(shù)，這個(gè)函數(shù)就是我們定義這個(gè)命令需要做什么事。

編寫功能函數(shù)

./src/generate.js

這個(gè)文件就定義了當(dāng)我們輸入

$ xu g

所做的操作了。

/**
 * Created by xushaoping on 17/10/11.
 */

const fs = require('fs-extra')
const chalk = require('chalk')
exports.run = function(type, name) {
  switch (type) {
    case 'page':
      const pageFile = './src/page/' + name + '/' + name + '.vue'
      const styleFile = './src/page/' + name + '/' + name + '.less'
      fs.pathExists(pageFile, (err, exists) => {
        if (exists) {
          console.log('this file has created')
        } else {
          fs.copy('/usr/local/lib/node_modules/vue-xu-generate/src/template/page.vue', pageFile, err => {
            if (err) return console.error(err)
        
            console.log(pageFile + ' has created')
          })
          fs.copy('/usr/local/lib/node_modules/vue-xu-generate/src/template/page.less', styleFile, err => {
            if (err) return console.error(err)
        
            console.log(styleFile + ' has created')
          })
        }
      })
      break;
    case 'component':
      const componentFile = './src/components/' + name + '.vue'
      fs.pathExists(componentFile, (err, exists) => {
        if (exists) {
          console.log('this file has created')
        } else {
          fs.copy('/usr/local/lib/node_modules/vue-xu-generate/src/template/component.vue', componentFile, err => {
            if (err) return console.error(err)
          
            console.log(componentFile + ' has created')
          })
        }
      })
      break;
    case 'store':
      const storeFile = './src/store/modules' + name + '.js'
      fs.pathExists(storeFile, (err, exists) => {
        if (exists) {
          console.log('this file has created')
        } else {
          fs.copy('/usr/local/lib/node_modules/vue-xu-generate/src/template/store.js', storeFile, err => {
            if (err) return console.error(err)
          
            console.log(storeFile + ' has created')
          })
        }
      })
      break;
    default:
      console.log(chalk.red(`ERROR: uncaught type , you should input like $ xu g page demo` ))
      console.log()
      console.log(' Examples:')
      console.log()
      console.log(chalk.gray('  # create a new page'))
      console.log('  $ xu g page product')
      console.log()
      console.log(chalk.gray('  # create a new component'))
      console.log('  $ xu g component product')
      console.log()
      console.log(chalk.gray('  # create a new store'))
      console.log('  $ xu g store product')
      console.log()
      break;
  }
};

這里有2個(gè)新的依賴，分別是命令輸出顏色和一個(gè)文件操作的插件,通過(guò)npm安裝。

$ npm i fs-extra --save

$ npm i chalk --save

這個(gè)js文件導(dǎo)出了一個(gè)run函數(shù)給 xu-generate.js調(diào)用，我們通過(guò)參數(shù)拿到了用戶輸入的type，name，然后就可以根據(jù)type通過(guò)node fs模塊（這里用了一個(gè)依賴，不過(guò)原理還是fs）操作把template文件復(fù)制了一份到你的項(xiàng)目中。

到這，我們就已經(jīng)完成了一個(gè)命令的開(kāi)發(fā)，這個(gè)命令可以快速生成項(xiàng)目的模版文件。

本地測(cè)試

npm包開(kāi)發(fā)不像web開(kāi)發(fā)，可以直接在瀏覽器看，實(shí)例目錄下建立一個(gè)test文件，再 node test 就可以測(cè)試我們的邏輯。如果有一些功能需要在發(fā)布后才能測(cè)，npm 有個(gè) link命令可以連接你本地的模塊，當(dāng)然你也可以發(fā)布后自己安裝插件測(cè)試，就跟平時(shí)引入一個(gè)插件一樣。

發(fā)布npm包

首先在項(xiàng)目根目錄執(zhí)行npm登陸

$ npm login 

$ npm publish

如果這里有個(gè)報(bào)錯(cuò)，可能是你使用了cnpm地址，需要把npm倉(cāng)庫(kù)設(shè)置回來(lái)

 $ npm config set registry https://registry.npmjs.org/

然后，更新更新npm包，版本號(hào)需要大于上一次

后記

至此，一個(gè)入門級(jí)的npm包就制作完成了。萬(wàn)分感慨，記得剛?cè)腴T前端的時(shí)候看到別人的插件做的真牛，自己只要簡(jiǎn)單安裝一下就能搞得那么漂亮，想搞～但是看到一堆陌生的東西，立刻慫了（node環(huán)境，東西非常非常多，直接拷個(gè)vue-cli看到一對(duì)代碼，一頭霧水。。。大牛請(qǐng)無(wú)視）

學(xué)習(xí)是一個(gè)循序漸進(jìn)的過(guò)程，大牛寫出來(lái)的東西，沒(méi)有一定的基礎(chǔ)，和長(zhǎng)時(shí)間的積累經(jīng)驗(yàn)，源碼是很難學(xué)習(xí)。非要啃，也行，只是效率感覺(jué)不如循序漸進(jìn)來(lái)的好。

插件已經(jīng)發(fā)布，Github也有完整源碼，想學(xué)習(xí)的同學(xué)可以fork一個(gè)自己玩玩，干這一行～隨心所動(dòng) ，跟著興趣走，準(zhǔn)沒(méi)錯(cuò)

傳送門： npm地址

傳送門：github源碼

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

您可能感興趣的文章: