node-compiler/lib/Profile.js

Single page application compiler that supports a number of popular integrations.

var Target = require("./Target");

var Legitimize = require("legitimize");
var Path = require("path");
var FS = require("fs-extra");

/* ------------------------------------------------------------------------------------------------------------------ *\
  * @description: This class has authority over the compilation of files within its subsequent target directories. A
                  profile can contain multiple instances of Target that all report to its Profile when a file is
                  either created, deleted, or updated. When this occurs, the profile will authorise a compile of all
                  its targets.
  * @parameters:
    * compiler [object] - Reference to an instance of the compiler class.
    * profile [object]  - Pointer to a profile within the configuration object.
  * @requires:
    * Target:    - Used during the instantiation of the Profile when iterating through the configured targets.
    * legitimize - Used to validate a profile object defined in the configuration object.
    * path:      - Used to retrieve the directory portion of cache profiles and to determine the concatenation mode.
    * fs-extra:  - Chosen over the standard fs module for mkdirsSync and used to remove old output files.

\* ------------------------------------------------------------------------------------------------------------------ */

function Profile(compiler, profile) {
    var invalid = this.validate(profile);
    if (invalid) { throw new Error(invalid); }

    this.compiler = compiler;
    this.logger = compiler.logger;
    this.id = profile.id;
    this.name = profile.name;
    this.output = Path.join(compiler.directory, profile.output);
    this.concatenate = (Path.extname(this.output).length > 0);

    this.targets = profile.targets.map(function(target, id) {
        return new Target(this, target, id);
    }, this);
}

/* ------------------------------------------------------------------------------------------------------------------ *\
  * @description: This method loops through each target and compiles them. Depending on the output specified, files
                  may be concatinated or saved individually.
  * @parameters:
    * manualCompile [boolean]: Only true when the compiler is manually compiled otherwise it's falsy.
\* ------------------------------------------------------------------------------------------------------------------ */
Profile.prototype.compile = function _compile(manualCompile) {
    if (FS.existsSync(this.output)) {
        if (!FS.statSync(this.output).isDirectory()) {
            this.logger.debug("Removing old output file.");
            FS.unlinkSync(this.output);
        }
    } else {
        FS.mkdirsSync(Path.dirname(this.output));
    }

    this.logger.debug("Compiling Targets for Profile '" + this.name + "'.");
    this.targets.forEach(function(target) { target.compile(manualCompile); });
};

Profile.prototype.validate = new Legitimize({
    id: {
        type: "string",
        error: "'id' property of profile in configuration object is required and must be a string."
    },
    name: {
        type: "string",
        error: "'name' property of profile in configuration object is required and must be a string."
    },
    output: {
        type: "string",
        error: "'output' property of profile in configuration object is required and must be a path."
    },
    targets: {
        type: "array",
        error: "'targets' property of profile in configuration object is required and must be an array."
    }
}, {required: true});

module.exports = Profile;