devbox
Cpp五条
这个屌丝很懒，什么也没留下！
关注作者
热门标签
热门文章
当前位置:   article > 正文

Nodejs 制作命令行工具

作者：Cpp五条 | 2024-04-10 16:13:55

赞

踩

Nodejs 制作命令行工具

wcj

   

github仓库源码下载

这不仅是一篇教程，还是通过命令行输出我自己简历的一个工具O(∩_∩)O哈哈哈~，很有趣的样子哦。

  1. # 全局安装，安装报错是需要前面加上sudo
  2. $ sudo npm install -g wcj 
  3.  
  4. # 输出帮助
  5. $ wcj -h
  6.   Usage: wcj 这里是我私人玩耍的命令哦！[options] <package>
  7.  
  8.  
  9.   Commands:
  10.  
  11.     resume|rs [options] [cmd]    这里是我的简历详情！
  12.  
  13.   Options:
  14.  
  15.     -h, --help     output usage information
  16.     -V, --version  output the version number
  17.  
  18. # 输出子命令帮助
  19. $ wcj rs -h
  20.  
  21.   Usage: resume|rs [options] [cmd]
  22.  
  23.     这里是我的简历详情！
  24.  
  25.   Options:
  26.  
  27.     -h, --help              output usage information
  28.     -b, --basicinfo [type]  基本信息
  29.     -e, --education [type]  教育经历
  30.  
  31.   basicinfo 说明:
  32.  
  33.     preview 预览简历
  34.  
  35.     -b, --basicinfo 基本信息
  36.        name : 名字
  37.        height : 身高
  38.        dateOfBirth : 出生日期
  39.        workExperience : 工作经验
  40.        mobile : 手机号码
  41.        telephone : 电话号码
  42.        email : 邮箱地址
  43.        residency : 居住地点
  44.        currentSituation : 现状
  45.        currentCity : 当前城市
  46.        nation : 国家
  47.        region : 地区
  48.        postalCode : 邮编地址
  49.        ID : 身份证ID
  50.        website : 个人网赚
  51.        maritalStatus : 婚姻状况
  52.        politicalStatus : 政治面貌
  53.     -e, --education 教育经历

在使用 Nodejs 过程中，有很多包都支持全局安装，提供一个命令，然后在命令行我们就可以完成一些任务。有时候我们也需要开发这样的命令工具。在Node.js 中发现弄个命令行工具特别轻松，我来学习如何使用 Node.js 生成自己的command命令，在未来的项目中方便自己。

  • 先弄个小实例感受一下命令行的魅力

  • 再用命令行实现输出自己的简历（我觉得这个可能很有趣）

  • 常用的命令加入进来

    • ls 查看当前目录

    • ls -a 包括隐藏文件

    • 打开当前目录

  • 就先这么计划着吧。

小实例

开始编写之前需要确认的一件事情是你已经安装了Node.js。你可以在命令行中运行 which node 来确认是否已经安装，或者运行 node -v 查看 node 的版本 。如果你已经安装了node，你可以看到类似于下面的输出结果，一般情况安装了node.js 顺带npm工具自动安装了。

  1. $ which node
  2. /usr/local/bin/node  
  3.  
  4. $ node -v
  5. v0.10.36

创建目录

首先任意创建一个文件夹，初始化 package.json 文件，在该文件夹下创建bin目录：

  1. $ mkdir wcj #创建一个文件夹
  2. $ cd wcj && mkdir bin
  3. $ npm init #初始化 `package.json` 文件

编写命令行

cd到 bin 目录下，新建一个 wcj.js 文件(名字自取)，编写如下代码，在js文件顶部加上 #!/usr/bin/env node 这段代码：

  1. #!/usr/bin/env node  
  2. var fs = require("fs"),
  3.     path = process.cwd();
  4.  
  5. var run= function (obj) {
  6.     if(obj[0] === '-v'){
  7.         console.log('version is 1.0.0');
  8.     }else if(obj[0] === '-h'){
  9.         console.log('Useage:');
  10.         console.log('  -v --version [show version]');
  11.     }else{
  12.         fs.readdir(path, function(err, files){
  13.             if(err){
  14.                 return console.log(err);
  15.             }
  16.             for(var i = 0; i < files.length; i += 1){
  17.                 console.log(files[i]);
  18.             }
  19.         });
  20.     }
  21. };
  22. //获取除第一个命令以后的参数，使用空格拆分
  23. run(process.argv.slice(2));

