path-loader/lib/loaders/file.js

Utility that provides a single API for loading the content of a path/URL.

/*
 * The MIT License (MIT)
 *
 * Copyright (c) 2015 Jeremy Whitlock
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

'use strict';

var fs = require('fs');
var path = require('path');

/**
 * Loads a file from the filesystem.
 *
 * @param {string} location - The filesystem location (If relative, location is relative to process.cwd()).
 * @param {object} options - The loader options (Unused)
 * @param {string} [options.encoding='utf-8'] - The encoding to use when loading the file
 * @param {function} callback - The error-first callback
 */
module.exports.load = function (location, options, callback) {
  if (typeof options.encoding !== 'undefined' && typeof options.encoding !== 'string') {
    throw new TypeError('options.encoding must be a string');    
  }

  // Strip the scheme portion of the URI
  if (location.indexOf('file://') === 0) {
    // Handle URI
    location = location.substr(7);
  }

  if (path.resolve(location) !== path.normalize(location)) {
    // Handle relative paths
    location = path.resolve(process.cwd(), location);
  }

  fs.readFile(location, {encoding: options.encoding || 'utf-8'}, callback);
};