stefanwalther / assemble-scaffold Goto Github PK

🚨 You need to enable Continuous Integration on all branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because we are using your CI build statuses to figure out when to notify you about breaking changes.

Since we did not receive a CI status on the greenkeeper/initial branch, we assume that you still need to configure it.

If you have already set up a CI for this repository, you might need to check your configuration. Make sure it will run on all new branches. If you don’t want it to run on every branch, you can whitelist branches starting with greenkeeper/.

We recommend using Travis CI, but Greenkeeper will work with every other CI service as well.

Once you have installed CI on this repository, you’ll need to re-trigger Greenkeeper’s initial Pull Request. To do this, please delete the greenkeeper/initial branch in this repository, and then remove and re-add this repository to the Greenkeeper integration’s white list on Github. You'll find this list on your repo or organization’s settings page, under Installed GitHub Apps.

🚨 You need to enable Continuous Integration on all branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because we are using your CI build statuses to figure out when to notify you about breaking changes.

Since we did not receive a CI status on the greenkeeper/initial branch, we assume that you still need to configure it.

If you have already set up a CI for this repository, you might need to check your configuration. Make sure it will run on all new branches. If you don’t want it to run on every branch, you can whitelist branches starting with greenkeeper/.

We recommend using Travis CI, but Greenkeeper will work with every other CI service as well.

Once you have installed CI on this repository, you’ll need to re-trigger Greenkeeper’s initial Pull Request. To do this, please delete the greenkeeper/initial branch in this repository, and then remove and re-add this repository to the Greenkeeper integration’s white list on Github. You'll find this list on your repo or organization’s settings page, under Installed GitHub Apps.

🚨 You need to enable Continuous Integration on all branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because we are using your CI build statuses to figure out when to notify you about breaking changes.

Since we did not receive a CI status on the greenkeeper/initial branch, we assume that you still need to configure it.

If you have already set up a CI for this repository, you might need to check your configuration. Make sure it will run on all new branches. If you don’t want it to run on every branch, you can whitelist branches starting with greenkeeper/.

We recommend using Travis CI, but Greenkeeper will work with every other CI service as well.

Once you have installed CI on this repository, you’ll need to re-trigger Greenkeeper’s initial Pull Request. To do this, please delete the greenkeeper/initial branch in this repository, and then remove and re-add this repository to the Greenkeeper integration’s white list on Github. You'll find this list on your repo or organization’s settings page, under Installed GitHub Apps.

This is great. I'm doing something similar for assemble and verb as soon as the CLI is done (not the same, but we'll move some defaults into an external project to make it easier to unit test and create issues for that).

Suggestion: Instead of creating classes, it would probably be a better pattern to use Assemble's API to accomplish what you need. Since we don't have docs for the things you can use for this yet, I'll add some suggestions below.

Assemble's API has static and prototype methods for using plugins, either of which could accomplish what you're doing there in a more composable way - and using assemble's API, so it would be friendlier to other assemble users or for you when you work on other projects.

Example

function defaultConfig(options) {
  return function(app) {

    /**
     * Customize how templates are stored. This changes the
     * key of each template, so it's easier to lookup later
     */

    app.option('renameKey', function (fp) {
      return path.basename(fp, path.extname(fp));
    });

    app.preLayout(/\/content\/.*\.md/, function (view, next) {
      // don't add the default layout to partials, and account for 
      // templates that might define `null` to exclude the layout
      if (!view.isType('partial') && typeof view.layout === 'undefined') {
        view.layout = 'default';
      }
      next();
    });
  };
};

/**
 * A few options for using the plugin
 */

// "global" plugin - called in the constructor upon instantiation
// (in the plugin, `app` is the assemble **instance**). Although this 
// is really just an instance plugin, like the next example, these plugins
// will be called before other instance plugins, and on every instance created
assemble.use(defaultConfig());

// instance plugin - if you want to ensure that plugins are called immediately _after_ 
// instantiation, then use it as an instance plugin
// (in the plugin, `app` is the assemble **instance**)
var app = assemble();
app.use(defaultConfig());

// `mixin` - in rare cases, if you absolutely must modify the prototype, you
// can register the plugin as a `mixin`
// (in the plugin, `app` is the assemble **prototype**)
assemble.mixin(defaultConfig());

/**
 * You can wrap plugins too if you want
 */

function assembleScaffold(config) {
  return function(app) {
    this.origConfig = config;

    // plugins
    this.use(defaultConfig());
    this.use(foo());
    this.use(bar());
    this.use(baz());
  };
}

/**
 * And use them all together like this
 */

var assemble = require('assemble');

var app = assemble()
  .use(assembleScaffold());

Hope this helps.