Node.js+commander开发命令行工具

命令行工具.jpeg

Node.js 是一个基于 Chrome V8 引擎的 JavaScript 运行环境。Node.js 使用了一个事件驱动、非阻塞式 I/O 的模型,使其轻量又高效。Node.js 的包管理器 npm,是全球最大的开源库生态系统。
Node.js作为最热的开发工具之一,如何用它来开发命令行程序,是一个web开发者应该学习掌握的。
本文主要使用commander插件来进行命令行工具的开发工作。Commander.js 是 一个帮助快速开发Nodejs命令行工具的package。

脚本解释程序:

#! /usr/bin/env node

在代码的开头第一行,必须指定我们的脚本执行所需要的解释程序。在这里,我们使用node来作为脚本的解释程序。而我们#! /usr/bin/env node这样写,目的是使用env来找到node,并使用node来作为程序的解释程序。

env

在env中规定很多系统的环境变量,包括我们安装的一些环境的路径等。在不同的操作系统中,我们安装node的路径可能会有所不同,但是其环境变量会存在于env里面,所以,这里我们使用env来找到node,并用node作为解释程序。所以,env的主要目的就是让我们的脚本在不同的操作系统上都能够正常的被解释,启动。
命令行工具开发:
这里我们以将sass文件编译转化为css文件,并放到相应目录。监视sass文件变化自动执行编译为css这个功能作为一个列子,一步一步来实现sass文件的编译以及监听功能。

插件 安装方法 描述
commander npm install commander 一个帮助快速开发Nodejs命令行工具的package
chalk npm install chalk 终端输出时颜色样式输出工具
gulp npm install gulp 一个自动化构建工具,开发者可以使用它在项目开发过程中自动执行常见任务
gulp-sass npm install gulp-sass 将sass文件编译成css文件的工具

这里,我们在package.json文件中,定义好命令的名称以及执行该命令时,所执行脚本的路径:

"bin": {
    "cain": "./bin/cain.js"
 },

cain.js

#! /usr/bin/env node

var program = require('commander'),
   chalk = require('chalk'),
   SassMain = require('./sass.js');

/**
 * sass编译执行及监听
 */
program
    .command('sass')
    .option('--w', '监听sass变化,自动执行编译')
    .alias('sa')
    .description('sass转化css')
    .action(function (option) {
      var isWatch = option.w ? true : false;
      if (isWatch) {
        SassMain.sassWatch();
      }else {
        SassMain.sassMake();
      }
    });

以上是cain.js脚本的内容,其中定义了一个sass命令。
command:执行的命令 sass (这里如果执行的话,就是“cain sass”)
option:可选参数 --w (watch 监听sass文件变化,自动执行编译)
alias:简写 sa (命令简写为sa 执行就是“cain sa”)
description:命令描述
action:执行命令后所执行的方法。

sass.js

/**
 * @fileoverview sass文件编译、监听
 * @author  wangzhengkai
 */

'use strict';

var sass = require('gulp-sass'),
    chalk = require('chalk'),
    Util = require('../lib/util'),
    gulp = require('gulp');

var sassMain = {
  sassMake: function () {
    sassChange();
  },
  sassWatch: function() {
    console.log(chalk.green("  正在监听..."));
    var conf;
    Util.getConfig(function(config){
      conf = config;
    });
    var watcher = gulp.watch(conf.sass.sassUrl+'*.scss');
    watcher.on('change', function (event) {
      sassChange();
    });
  },
};

/**
 * [sassChange sass文件编译方法]
 * @return {[type]} [description]
 */
function sassChange() {
  var conf;
  Util.getConfig(function(config){
    conf = config;
  });
  return gulp.src(conf.sass.sassUrl+'*.scss')
    .pipe(sass().on('error', sass.logError))
    .pipe(gulp.dest(conf.sass.output));
}

module.exports = sassMain;

sass.js文件中定义了sass文件编译方法以及其监听方法,这里主要通过集成了gulp以及gulp-sass的sass文件编译以及监听方法来实现,如果有兴趣的话,可以去尝试看看这两个插件的内部实现并自己来做。在sass.js文件中,我引用了一个Util文件,在这个文件中,我实现了一个getConfig()方法。这个方法可以获取到用户当前执行目录的配置文件,并从中读取用户设置的相关配置内容。

getConfig()方法:

/**
   * 获取cain config文件
   */
   getConfig:function (callback) {
       var configPath = path.join(process.cwd(), 'cain.config.js');
       var config = {};
       if (fs.existsSync(configPath)) {
           try {
               config = eval(fs.readFileSync(configPath,"utf-8"));
               callback&&callback(config);
           } catch (e) {
               console.log("读取cain.config.js文件失败");
           }
       }else {
           console.log("cain.config.js文件不存在,请检查后再试");
       }
   },

cain.config.js文件内容:

module.exports = {
    name:"test",
    sass:{
        sassUrl:"sass/",
        output:"css/"
    }
};

至此,sass文件编译以及监听的开发工作就完成了。
最后,想要看到执行效果,只需要在package.json文件所在目录下执行npm link命令就可以执行了。

小结:

在命令行工具开发的过程中,充分利用好commander、inquirer以及chalk还有其他的一些npm插件,可以很好的完成命令行工具的开发,并且可以达到很棒的效果,感兴趣的话,赶快试试吧,做一款自己的命令行工具。

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

推荐阅读更多精彩内容