FIS源码解析-整体架构

lib/
├── cache.js    // 缓存模块，提高编译速度
├── compile.js      // （单）文件编译模块
├── config.js  // 配置模块，fis.config 
├── file.js  // 文件处理
├── log.js // 日志
├── project.js  // 项目相关模块，比如获取、设置项目构建根路径、设置、获取临时路径等
├── release.js  // fis release 的时候调用，依赖 compile.js 完成单文件编译。同时还完成如文件打包等任务。├── uri.js  // uri相关
└── util.js  // 各种工具函数

fis server open

#!/usr/bin/env node

require('../fis.js').cli.run(process.argv);

// 加载FIS内核
var fis = module.exports = require('fis-kernel');

//项目默认配置
fis.config.merge({
   // ...
});

//exports cli object
// fis命令行相关的对象
fis.cli = {};

// 工具的名字。在基于fis的二次解决方案中，一般会将名字覆盖
fis.cli.name = 'fis';

//colors
// 日志友好的需求
fis.cli.colors = require('colors');

//commander object
// 其实最后就挂载了 commander 这个插件
fis.cli.commander = null;

//package.json
// 把package.json的信息读进来，后面会用到
fis.cli.info = fis.util.readJSON(__dirname + '/package.json');

//output help info
// 打印帮助信息的API
fis.cli.help = function(){
    // ...
};

// 需要打印帮助信息的命令，在 fis.cli.help() 中遍历到。 如果有自定义命令，并且同样需要打印帮助信息，可以覆盖这个变量
fis.cli.help.commands = [ 'release', 'install', 'server' ];

//output version info
// 打印版本信息
fis.cli.version = function(){
    // ...
};

// 判断是否传入了某个参数（search）
function hasArgv(argv, search){
    // ...
}

//run cli tools
// 核心方法，构建的入口所在。接下来我们就重点分析下这个方法。假设我们跑的命令是 fis server open
// 实际 process.argv为 [ 'node', '/usr/local/bin/fis', 'server', 'open' ]
// 那么，argv[2] ==> 'server'
fis.cli.run = function(argv){
    // ...
};

//run cli tools
fis.cli.run = function(argv){

    fis.processCWD = process.cwd();    // 当前构建的路径

    if(hasArgv(argv, '--no-color')){    // 打印的命令行是否单色
        fis.cli.colors.mode = 'none';
    }

    var first = argv[2];
    if(argv.length < 3 || first === '-h' ||  first === '--help'){
        fis.cli.help();    // 打印帮助信息
    } else if(first === '-v' || first === '--version'){
        fis.cli.version();    // 打印版本信息
    } else if(first[0] === '-'){
        fis.cli.help();    // 打印版本信息
    } else {
        //register command
        // 加载命令对应的插件，这里特指 fis-command-server
        var commander = fis.cli.commander = require('commander');
        var cmd = fis.require('command', argv[2]);
        cmd.register(
            commander
                .command(cmd.name || first)
                .usage(cmd.usage)
                .description(cmd.desc)
        );
        commander.parse(argv);    // 执行命令
    }
};

var server = require('./lib/server.js');  // 依赖的基础库

// 命令的配置属性，打印帮助信息的时候会用到
exports.name = 'server';
exports.usage = '<command> [options]';
exports.desc = 'launch a php-cgi server';

// 对外暴露的 register 方法，参数的参数为 fis.cli.command 
exports.register = function(commander) {

    // 略过若干个函数

    // 命令的可选参数，格式参考 commander 插件的文档说明
    commander
        .option('-p, --port <int>', 'server listen port', parseInt, process.env.FIS_SERVER_PORT || 8080)      
        .action(function(){
            // 当 command.parse(..)被调用时，就会进入这个回调方法。在这里根据fis server 的子命令执行具体的操作
            // ...
        });

    // 注册子命令 fis server open
    // 同理，可以注册 fis server start 等子命令
    commander
        .command('open')
        .description('open document root directory');
};