十分鐘通過 NPM 建立一個命令列工具

$ mkdir create-file-cli
$ cd create-file-cli
$ npm init -y

{
"name": "create-file-cli",
"version": "1.0.0",
"description": "",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"bin": {
"touchme": "bin/touchme.js"
},
"keywords": [],
"author": "",
"license": "ISC"
}

bin/touchme.js 如下

#!/usr/bin/env node

const program = require('commander');
const gen = require('../lib/generate-file');

program
// 版本資訊
.version('0.0.4', '-v, --version')
// 用法說明
.usage('<file ...> [options]')
// 選擇名 選項描述 預設值
// 選項 可以帶有一個引數 可以通過 program.copy 獲取該選項資訊
// 如果沒有引數 該值為 true
.option('-c, --copy <source>', 'copy file and add comment')
.option('-H, --hashtag', `comment by '#'`)
.option('-s, --slash', `comment by '/'`)
.parse(process.argv);

function resolve(program) {
// 沒有匹配任何選項的引數會被放到陣列 args 中
const { copy, hashtag, slash, args } = program;
if (!args.length) {
console.log('Please input filename.');
return;
}
if (copy === true) {
console.log('You should copy at least one file.');
return;
}
let type = 'star';
if (slash) type = 'slash';
if (hashtag) type = 'hashtag';
for (let i = 0; i < args.length; i++) {
gen(args[i], copy, type);
}
}

resolve(program);

具體 lib/generate-file.js 實現見 https://github.com/G-lory/create-file-cli/ 就是簡單的建立一個檔案並寫入註釋。

通過 option 定義命令選項並可定義引數。

通過 program 可以獲取命令列輸入的引數資訊。

現在功能寫完了，剩下的事情就是釋出了。首先要到 https://www.npmjs.com 查詢一下自己的包名有沒有人已經發布了，如果有的話，你需要先修改包名。然後在 https://www.npmjs.com 註冊一個賬號。記住自己的賬號密碼和郵箱後，回到命令列。

$ npm login
Username: ...
Password: 
Email: (this IS public)
Logged in as ... on https://registry.npmjs.org/.

注意登入成功後顯示的是 https://registry.npmjs.org/ 很多同學設定了淘寶的映象，顯示的就不是這個地址，那麼釋出之前要改回來。