Hexo插件机制分析

CLI启动

有种流行的做法是把cli和实现分离,比如grunt-cli和grunt。hexo也是采取这种方式,hexo-cli专门处理命令行,hexo才是具体的实现。可以像bash一样执行hexo-cli的命令

启动脚本

#!/usr/bin/env node

'use strict';

require('../lib')();

搜索路径,初始化Hexo

上面的脚本,实际上执行的是lib/index.js,核心代码如下。为了方便阅读,省略了与流程无关的代码:

findPkg(cwd, args).then(function(path){
   

    if(!path){
        return runCLICommand(args);
    }

    var modulePath = pathFn.join(path, 'node_modules', 'hexo');

    return fs.exists(modulePath).then(function(exist){
   

      if (!exist){
        return process.exit(1);
      }

      var Hexo = require(modulePath);
      hexo = new Hexo(path, args);
      log = hexo.log;

      return hexo.init().then(runHexoCommand);
    });

首先,Hexo大量使用了bluebird,包括上面代码中的fs也不是node核心模块的fs,而是经过promise化的API,所以习惯了callback风格的人可能会看得晕头转向,怎么全是各种return。本文就不介绍bluebird了,基本上就是前一个function执行完之后,会进入下一个then方法

findPkg具体的代码不展开了,目的是从cwd(当前目录,也就是执行hexo xxx命令的目录)递归向上查找package.json里是否包含Hexo属性,如果有的话,就把此目录作为Hexo的根目录

如果找不到根目录,就执行hexo-cli自带的3个基础命令(init, help, version);如果找到了根目录,就require hexo module,然后实例化,调用init函数,最后执行具体的命令,如new,generate等

cli用到的模块

hexo-cli思路很简单,麻雀虽小五脏俱全,读它的源代码也很有意思。比较有收获的是了解了几个库的用法

var minimist = require('minimist');
var abbrev = require('abbrev');
var tildify = require('tildify');
var chalk = require('chalk');

minimist

minimist是命令行处理的组件,比如下面这个命令:

$ init blog --verbose --cwd /usr/local/

会处理成:

{ _: [ 'init', 'blog' ], verbose: true, cwd: '/usr/local/' }

以–开头的参数,会处理成key/value;其他的参数会以数组的形式放到里。后续可以很容易地从中按顺序取出参数,或者判断某参数是否存在

abbrev

abbrev也是个命令行处理组件:

var commands = ["generate", "init", "help"];
var shorthands = abbrev(commands);

会得到:

{ g: 'generate',
  ge: 'generate',
  gen: 'generate',
  gene: 'generate',
  gener: 'genera
  • 1
    点赞
  • 3
    收藏
    觉得还不错? 一键收藏
  • 1
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值