脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 网络编程 → JavaScript → node.js → Node.js开发命令行工具

详解Node.js如何开发命令行工具

 更新时间：2016年08月14日 16:02:28   投稿：daisy  
追求更高的效率是码农不断的追求。选择合适的工具，合理搭配使用，既能提高一部分开发效率，又能改善写代码时的心情。使用Node.js开发命令行工具是开发者应该掌握的一项技能，适当编写命令行工具以提高开发效率。

前言

Node 给前端开发带来了很大的改变，促进了前端开发的自动化，我们可以简化开发工作，然后利用各种工具包生成生产环境。如运行sass src/sass/main.scss dist/css/main.css即可编译 Sass 文件。

在实际的开发过程中，我们可能会有自己的特定需求，

那么我们得学会如何创建一个Node命令行工具。

hello world

老规矩第一个程序为hello world。在工程中新建bin目录，在该目录下创建名为helper的文件，具体内容如下：

#!/usr/bin/env node

console.log('hello world');

修改helper文件的权限：

$ chmod 755 ./bin/helper

执行helper文件，终端将会显示hello world：

$ ./bin/helper
hello world

符号链接

接下来我们创建一个符号链接，在全局的node_modules目录之中，生成一个符号链接，指向模块的本地目录，使我们可以直接使用helper命令。

在工程的package.json文件中添加bin字段：

{
 "name": "helper",
 "bin": {
 "helper": "bin/helper"
 }
}

在当前工程目录下执行npm link命令，为当前模块创建一个符号链接：

$ npm link

/node_path/bin/helper -> /node_path/lib/node_modules/myModule/bin/helper
/node_path/lib/node_modules/myModule -> /Users/ipluser/myModule

现在我们可以直接使用helper命令：

$ helper
hello world

commander模块

为了更高效的编写命令行工具，我们使用TJ大神的commander模块。

$ npm install --save commander

helper文件内容修改为：

#!/usr/bin/env node

var program = require('commander');

program
 .version('1.0.0')
 .parse(process.argv);

执行helper -h和helper -V命令：

$ helper -h

 Usage: helper [options]

 Options:

 -h, --help  output usage information
 -V, --version output the version number

$ helper -V
1.0.0

commander模块提供-h, --help和-V, --version两个内置命令。

创建命令

创建一个helper hello <author>的命令，当用户输入helper hello ipluser时，终端显示hello ipluser。修改helper文件内容：

#!/usr/bin/env node

var program = require('commander');

program
 .version('1.0.0')
 .usage('<command> [options]')
 .command('hello', 'hello the author') // 添加hello命令
 .parse(process.argv);

在bin目录下新建helper-hello文件：

#!/usr/bin/env node

console.log('hello author');

执行helper hello命令：

$ helper hello ipluser
hello author

解析输入信息

我们希望author是由用户输入的，终端应该显示为hello ipluser。修改helper-hello文件内容，解析用户输入信息：

#!/usr/bin/env node

var program = require('commander');

program.parse(process.argv);

const author = program.args[0];

console.log('hello', author);

再执行helper hello ipluser命令：

$ helper hello ipluser
hello ipluser

哦耶，终于达到完成了，但作为程序员，这还远远不够。当用户没有输入author时，我们希望终端能提醒用户输入信息。

提示信息

在helper-hello文件中添加提示信息：

#!/usr/bin/env node

var program = require('commander');

program.usage('<author>');

// 用户输入`helper hello -h`或`helper hello --helper`时，显示命令使用例子
program.on('--help', function() {
 console.log(' Examples:');
 console.log(' $ helper hello ipluser');
 console.log();
});

program.parse(process.argv);
(program.args.length < 1) && program.help(); // 用户没有输入信息时，调用`help`方法显示帮助信息

const author = program.args[0];

console.log('hello', author);

执行helper hello或helper hello -h命令，终端将会显示帮助信息：

$ helper hello

 Usage: helper-hello <author>

 Options:

 -h, --help output usage information

 Examples:
 $ helper hello ipluser

