Skip to content

Latest commit

 

History

History
80 lines (53 loc) · 3.9 KB

README.md

File metadata and controls

80 lines (53 loc) · 3.9 KB

generate-data NPM version NPM monthly downloads NPM total downloads Linux Build Status

Generate plugin that gathers data from the user's environment to pre-populate data for hints.

Heads up!

This plugin modifies the app.cache.data object with "expanded" values. For example, the following author property from package.json:

{
  author: 'Jon Schlinkert (https://github.com/jonschlinkert)'
}

Is expanded to:

{
  author: {
    name: 'Jon Schlinkert',
    url: 'https://github.com/jonschlinkert'
  }
}

"original" data

Before data is modified, it's cloned and set on the app.cache.originalData object. You can reset the data object to this value by doing something like the following:

app.cache.data = app.cache.originalData;

Usage

Use as a plugin inside your generate generator:

module.exports = function(app) {
  app.use(require('generate-data'));
};

About

Related projects

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Running tests

Install dev dependencies:

$ npm install && npm test

Author

Jon Schlinkert

License

Copyright © 2017, Jon Schlinkert. Released under the MIT License.


This file was generated by verb-generate-readme, v0.4.2, on February 03, 2017.