jspacker/lib/resolvepath.js

支持commonjs类模块化开发项目的静态打包

var path = require('path');
var utils = require('./utils');

/**
 *{
     *   "alias": {  别名
     *       "jquery": "lib/jquery.js"
     *  },
     *   "paths": {  路径变量
     *       "render": "src/scripts/render"
     *   },
     *   "base": "E:/path/to/project"  必须使用本地绝对路径
     *}
 */
var commonJSConfig = null;

var SUFFIX = '.js';
/**
 * id 类型正则
 * @type {{
 * ABSOLUTE: RegExp,
 *   RELATIVE: RegExp,
 *   ROOT: RegExp,
 *   ROOT_DIR: RegExp,
 *   PATHS: RegExp
 * }}
 */
var idTypeRegs = {
    "ABSOLUTE": /(?:^|:)\/\/./,  //绝对路径
    "RELATIVE": /^\./,           //相对路径
    "ROOT": /^\//,               //根路径
    "ROOT_DIR": /^.*?\/\/.*?\//, //根文件
    "PATHS": /^([^/:]+)(\/.+)$/  //全局路径
};

/**
 * 获取 id 的类型
 * @param id
 * @returns {*}
 */
var getIdType = function (id) {
    for (var type in idTypeRegs) {
        if (idTypeRegs.hasOwnProperty(type)) {
            if (idTypeRegs[type].test(id)) {
                return type;
            }
        }
    }
};

/**
 * 解析别名
 * @param id
 * @returns {*}
 */
var parseAlias = function (id) {
    var alias = commonJSConfig.alias;
    return alias && utils.isString(alias[id]) ? alias[id] : id;
};

/**
 * 解析全局类型
 * @param resultPath
 * @returns {*}
 */
var parsePaths = function (resultPath) {
    var paths = commonJSConfig.paths;
    if (paths) {
        var pathMatch = resultPath.match(idTypeRegs["PATHS"]);
        if (pathMatch && utils.isString(paths[pathMatch[1]])) {
            resultPath = paths[pathMatch[1]] + pathMatch[2] + SUFFIX;
        }
    }
    return resultPath;
};

/**
 * 补全路径，理论上讲，应该使用 config.base补全
 * @param resultPath
 * @param scriptBasePath 项目根目录
 * @returns {*}
 */
var appendBase = function (resultPath, scriptBasePath) {
    if (idTypeRegs["PATHS"].test(resultPath)) {
        resultPath = path.resolve(scriptBasePath, resultPath);
    }
    return resultPath;
};

/**
 * 添加后缀
 * @param resultPath
 * @returns {*}
 */
var addSuffix = function (resultPath) {
    if (path.extname(resultPath) !== '.js' &&
        path.extname(resultPath) !== '.json') {
        resultPath += SUFFIX;
    }
    return resultPath;
};

/**
 * 处理特殊的路径
 * 比如，当使用knighkit时，可以直接使用未编译的模板，即 虚拟路径，比如require('src/template/list')，服务会自动返回编译后的模块代码
 * 当出现这种代码后，jspacker会找不到此类js文件，因此，需要特殊处理，去js的输出路径去找： output/list/list
 * @param resultPath 计算完毕的文件路径
 * @param scriptBasePath 项目根目录
 */
var fixSpecialPath = function (resultPath, scriptBasePath) {
    if (commonJSConfig.template && commonJSConfig.output) { //检测是否是knighkit配置文件，是否含有 template和output 配置项
        var templateRoot = commonJSConfig.template;
        var output = commonJSConfig.output;
        var tempname = path.relative(path.join(scriptBasePath, templateRoot), resultPath);
        if (path.dirname(tempname) === '.') {
            return path.join(scriptBasePath, output, path.basename(tempname, path.extname(tempname)), tempname);
        }
    }
    return resultPath;
};

module.exports = function (modulePath, id, scriptBasePath) {
    var resultPath = parseAlias(id);
    switch (getIdType(resultPath)) {
        case "RELATIVE":
            resultPath = path.resolve(modulePath, resultPath);
            break;
        case "PATHS":
            resultPath = parsePaths(resultPath);
    }

    resultPath = appendBase(resultPath, scriptBasePath);
    resultPath = addSuffix(resultPath);
    resultPath = fixSpecialPath(resultPath, scriptBasePath);
    return resultPath;
};
/**
 *
 * @param config
 * configPath  .json or nodejs module
 * config obj
 * @returns {*}
 */
module.exports.initConfigs = function (config) {
    commonJSConfig = config || {
            /**
             * commonJS 和 nodejs 都可以加载此模块
             * -------- begin -----------*/
            "alias": {},
            "paths": {},
            "debug": true,
            /* --------end-----------*/

            /**
             * 打包模块, 可设置多个
             * path 是要打包文件的入口模块路径
             * name 是输出文件名称
             * -------- begin -----------*/
            "packModules": [
                {"path": "src/scripts/index", "name": "business"}
            ]
            /* --------end-----------*/
        };
    if (utils.isString(config)) {
        var realPath = path.resolve(__dirname, config);
        commonJSConfig = require(realPath);
    }
    return commonJSConfig
};