$ helper hello -h

 Usage: helper-hello <author>

 Options:

 -h, --help output usage information

 Examples:
 $ helper hello ipluser

总结

到此我们编写了一个helper命令行工具，并且具有helper hello <author>命令。刚兴趣的朋友们快快自己动手实践起来，只有自己做了才能算真正的学习了，希望本文对大家能有所帮助。

您可能感兴趣的文章:

相关文章

  • 一文详解NPM如何换源

    一文详解NPM如何换源

    在每一次的实际开发过程中我们都会下载相关的依赖包,最官方的是 npm,但是该服务器对于国内开发者来说,下载起来是比较慢的,所以我们需要换源,下面这篇文章主要给大家介绍了关于NPM如何换源的相关资料,需要的朋友可以参考下
    2023-02-02
  • 总结Node.js中的一些错误类型

    总结Node.js中的一些错误类型

    NodeJS 的错误处理让人痛苦，在很长的一段时间里，大量的错误被放任不管。但是要想建立一个健壮的 Node.js 程序就必须正确的处理这些错误，而且这并不难学。下面跟着小编一起来学习学习。
    2016-08-08
  • NodeJS使用递归算法和遍历算法来遍历目录的方法

    NodeJS使用递归算法和遍历算法来遍历目录的方法

    遍历目录是操作文件时的一个常见需求,比如写一个程序,需要找到并处理指定目录下的所有JS文件时,就需要遍历整个目录,NodeJS遍历目录可以使用递归算法、遍历算法,遍历算法又分为同步遍历、异步遍历两种,本文介绍NodeJS使用递归算法和遍历算法来遍历目录的方法
    2023-11-11
  • 基于Node.js实现nodemailer邮件发送

    基于Node.js实现nodemailer邮件发送

    Nodemailer 是一个简单易用的 Node.JS 邮件发送模块（通过 SMTP，sendmail，或者 Amazon SES），支持 unicode，你可以使用任何你喜欢的字符集。Nodemailer是一个简单易用的Node.js邮件发送组件，需要的朋友可以参考下
    2016-01-01
  • kafka调试中遇到Connection to node -1 could not be established. Broker may not be available.

    kafka调试中遇到Connection to node -1 could not be established. Br

    这篇文章主要介绍了kafka调试中遇到Connection to node -1 could not be established. Broker may not be available的解决方法，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
    2019-09-09
  • npm报错"A complete log of this run can be found in:"的解决办法

    npm报错"A complete log of this run can be found 

    这篇文章主要给大家介绍了关于npm报错"A complete log of this run can be found in:"的解决办法,文中通过实例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2023-04-04
  • node.js中的fs.utimesSync方法使用说明

    node.js中的fs.utimesSync方法使用说明

    这篇文章主要介绍了node.js中的fs.utimesSync方法使用说明,本文介绍了fs.utimesSync的方法说明、语法、接收参数、使用实例和实现源码,需要的朋友可以参考下
    2014-12-12
  • Nodejs如何进行性能监控和分析优化

    Nodejs如何进行性能监控和分析优化

    Node.js应用可能因为高并发、内存泄漏、CPU密集型任务等原因导致性能下降,影响用户体验甚至系统稳定性,通过性能监控和分析,我们可以及时发现潜在问题,并针对性地进行优化,确保系统正常运行且具备良好的性能表现
    2024-06-06
  • Node.js实现的简易网页抓取功能示例

    Node.js实现的简易网页抓取功能示例

    这篇文章主要介绍了Node.js实现的简易网页抓取功能示例,本文使用了PhantomJS、node-phantomjs等库实现,需要的朋友可以参考下
    2014-12-12
  • 在Node.js中判定文件是否可执行的方法详解

    在Node.js中判定文件是否可执行的方法详解

    在进行前端开发时,经常需要处理各种文件权限的问题,特别是在Node.js环境中,你可能想要判断某个文件是否具有可执行权限,本文将详细介绍如何使用isexe模块来进行这一操作,需要的朋友可以参考下
    2024-05-05

最新评论