spoonx / boards Goto Github PK

Allow for basic simple stuff, through a config file. Just generate templates with an accessible API.

// @todo find way to locate globally installed modules
// @todo like so https://github.com/egoist/global-node-modules/blob/master/index.js
// @todo or one that actually works: https://github.com/jonschlinkert/global-paths/blob/master/index.js

Allow steps consisting out of multiple streams. This means the same flow gets repeated for all files.

The locate step can find and replace specific occurrences in existing files. This allows you to alter existing projects, useful for routes etc.

const {Generator} = require('boards');

class TemplateGenerator extends Generator {
  static defaults() {
    return {};
  }

  generate(parameters) {
    return this.runSteps(['read', 'replace', 'write']);
  }

  complete(stream) {
    return stream;
  }
}

module.exports.TemplateGenerator = TemplateGenerator;

A lot of the time you'll want to use this. It's tiny, it's simple. There's no cli output... Perfect.

Currently a generator must have a static defaults method