nodejs,命令行工具,nodejs编写命令行工具,node.js,开发工具前言 Node 给前端开发带来了很大的改变,促进了前端开发的自动化,我们可以简化开发工作,然后利用各种工具包生成生产环境。如运行sass src/sass/main.scss dist/css/main.css 即可编译 Sass 文件。 在实际的开发过程中,我们可能会有自己的特定需求, 那么我们得学会如何创建一个Node命令行工具。 hello world
老规矩第一个程序为hello world 。在工程中新建bin目录,在该目录下创建名为helper的文件,具体内容如下: #!/usr/bin/env nodeconsole.log('hello world'); 修改helper文件的权限: 执行helper文件,终端将会显示hello world : $ ./bin/helperhello 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 命令: commander模块
为了更高效的编写命令行工具,我们使用TJ大神的commander模块。 $ npm install --save commander helper文件内容修改为: #!/usr/bin/env nodevar 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 -V1.0.0 commander模块提供-h , --help 和-V , --version 两个内置命令。 创建命令
创建一个helper hello <author> 的命令,当用户输入helper hello ipluser 时,终端显示hello ipluser 。修改helper文件内容: #!/usr/bin/env nodevar 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 nodeconsole.log('hello author'); 执行helper hello 命令: $ helper hello ipluserhello author 解析输入信息 我们希望author是由用户输入的,终端应该显示为hello ipluser 。修改helper-hello 文件内容,解析用户输入信息: #!/usr/bin/env nodevar program = require('commander');program.parse(process.argv);const author = program.args[0];console.log('hello', author); 再执行helper hello ipluser 命令: $ helper hello ipluserhello ipluser 哦耶,终于达到完成了,但作为程序员,这还远远不够。当用户没有输入author时,我们希望终端能提醒用户输入信息。 提示信息 在helper-hello文件中添加提示信息: #!/usr/bin/env nodevar 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>命令。刚兴趣的朋友们快快自己动手实践起来,只有自己做了才能算真正的学习了,希望本文对大家能有所帮助。 nodejs,命令行工具,nodejs编写命令行工具,node.js,开发工具
|