上面的 #!/usr/bin/env node 被成为 shebang ，表示用后面的路径所示的程序来执行当前文件夹。还需要一个 package.json 文件

  1. {
  2.   "name": "wcj",
  3.   "version": "1.0.0",
  4.   "description": "wcj ---",
  5.   "repository": {
  6.     "type": "git",
  7.     "url": "https://github.com/jaywcjlove/wcj.git"
  8.   },
  9.   "main": "index.js",
  10.   "bin": { "wcj": "bin/wcj.js" },
  11.   "author": "kenny wang <wowohoo@qq.com> ",
  12.   "license": "MIT"
  13. }

运行 node bin/wcj.js 会显示当前文件夹下的所以文件和文件夹名。这个玩意儿真的跑起来了。更多npm link的信息请查看

package.json 文件中 bin 里面的内容表示这个字段将 wcj 命令映射到了你的 bin/wcj.js 脚本。bin参考

此工具采用 npm版本号采用的 semver 规则

"bin": { "wcj": "bin/wcj.js" }

列子源码

全局运行命令调试

确保你在 package.json 文件中添加了 bin 节点。然后打开命令了工具进入 wcj 目录

install

如果在项目目录下运行没有问题，可以将当前目录模块安装到全局，也可以采用此方法来更新你的命令行工具

sudo npm install . -g

link

或者目录输入 npm link 会自动添加全局的 symbolic link ，然后就可以使用自己的命令了。

  1. $ wcj
  2. #README.md
  3. #bin
  4. #package.json
  5.  
  6. $ cmd -v
  7. # version is 1.0.0
  8.  
  9. $ cmd -h 
  10. #Useage:
  11. #  -v --version [show version]

错误处理

在运行 sudo npm install . -g 会有一堆警告可以忽视

如果你已经 npm link 搞了一遍你再 link 一遍，会报如下错误。即使你 npm unlink 也会报如下错误：

  1. npm link
  2. npm ERR! Darwin 14.3.0
  3. npm ERR! argv "node" "/usr/local/bin/npm" "link"
  4. npm ERR! node v0.10.36
  5. npm ERR! npm  v2.7.1
  6. npm ERR! path /usr/local/bin/wcj
  7. npm ERR! code EEXIST
  8.  
  9. npm ERR! Refusing to delete: /usr/local/bin/wcj not in /Applications/XAMPP/xamppfiles/htdocs/git/github.com/myJS/wcj
  10. File exists: /usr/local/bin/wcj
  11. Move it away, and try again.

让你删除 /usr/local/bin/wcj 再 npm link ， 删除此目录运行 rm -rf /usr/local/bin/wcj

发布安装

发布到npm中

发布必须注册 npm 账号，还有 github 账号，具体怎么玩儿问 谷歌大婶吧。在JSLite.io 中也有教程哦。

npm publish

安装

前提你发布到了npm中，你就可以运行下面的命令了。

sudo npm install -g wcj

例子下载：v1.0.1

Commander

依赖 nodejs 原生开发命令工具比较麻烦，Commander.js 可以帮助我们简化命令行开发。Commander 是一款重量轻，表现力和强大的命令行框架。提供了用户命令行输入和参数解析强大功能。Commander 源自一个同名的Ruby项目。Commander.js 是 TJ 写的一个帮助快速开发Nodejs命令行工具的package。TJ这货是Nodejs社区里非常知名的高产作者。方便的定义option(包括option的描述和其回调函数)和子命令。

特性

Commander的方便之处在于：

自记录代码、自动生成帮助、合并短参数（“ABC”==“-A-B-C”）、默认选项、强制选项​​、命令解析、提示符

API

