node-compiler/plugins/Sync.js

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

var Helpers = require("../helpers");
var Plugin = require("../lib/Plugin");

var Path = require("path")
var FS = require("fs");

function Sync() {
    Plugin.apply(this, arguments);

    if (Path.extname(Path.basename(this.target.profile.output)).length > 0) {
       throw new Error("Sync intergration requires an output path that is a folder.");
    }
}

/* ------------------------------------------------------------------------------------------------------------------ *\
  * @description: The sync plugin is rather simple. Files placed in the watch directory will be copied to the output
                  directory. The filePattern property is not used as unlike other plugins, this isn't important.
  * @requires:
    * helpers - Used for reading from and writing to cache.
    * plugin  - Used to inherit common methods among the plugins.
    * path    - Required to ensure it's profile output path is a folder.
    * fs      - Used to read the contents of the files that aren't within cache when compiling.
  * @todo:
    * Force concatination of the target to be false.
    * Skip caching of files and simply check if they are in the output directory.
    * Allow an option to specify a regex file extension matcher.
    * Stream syncing to prevent large amounts of memory consumption when dealing with big files.
\* ------------------------------------------------------------------------------------------------------------------ */

Sync.prototype = Object.create(Plugin.prototype);
Sync.prototype.constructor = Sync;

Sync.title = "Sync";

/* ------------------------------------------------------------------------------------------------------------------ *\
  * @description: This method simply checks in cache for the file in question. If this isn't the case the contents of
                  the file is read and created in cache.
  * @parameters:
    * path [string]     - The absolute path of the file.
    * stat [object]     - The stat object of the file.
    * startup [boolean] - This parameter is only true when the compiler is first launched otherwise it's falsy.
  * @returns: The contents of the compiled file will be returned unless an error occurs. If this is the case null will
              instead be returned.
\* ------------------------------------------------------------------------------------------------------------------ */
Sync.prototype.compile = function _compile(path, stat, startup) {
    var cache = Helpers.getCache(this.target, path, null);
    var contents = (cache || "");
    
    if (!cache) {
        contents = FS.readFileSync(path);
        Helpers.cache(this.target, path, contents);
        this.logger.debug("[Cached] " + path);
        this.log(path);
    }

    return contents;
};

module.exports = Sync;