用Node创建命令行工具

2012年8月份,我写了一篇介绍如何用NodeJS构建命令行工具的文章。如今已经过去了2年多的时间,很多东西已经发生了改变,因此,我觉得现在有必要重新写篇文章,介绍我现在是如何创建同样的命令行工具。

我们将要创建同样的工具,即在一个文件夹里根据给定的字符串去搜索文件。这个工具可能不是很有用,但却能让大家很好的了解一些使用NodeJS创建CLI(命令行界面)的基础知识。

创建项目

第一,让我们先创建一个新的项目,在项目目录下执行npm init生成一个package.json文件来初始化项目。有必要的话,可以根据提示输入你想要的内容,你也可以一直敲Enter键来得到一个package.json文件。

配置package.json

NPM(NodeJS的包管理工具)需要根据package.json的配置了解你的项目、项目依赖和如何工作。我们需要做一些修改:

  • 删除入口文件:该配置只是用于那些需要被引用的模块(比如, var _ = require(‘underscore’);)
  • 增加preferGlobal属性,并设为true,该配置意味着如果有人通过NPM安装该模块但没有使用— global选项,那么他将会被提醒该模块是需要全局安装的。
  • 添加bin对象,用于建立命令索引。这意味着,当模块被安装后,NPM会将执行filesearch等效为执行index.js

{
  "name": "filesearch",
  "version": "1.0.0",
  "description": "searches for files",
  "keywords": [
    "file",
    "search"
  ],
  "preferGlobal": true,
  "author": "wagg",
  "license": "ISC",
  "bin": {
    "filesearch": "index.js"
  }
}

创建脚本

新建index.js,并在头部添加一下内容:

#!/usr/bin/env node

console.log('filesearch');

安装脚本

现在你可以在项目下执行npm link命令,就可以在你的系统上安装该脚本。这会从你的项目上创建一个symmlink,然后你就可以执行你的脚本,而不用重新安装。

一旦执行了npm link ,你在就可以在命令行工具里面执行filesearch命令,然后看到以下输出内容:

$ filesearch
filesearch

解析参数

Filesearch需要一个用来作为搜索文件关键字的参数来执行。我们需要获取到这个参数。当在命令行中执行一个JS脚本时,process.argv数组包含了脚本执行时的所有参数。

修改index.js,打印出该数组:

console.log(process.argv);

现在增加一个参数,然后重新执行脚本:

$ filesearch foo
[ 'node', '/Users/ziluo/.nvm/versions/node/v0.12.0/bin/filesearch', 'foo' ]

第一个参数永远都是node,第二个参数是执行脚本的文件路径。后面的所有参数都是执行脚本时传入的参数,而且这些正是我们所需要的。我们可以使用slice方法得到我们需要的参数:

var userArgv = process.argv.slice(2);

var searchPattern = userArgv[0];

现在我们就得到了我们需要的参数。

搜索文件

我们需要结合使用两个Unix命令,lsgrep,来实现文件搜索。我们可以使用ls -a列举出当前目录下所有的文件,然后传递给grep找到我们要搜索的文件。

我们可以通过child_procss模块(Node自带,不需要安装)的exec方法执行系统命令:

var exec = require('child_process').exec;

var child = exec('ls -a | grep ' + searchPattern, function(err, stdout, stderr){
  if(err) throw err;
  console.log(stdout);
});

一起就绪!现在我们执行filesearch,看看结果:

$ filesearch json
package.json

后续

如果这一个需要发布的真是项目,那么在执行npm publish之前,这里有几点需要做的:

  • 保证你的README文档清晰易懂,组织良好
  • 决定你的初始版本号(推荐0.1.0),后续遵循semver规范

一旦发布,用户就可以通过npm install —global filesearch来安装这个模块。

原文地址:http://javascriptplayground.com/blog/2015/03/node-command-line-tool/

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

推荐阅读更多精彩内容