mincer/lib/mincer/helpers/paths.js

Web assets processor. Native JavaScript port of Sprockets.

/** internal
 *  mixin Paths
 *
 *  An internal mixin whose public methods are exposed on the [[Environment]]
 *  and [[Index]] classes.
 *
 *  Provides helpers to work with `Hike.Trail` instance.
 **/


// REQUIRED PROPERTIES /////////////////////////////////////////////////////////
//
// - `__trail__` (Hike.Trail)
//
////////////////////////////////////////////////////////////////////////////////


'use strict';


// internal
var getter = require('../common').getter;


////////////////////////////////////////////////////////////////////////////////


/**
 *  Paths#root -> String
 *
 *  Returns [[Environment]] root.
 *
 *  All relative paths are expanded with root as its base.
 *  To be useful set this to your applications root directory.
 **/
getter(module.exports, 'root', function () {
  return this.__trail__.__root__;
});


/**
 *  Paths#paths -> Array
 *
 *  Returns an `Array` of path `String`s.
 *
 *  These paths will be used for asset logical path lookups.
 *
 *  Note that a copy of the `Array` is returned so mutating will
 *  have no affect on the environment. See [[Paths#appendPath]],
 *  [[Paths#prependPath]], and [[Paths#clearPaths]].
 **/
getter(module.exports, 'paths', function () {
  return this.__trail__.paths;
});


/**
 *  Paths#prependPath(path) -> Void
 *
 *  Prepend a `path` to the `paths` list.
 *  Paths at the end have the least priority.
 **/
module.exports.prependPath = function (path) {
  this.__trail__.prependPaths(path);
};


/**
 *  Paths#appendPath(path) -> Void
 *
 *  Append a `path` to the `paths` list.
 *  Paths at the beginning have a higher priority.
 **/
module.exports.appendPath = function (path) {
  this.__trail__.appendPaths(path);
};


/**
 *  Paths#clearPaths() -> Array
 *
 *  Clear all paths and start fresh.
 *
 *  There is no mechanism for reordering paths, so its best to
 *  completely wipe the paths list and reappend them in the order
 *  you want.
 *
 *  Returns list of previously registered paths.
 **/
module.exports.clearPaths = function () {
  return this.__trail__.removePaths();
};


/**
 *  Paths#extensions -> Array
 *
 *  Returns an `Array` of extensions.
 *
 *  These extensions maybe omitted from logical path searches.
 *
 *      [".js", ".css", ".coffee", ".sass", ...]
 **/
getter(module.exports, 'extensions', function () {
  return [].concat(this.__trail__.__extensions__);
});