Node.js 命令行工具库:js-fire

前言

来啦老铁!

还记得之前 Python 下学过一个好用的模块 Fire,关于 Fire 模块的简介是:

  • Python Fire 是 Google 开源的一个可从任何 Python 代码自动生成命令行接口(CLI)的库。

对 Fire 模块的介绍有兴趣的小伙伴可以移步至:Python 命令行工具库:Fire

而笔者平时工作用的语言是 typescript,或者也可以说是 Node.js,过去想要在脚本中访问命令行中的参数,往往使用环境变量的方式,如访问命令行中 export 的 SITE_ENV 环境参数,则使用:

process.env.SITE_ENV

这种方式比较笨重,而且可能不同操作系统可能会遇到奇葩问题,如环境变量大小写等问题。

由于某些机缘巧合,需要使用类似于 Python 的 Fire 模块的功能,因此经过摸索后,发现这样一个模块:

  • js-fire 模块

js-fire 模块可以实现与 Python Fire 模块一样的效果!npm 地址:https://www.npmjs.com/package/js-fire

学习路径

  1. 安装 js-fire 模块;
  2. 使用 js-fire 进行编程;
  3. 使用命令行接口;
  4. js-fire 彩蛋;

1. 安装 js-fire 模块;

  • 在项目内执行以下命令:
npm install js-fire --save-dev

2. 使用 js-fire 进行编程;

  • 我们直接使用官方的例子进行学习即可(假设我们的 js 文件叫 demo.js):
const fire = require('js-fire');

const calculator = {
    __description__: 'I am a math machine',
    double: number => {
        // I double things
        return 2 * number
    },
    add: (n1 = Math.PI, n2) => {
        return n1 + n2
    },
    misc: {
        year: () => '1999',
        brand: () => 'casio',
        hello: name => `hello ${name}`,
    },
}

fire(calculator);
  • 简要说下,我们声明了 double 方法、add 方法、misc 方法组,misc 方法组内有 year 方法、brand 方法、hello 方法;

3. 使用命令行接口;

1). 使用 double 方法:

node demo.js double --number=2

执行结果如下:

double 方法

2). 使用 add 方法:

node demo.js add --n1=2 --n2=3

执行结果如下:


add 方法

n1 有默认值为 Math.PI,因此也可以使用其默认值,如:

node demo.js add --n2=3

此时,执行结果如下:

add 方法,参数默认值

3). 使用 misc 方法组内的方法:

node demo.js misc year

执行结果如下:

misc year
node demo.js misc brand

执行结果如下:

misc brand
node demo.js misc hello --name=dylan

执行结果如下:

misc hello
由此可见,我们用 js-fire 模块实现了类似于 Python Fire 模块的自动生成命令行接口(CLI)的功能,这样的功能很优雅、灵活~

4. js-fire 彩蛋;

有趣的是,js-fire 还为我们准备了一个彩蛋,即:

  • js-fire 可以直接在命令行直接使用大多数 js 模块,例如,我们使用非常常见的 fs 模块中的 writeFileSync 方法,创建一个 hello.txt 文件,并向 hello.txt 文件写入 hiii 字符串,则不需要任何 js 代码,可以直接用 js-fire 模块完成:
npx js-fire fs -- writeFileSync --path=hello.txt --data="hiii"

执行后效果如下:

彩蛋

当然,当我们不知道一个模块有什么方法可以用时,还可以用这样的方式去查询:

npx js-fire fs -- -h
help

当看到这个功能,我情不自禁的说:哇~

不用一行 js 代码,就能使用简单的模块去完成一些相对简单的任务,有点香啊~

能力有限,欢迎指正、互相交流,感谢~

如果本文对您有帮助,麻烦点赞、关注!

感谢~

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

推荐阅读更多精彩内容