Option(): 初始化自定义参数对象，设置“关键字”和“描述” 
Command(): 初始化命令行参数对象，直接获得命令行输入 
Command#command(): 定义一个命令名字 
Command#action(): 注册一个callback函数 
Command#option(): 定义参数，需要设置“关键字”和“描述”，关键字包括“简写”和“全写”两部分，以”,”,”|”,”空格”做分隔。 
Command#parse(): 解析命令行参数argv 
Command#description(): 设置description值 
Command#usage(): 设置usage值

参考：官方文档例子

安装

安装commander

sudo npm install commander

Option

内置选项Built-in option，Commander 会为程序提供给一个默认的 -h option。

  1. program
  2.   .version('0.0.1')
  3.   .option('-r, --resume', '简历');
  4. program.parse(process.argv);

其中parse函数是处理定义的option和sub-command， 解析命令行参数并触发相应的回调(下文会说)。

  1.  
  2. ./bin/wcj.js -h
  3. ## 输出下面内容
  4.   Usage: wcj [options]
  5.  
  6.   Options:
  7.  
  8.     -h, --help     output usage information
  9.     -V, --version  output the version number
  10.     -r, --resume   简历

可以看到默认就有个 -h 参数，传入后会输出 wcj 命令的帮助信息。

Custom option

为 wcj 命令增加一个 option，展示说明是我的简历。

  1. program
  2.   .version('0.0.1')
  3.   .option('-r| --resume', '简历');
  4. program.parse(process.argv);
  5.  
  6. if (program.resume) {
  7.     console.log('简历 - '
  8.         + '这个是我的简历！'
  9.     );
  10. }

option() 接收四个参数

  • 第一个参数中，-r 为short option，--resume为对应的long option, 二者的分割符是|或者,。在命令行里使用时，这两个是等价的。 区别是后者可以在程序里通过 program.resume 的方式取到该 option 的值，此处 option 的值为 bool，也可以为字符串。

  • 第二个为 option 描述, 会在 help 信息里展示出来

  • 第三个参数为回调函数

  • 第四个参数为默认值

Unknown option

当接收到未定义的option时，程序会自动抛出错误

  1. ./bin/wcj.js -h
  2.  
  3. ## 输出下面内容
  4. error: unknown option '--res'

Commander同时提供了api来取消这个自动报错机制， .allowUnknownOption()。

  1. #!/usr/bin/env node
  2. program
  3.     .allowUnknownOption()
  4.     .version('0.0.1')
  5.     .option('-r, --resume', '简历');
  6.  
  7. program.parse(process.argv);
  8. //省略一些细节...

Option types

Command支持以下两种类型的option： required 、 optional 和 bool

required 和 optional

在option的第一个参数里, 除了short，long option，还可以指定option类型，分隔符也是|和, 其中

  • <lang> required参数，使用时后边必须跟参数值, 否则程序会报错

  • [db] optional参数，后面可以选择是否跟参数值

  1. #!/usr/bin/env node  
  2. var program = require('commander');
  3. program
  4.     .allowUnknownOption()
  5.     .version('0.0.1')
  6.     .option('-r, --resume', '简历')
  7.     .option('-l, --language <lang>', '这个语言是我擅长的语言。')
  8.     .parse(process.argv);
  9.  
  10. if (program.resume) {
  11.     console.log('简历'
  12.         + '-'
  13.         + '这个是我的简历！'
  14.     );
  15. }
  16.  
  17. if (program.language) console.log('language: 我擅长的语言`' + program.language + '`');
  18. if (program.database) console.log('db: 我擅长的语言`' + program.database + '`');

看下效果

  1. ./bin/wcj.js -l python
  2. ## 输出
  3. language: 我擅长的语言`python`
  4. db: 我擅长的语言`MySQL`
  5.  
  6. ./bin/wcj.js -l
  7. ## 输出
  8.   error: option '-l, --language <lang>' argument missing

bool

选项值为布尔型, 像上面的--date, 默认是false，当使用此参数时，program.date 为true, 否则为false

bool型option有个变种，当long option定义为no-*时默认值为true, 将

  1. var program = require('commander');
  2. program
  3.   .option('-d, --no-date', 'don‘t display current date')
  4.   .parse(process.argv);
  5.  
  6. var dt = new Date();
  7. if (program.date) {
  8.     console.log(dt.getFullYear()
  9.         + '-'
  10.         + (dt.getMonth() + 1)
  11.         + '-'
  12.         + dt.getDate()
  13.     );
  14. }

