verb/lib/transforms/env/env.js

Documentation generator for GitHub projects. Verb is extremely powerful, easy to use, and is used on hundreds of projects of all sizes to generate everything from API docs to readmes.

'use strict';

var path = require('path');
var merge = require('lodash')._.merge;

/**
 * Getter for getting stored values from `verb.env`, a read-only
 * object that stores the project's package.json before it's modified.
 *
 * ```js
 * console.log(verb.env.name);
 * //=> 'my-project'
 * ```
 *
 * @return {*} The value of specified property.
 * @api public
 */

module.exports = function(app) {
  var env = app.env || app.option('env') || require(path.resolve('package.json'));
  merge(env, (env.verb && env.verb.data) || {});

  Object.defineProperty(app, 'env', {
    get: function () {
      return env;
    },
    set: function () {
      console.log('verb.env is read-only and cannot be modified.');
    }
  });
};