写一个命令行工具

hello world

mkdir slb
cd slb
npm init
touch cli.js

命令行文件指定脚本使用的解析器

#!/usr/bin/env node
console.log("hello world")

package.json 中的字段 bin 表示的是一个可执行文件到指定文件源的映射。bin 的配置有两种,一种字符串配置是将命令指定为包名,
第二种是对象配置的方式可以指定命令名称并且配置多个

// 字符串配置
{
  "name": "slb"
  "bin": "cli.js"
}
// 对象配置
{
  "bin": {
    "slb1": "cli1.js"
    "slb2": "cli2.js"
  },
}

开发调试,全局安装的 cli 包,是可以全局调用 cli 命令的,比如webpack, vue-cli,我们开发环境调试可以通过在项目目录下npm link创建链接或者全局安装npm i -g .,这样我们就可以在全局下使用我们项目配置的命令了

全局安装@vue/cli 的话,@vue/cli 源文件会被安装在全局源文件安装目录(/user/local/lib/node_modules)下,而 npm 会在全局可执行 bin 文件安装目录(/usr/local/bin)下创建一个指向/usr/local/lib/node_modules/@vue/cli/bin/vue.js 文件的名为 vue 的软链接,这样就可以直接在终端输入 vue 来执行相关命令。

如果局部安装@vue/cli 的话,npm 则会在本地项目./node_modules/.bin 目录下创建一个指向./node_moudles/@vue/cli/bin/vue.js 名为 vue 的软链接,这个时候需要在终端中输入./node_modules/.bin/vue 来执行(也可以使用 npx vue 命令来执行,npx 的作用就是为了方便调用项目内部安装的模块)。

npm install 安装依赖时,会将指定脚本解析器安装在node_modules/.bin

命令行介绍

参数传递, 通过process.argv查看命令行参数

slb run dev
slb -v --version
slb test --mode=env

可以看到通过 argv 其实就是通过空格分隔了字段,自己处理参数还是有太多东西需要处理

参数处理

命令行开发工具, 开源的有比较成熟的依赖包,如yargs, meow, commander,下面介绍两种

var yargs = require("yargs");

console.log("hello ", yargs.argv);
  • meow
    封装简单,不支持自动生成 help 信息
    flags:
    command:
// 查看cli返回

依赖包和使用

命令行工具是通过 node 的能力,所以能做的事情非常多,下面简单的介绍下实际操作中会用到的一些依赖包和几个简单的功能(其实都是 node 的能力)

  1. chalk: 样式修改
  2. inquirer:交互输入
  3. execa:执行其他的命令
  4. 文件复制

其他

相关依赖:

  1. 输入交互: inquirer、 enquirer 、prompts
  2. 输出美化: chalk、ora、 kleur、ink、figlet
  3. 参数解析: meow, yargs, commander
  4. 命令执行: execa, shelljs

参考

  1. 手把手教你写命令行工具
  2. Build a Command Line Application with Node.js
  3. Node 命令行前端自动构建发布系统
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 202,529评论 5 475
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,015评论 2 379
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 149,409评论 0 335
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,385评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,387评论 5 364
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,466评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,880评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,528评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,727评论 1 295
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,528评论 2 319
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,602评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,302评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,873评论 3 306
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,890评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,132评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,777评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,310评论 2 342

推荐阅读更多精彩内容