FIS源码-fisrelease概览

'use strict';

exports.register = function(commander){

    //  fis relase --watch 时，就会执行这个方法
    function watch(opt){
        // ...
    }

    // 打点计时用，控制台里看到的一堆小点点就是这个方法输出的
    function time(fn){
        // ...
    }

    // fis release --live 时，会进入这个方法，对浏览器进行实时刷新
    function reload(){
        //...
    }

    // 高能预警！非常重要的方法，fis release 就靠这个方法走江湖了
    function release(opt){
        // ...
    }

    // 可以看到有很多配置参数，每个参数的作用可参考对应的描述，或者看官方文档
    commander
        .option('-d, --dest <names>', 'release output destination', String, 'preview')
        .option('-m, --md5 [level]', 'md5 release option', Number)
        .option('-D, --domains', 'add domain name', Boolean, false)
        .option('-l, --lint', 'with lint', Boolean, false)
        .option('-t, --test', 'with unit testing', Boolean, false)
        .option('-o, --optimize', 'with optimizing', Boolean, false)
        .option('-p, --pack', 'with package', Boolean, true)
        .option('-w, --watch', 'monitor the changes of project')
        .option('-L, --live', 'automatically reload your browser')
        .option('-c, --clean', 'clean compile cache', Boolean, false)
        .option('-r, --root <path>', 'set project root')
        .option('-f, --file <filename>', 'set fis-conf file')
        .option('-u, --unique', 'use unique compile caching', Boolean, false)
        .option('--verbose', 'enable verbose output', Boolean, false)
        .action(function(){

            // 省略一大堆代码

            // fis release 的两个核心分支，根据是否有加入 --watch 进行区分
            if(options.watch){
                watch(options);    // 有 --watch 参数
            } else {
                release(options);   // 这里这里！重点关注！没有 --watch 参数
            }
        });
};

findFisConf();    // 找到当前项目的fis-conf.js

setProjectRoot();    // 设置项目根路径，需要编译的源文件就在这个根路径下

mergeFisConf();    // 导入项目自定义配置

readSourcesAndReleaseToDest(options);    // 将项目编译到默认的目录下

if(options.root){

    if(options.file){
        // 项目根路径，为 options.root 指定的路径
        // fis-conf.js路径，为 options.file 指定的路径
    }else{
        // 项目根路径，为 options.root 指定的路径
        // fis-conf.js路径，为 options.root/fis-conf.js 
    }
}else{

    if(options.file){
        // fis-conf.js路径，为 options.file 指定的路径
        // 项目根路径，为 fis-conf.js 所在的目录        
    }else{
        // fis-conf.js路径，为 逐层向上遍历后，找到的 fis-conf.js 路径
        // 项目根路径，为 fis-conf.js 所在的目录
    }
}

// 如果找到了 fis-conf.js
if(conf){
    var cache = fis.cache(conf, 'conf'); 
    if(!cache.revert()){
        options.clean = true;
        cache.save();
    }
    require(conf);  // 加载 fis-conf.js，其实就是合并配置
} else {
    // 还是没有找到 fis-conf.js
    fis.log.warning('missing config file [' + filename + ']');
}

var collection = {};    // 跟total一样，key=>value 为 “编译的源文件路径”＝》"对应的file对象"
    var total = {};
    var deploy = require('./lib/deploy.js');    // 文件部署模块，完成从 src -> dest 的最后一棒

function release(opt){

    opt.beforeEach = function(file){
        // 用compile模块编译源文件前调用，往 total 上挂 key=>value
        total[file.subpath] = file;
    };
    opt.afterEach = function(file){
        // 用compile模块编译源文件后调用，往 collection 上挂 key=>value
        collection[file.subpath] = file;
    };

    opt.beforeCompile = function(file){
        // 在compile内部，对源文件进行编译前调用（好绕。。。）
        collection[file.subpath] = file;        
    };

    try {
        //release
        // 在fis-kernel里，fis.release = require('./lib/release.js');
        // 在fis.release里完成除了最终部署之外的文件编译操作，比如文件标准化等
        fis.release(opt, function(ret){

            deploy(opt, collection, total);    // 项目部署（本例子里特指将编译后的文件写到某个特定的路径下）
        });
    } catch(e) {
        // 异常处理，暂时忽略
    }
}