lilacs/project_config/defaults/base.js

A web frontend building tool for teamwork, with automaticly compiling, merging, minifying, syncing files to server, supporting distributed servers, ensuring css or html files' inline reference with correct absolute path, and more.

// default config root attributes
var defaults = {
    // current handling module name
    module: 'test/index',
    /**
     * environment index
     *
     * example: 0 -> test
     *          1 -> prod
     *          2 -> other
     *          ...
     */
    env: 0,
    // whether use requireJs to build project
    useRequireJs: false,
    /**
     * requireJs config file path
     *
     * note: 1. it should be an absolute path, and relative to basePaths.webRoot
     *       2. it will take effect when useRequireJs is true
     */
    requireJsConfigPath: '/dev/js/common/require_js_config.js',
    /**
     * convert js async load to sync tag load
     *
     * example: require(['jquery', 'underscore'])
     *
     * result: <script src="path/to/jquery"></script>
     *         <script src="path/to/underscore"></script>
     *         require(['jquery', 'underscore'])
     *
     * note: it will take effect when useRequireJs is true
     */
    requireJsToTagLoad: false,
    // requireJs config file tag selector in html
    requireJsConfigTagSelector: '[data-require-js-config-tag]',
    // whether use InCss to build project
    useInCss: false,
    /**
     * InCss config file path
     *
     * note: 1. it should be an absolute path, and relative to basePaths.webRoot
     *       2. it will take effect when useInCss is true
     */
    inCssConfigPath: '/dev/js/common/in_css_config.js',
    /**
     * convert css async load to sync tag load
     *
     * example: InCss.use('bootstrap', 'common')
     *
     * result: <link rel="stylesheet" href="path/to/bootstrap">
     *         <link rel="stylesheet" href="path/to/common">
     *
     * note: it will take effect when useInCss is true
     */
    inCssToTagLoad: false,
    // all InCss tag selector in html
    inCssTagSelector: '[data-in-css-tag]',
    // InCss config file tag selector in html
    inCssConfigTagSelector: '[data-in-css-config-tag]',
    // InCss load tag selector in html
    inCssLoadTagSelector: '[data-in-css-load-tag]',
    // local server port
    serverPort: 8090,
    // directory priority to merge js
    concatJsPriority: {
        /**
         * key(name): (string/array, relative to dev/js)
         */
    },
    // directory priority to merge css
    concatCssPriority: {
        /**
         * key(name): (string/array, relative to dev/css)
         */
    },
    // whether mini js files
    minJs: false,
    // whether mini css files
    minCss: false,
    // whether mini html files
    minHtml: false,
    // whether merge js files
    concatJs: false,
    // whether merge css files
    concatCss: false,
    // whether record file changes, thus next time only handle changed file
    recordFileChanges: true,
    // whether rename js/css file by appending hash code to file name
    revisionFiles: true,
    // revision hash code length
    revisionHashLength: 8,
    // whether convert relative path to absolute path in css
    cssAbsolutePath: true,
    // whether convert relative path to absolute path and add cdn prefix in html
    htmlAbsoluteAndCdnPath: true,
    // whether skip not existing files when build
    skipNotExistingFiles: false,
    // treat all methods as `get` method, thus all methods can access to static file
    treatAllMethodsAsGet: !1
};

var _ = require('lodash');

module.exports = (config) => {
    config = _.defaults(config, _.cloneDeep(defaults));

    // confirm concatJsPriority and concatCssPriority has '_' key
    !config.concatJsPriority ? config.concatJsPriority = {_: ''} : config.concatJsPriority._ = '';
    !config.concatCssPriority ? config.concatCssPriority = {_: ''} : config.concatCssPriority._ = '';

    return config;
};