10行Node代码开发一个命令行字典

开发命令行原理

看似很神奇的功能,其实本质十分简单。

#!/usr/bin/env node
这句话,告诉了 *nix 系统,当前文件,应该使用什么工具/软件来执行

而这,就是 node 开发命令行工具的原理。也是其它语言开发命令行工具的原理,可以对比于 windows 下的 bat 文件。

基础知识

既然讲到基础,那就尽可能使用原生的语言、不引用多余模块的方式进行开发。

Node 命令行工具开发中,最重(常)要的代码/原生语句就是

  1. process 系列:
process.argv;
process.on(single, callback);
process.exit(0);

其中, process.argv 用于获取敲击命令时,传入的参数;
process.exit() 用来退出程序,0 表示正常退出;process.on() 用来监听、接收系统传过来的信号(一般使用 kill -s 来传递 SINGLE 信号)

  1. node 系列:

这个系列的比较多。在使用 process 获取到输入的参数,node 就可以根据这些参数去做一些想做的事了。

如果操作完后,想操作文件,保存、修改、上传什么的,那就要用到其它模块了。这里也给 Node 的模块参考。比如: pathfsrequest等了。

生成可执行命令

  1. 写好的文件,在 *nix 系统中,是只有读写操作的。需要更改文件的可执行属性。
chmod 755 targetFile
  1. 修改属性后的文件,具有了可以被执行的能力。在文件所在的目录下,敲入
./targetFile [arg1 arg2 ...]

即可执行. arg* 为你想传入的参数。

  1. 这个时候,使用起来并不方便。我们可以使用 npm link 将当前文件软链接至全局对象下.
{
    "name": '你的工具名',
    "bin": {
        "myCommand": targetFile
    }
}

其中 myCommand 是你要在全局中使用该工具的名字。比如,你想输入 doSomething 来运行你写的工具。targetFile 指的是你写的文件名。即包含 #!/usr/bin/env node 语句的文件。

简单 Demo

以做一个命令行版本的翻译工具为例。

  1. 创建文件夹 /translate/
mkdir translate
  1. 打开文件夹。这里默认使用的是 vscode
code ./translate/
  1. 编写 index.js
#!/usr/bin/env node
'use strict';
let q = require('request');

let word = process.argv[2] || 'try once';
q.get('http://fanyi.youdao.com/openapi.do?keyfrom=node-translator&key=2058911035&type=data&doctype=json&version=1.1&q=' + word, function(error, res, body){
    console.log('get the ', word, " is: ", JSON.parse(body).translation);
});

这里使用了网易的 API。参考,并引用了 正凯 的博文。由于现在申请 AI youdao 比以前麻烦很多,故直接使用了 正凯 的接口,大家用作参考即可,正式使用。

  1. 修改 index.js 的属性
chmod 755 index.js
  1. 编写 package.json 文件。在同目录下,编写
{
    "name": "clchenliang de fanyi",
    "bin": {
        "see": "index.js"
    }
}
  1. 生成软链,全局使用。在当前目录下,输入:
npm link

测试

在我自己的机子上,进行测试。任意目录下,输入

see awesome

如下图:


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

推荐阅读更多精彩内容

  • 系统管理与维护命令 date date(选项)(参数) | 选项 | 说明 | | :-------- | ...
    蓓蓓的万能男友阅读 3,859评论 0 5
  • 一、Python简介和环境搭建以及pip的安装 4课时实验课主要内容 【Python简介】: Python 是一个...
    _小老虎_阅读 5,713评论 0 10
  • linux资料总章2.1 1.0写的不好抱歉 但是2.0已经改了很多 但是错误还是无法避免 以后资料会慢慢更新 大...
    数据革命阅读 12,127评论 2 34
  • 近日,思念渐涨,我的思绪有些不知道怎么控制,有点凌乱。 我不能忘记他,那我便也不逼你,但你可以慢慢地去安排自己喜欢...
    植物我爱的生命阅读 191评论 0 0
  • 身边有一个年轻的小朋友,最近有点焦虑。他即将大学毕业,马上要踏入社会。他的焦虑在于,他未来想立足的城市,房价高...
    萌萌君阅读 261评论 1 0