config.json

//
// TimelineJS3 configuration
//
// All file/directory paths are relative to the project directory.
//
// Regular expressions are in python regular expression format, but backslashes
// must be escaped for JSON.  When used to match files, matching will take
// place against the the file/directory path realtive to the project directory.
//
{
    //
    // name of the project as it will appear in the cdn and css/js banners
    //
    "name": "timeline3",
    //
    // author string to appear in css/js banners
    //
    "author": "Northwestern University Knight Lab",
    //
    // build
    //
    // These commands will be run the exact order in which they appear.
    // This order is determined in code by fabfile/__init__.py.
    //
    "build": {
        // copy files
        // input: list of objects specifying inputs and outputs
        //      @src: source file/directory
        //      @dst: destination file/directory
        //      @regex: regular expression to match files (if @src is directory)
        //
        "copy": [
            {
                "src": "website",
                "dst": "build",
                "regex": "(css/.*|img/.*|js/.*|.*\\.(ico))$"
            },
            {
                "src": "source",
                "dst": "build",
                "regex": "(css/.*|img/.*|.*\\.(ico|html)|gfx/.*\\.(png|jpg|gif))$"
            },
            {
                "src": "source/js/language/locale",
                "dst": "build/js/locale",
                "regex": ".*\\.json"
            },
            {
                "src": "source/embed",
                "dst": "build/embed"
            }
        ],
        // compile less files
        // input: list of objects specifying inputs and output
        // input: list of objects, where
        //      @src: source file/directory
        //      @dst: destination file/directory
        //      @regex: regular expression to match files (if @src is directory)
        //      @opt: options to pass to lessc
        "lessc": [
            {
                "src": "source/less/TL.Timeline.less",
                "dst": "build/css/timeline.css",
                "opt": "--clean-css=--s0"
            },
            {
                "src": "source/less/themes/dark/TL.Theme.Dark.less",
                "dst": "build/css/themes/timeline.theme.dark.css",
                "opt": "--clean-css=--s0"
            },
            {
                "src": "source/less/fonts",
                "dst": "build/css/fonts",
                "regex": ".*(?<!font.base)\\.less"
            }
        ],
        //
        // process codekit style imports on files
        // input: list of objects specifying inputs and output
        //      @src:    source file
        //      @dst:    destination file
        //
        "process": [
            {
                "src": "source/js/TL.Timeline.js",
                "dst": "build/js/timeline.js"
            },
            {
                "src": "source/js/Embed/Embed.CDN.js",
                "dst": "build/js/timeline-embed-cdn.js"
            },
            {
                "src": "source/js/Embed/Embed.js",
                "dst": "build/js/timeline-embed.js"
            }
        ],
        // concatenate files
        // input: list of objects, where
        //      @src: list of source files
        //      @dst: destination file
        "concat": [
        ],
        // minify files using uglifyjs
        // input list of objects specifying inputs and output
        //      @src:   source file/directory
        //      @dst:   destination file/directory
        //      @opt:   options to pass to uglifyjs
        //      @ext:   extension to prepend to destination file name (optional, default = none)
        //
        "minify": [
            {
                "src": "build/js/timeline.js",
                "dst": "build/js/timeline-min.js",
                "opt": "--comments --mangle --reserved $ --compress booleans,cascade,comparisons,conditionals,drop_debugger,evaluate,hoist_funs,if_return,join_vars,loops,properties,sequences"
            },
            {
                "src": "source/js/library/moment.js",
                "dst": "build/js/library/moment.js",
                "opt": "--comments --mangle --reserved $ --compress booleans,cascade,comparisons,conditionals,drop_debugger,evaluate,hoist_funs,if_return,join_vars,loops,properties,sequences"
            }
        ],
        //
        // process usermin style build blocks on html files
        // input: list of files/directorys to process in-place
        //
        "usemin": [
            "build/embed"
        ],
        //
        // banner
        // input: list of objects, where
        //      @src: source file/directory
        //      @regex: regular expression to match files (if @src is directory)
        "banner": [
            {
                "src": "build",
                "regex": "(js|css)/.*\\.(css|js)$",
                "template": [
                    "/*",
                    "    TimelineJS - ver. %(version)s - %(date)s",
                    "    Copyright (c) 2012-2015 Northwestern University",
                    "    a project of the Northwestern University Knight Lab, originally created by Zach Wise",
                    "    https://github.com/NUKnightLab/TimelineJS3",
                    "    This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.",
                    "    If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.",
                    "*/"
                ]
            }
        ]
    },
    //
    // stage
    // input: regular expression to match files in the build directory
    //
    "stage": [{
        "src": "build",
        "regex": "(css/.*|js/.*|gfx/.*|embed/.*)$"
    }],
    //
    // deploy
    // input: {
    //   env: {bucket: name of the S3 bucket that will host the website}
    // }
    //
    "deploy": {
        "stg": {"bucket": "timeline.knilab.com", "usemin_context": {"cdn": "dev"}, "deploy_context": {"cdn": "dev"}},
        "prd": {"bucket": "timeline.knightlab.com", "usemin_context": {"cdn": "latest"}, "deploy_context": {"cdn": "latest"}}
    }
}