node-npm發布包-package.json中bin的用法

前言

用過angular-cli，create-react-app這些腳手架的朋友們，不知道你們有沒有好奇過，
為什么安裝這些腳手架后，可以使用類似ng generate之類的命令。小弟研究了以下，原來是這樣的。

package.json

貼一個簡單的package.json

{
  "name": "arashiquan33-node-learn",
  "version": "1.1.0",
  "description": "learn node.js",
  "main": "module.js",  //包的入口文件
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": [
    "node",
    "express"
  ],
  "author": "arashiquan33",
  "license": "ISC"
}

接下來我們也給這個包制作一個命令，叫q-cli。

1. 新建bin文件夾，創建q-cli.js

#!/usr/bin/env node
function run (argv) {
    if (argv[0] === '-v' || argv[0] === '--version') {
        console.log('  version is 0.0.1');
    } else if (argv[0] === '-h' || argv[0] === '--help') {
        console.log('  usage:\n');
        console.log('  -v --version [show version]');
    }
}
run(process.argv.slice(2));

#!/usr/bin/env node 這段話的意思是讓使用 node 進行腳本的解釋程序，那下面的就可以使用 node 的語法了

process.argv.slice(2)，//從進程中獲取參數

好了，上面這段腳本當被加載執行的時候，會首先執行run方法，並且傳入進程輸入的參數。

添加bin

好了，現在我們把bin需要的可執行js文件已經創建好，接下來需要在package.json中描述進去.

{
  "name": "arashiquan33-node-learn",
  "version": "1.1.0",
  "description": "learn node.js",
  "main": "module.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "bin": {
    "q-cli": "./bin/q-cli.js"  //告訴package.json,我的bin叫q-cli,它可執行的文件路徑是bin/q-cli.js
  },
  "keywords": [
    "node",
    "express"
  ],
  "author": "arashiquan33",
  "license": "ISC"
}

好了，現在換差最后一步我們就可以再命令行使用q-cli.

打成全局包

必須要打成全局包才可以使用該命令,打成全局包的命令
npm install . -g
或者
npm link

 

 

好了，現在可以再命令行輸入q-cli,