不带-d 参数时, 参数的默认值为true

Automated --help

Commander会根据配置的option，sub-command等信息，自动生成help信息。

Custom help

可以通过监听--help事件来输出额外的帮助信息，如下面给fe命令添加了一些examples

  1. // must be before .parse() since node's emit() is immediate
  2. program.on('--help', function () {
  3.     console.log('  自定义的例子:')
  4.     console.log('')
  5.     console.log('    输出命令  wcj -d')
  6.     console.log('    输出命令  wcj -l python')
  7.     console.log('')
  8. })
  9.  
  10. program.parse(process.argv);

效果如下：

  1. ./bin/wcj.js -h
  2.  
  3.   Usage: wcj [options]
  4.  
  5.   Options:
  6.  
  7.     -h, --help             output usage information
  8.     -d, --no-date          display current time
  9.     -l, --language <lang>  这个语言是我擅长的语言。
  10.     -b, --database [db]    该数据库为我最擅长数据库
  11.  
  12.   自定义的例子:
  13.  
  14.     输出命令  wcj -d
  15.     输出命令  wcj -l python

像git风格一样的命令

列子源码

  1. #!/usr/bin/env node 
  2. var program = require('commander');
  3. var appInfo = require('./../package.json');
  4.  
  5. program
  6.     .version(appInfo.version)
  7.     .usage('这里是我私人玩耍的命令哦！[options] <package>')
  8.  
  9. //像git风格一样的子命令
  10. program
  11.     //子命令
  12.     .command('resume <cmd>')
  13.     //短命令 - 简写方式
  14.     .alias('rs')
  15.     //说明
  16.     .description('这里是我的简历详情！')
  17.     //resume的子命令
  18.     .option("-n, --name <mode>", "输出我的名字")
  19.     //注册一个callback函数
  20.     .action(function(cmd, options){
  21.         var nm = typeof options.name=='string'?options.name:""
  22.  
  23.         console.log('resume "%s" 使用 %s 模式', cmd, nm);
  24.     }).on('--help', function() {
  25.         //这里输出子命令的帮助
  26.         console.log('  Examples:');
  27.         console.log('    运行方法：');
  28.         console.log('    $ ./bin/wcj.js resume ss -n aaaaa');
  29.         console.log('    $ ./bin/wcj.js resume ss');
  30.         console.log();
  31.     });
  32.  
  33. program.parse(process.argv);

上面实例运行输出方式

  1. $ ./bin/wcj.js resume ss -n aaaaa
  2.  
  3. #输出：
  4. resume "ss" 使用 aaaaa 模式
  5.  
  6. $ ./bin/wcj.js resume ss
  7. #输出：
  8. resume "aa" 使用  模式

事件监听

命名多少个命令就监听多少命令，--help 为默认监听事件。

  1. program.on('--help', function(argv,test){
  2.     process.exit(1);
  3. });

yargs

命令行框架 yargs 和你的程序实现交互 yargs for github

  1. var argv = require('yargs').argv;
  2. if (argv.l == 'zh-cn') {
  3.     console.log('Chinese site!');
  4. }else if(argv.l == 'en') {
  5.     console.log('English website!');
  6. }

使用

  1. var argv = require('yargs').argv;
  2. if (argv.l == 'zh-cn') {
  3.     console.log('Chinese site!');
  4. }else if(argv.l == 'en') {
  5.     console.log('English website!');
  6. }

阅读参考

第一个小实例看了很多文章，记录一下，感觉非常简单的样子。

声明：本文内容由网友自发贡献，不代表【wpsshop博客】立场，版权归原作者所有，本站不承担相应法律责任。如您发现有侵权的内容，请联系我们。转载请注明出处：https://www.wpsshop.cn/w/Cpp五条/article/detail/399759
推荐阅读
相关标签

Copyright © 2003-2013 www.wpsshop.cn 版权所有，并保留所有权利。

  

闽ICP备14008679号