用Node创建命令行工具

2015-03-22  本文已影响0人  Glickr

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

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

创建项目

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

配置package.json

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


{
  "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之前,这里有几点需要做的:

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

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

上一篇 下一篇

猜你喜欢

热点阅读