featurama

Featurama

Removing the chaos from your features.

npm install featurama

To use:

var featurama = require('featurama')({
      featurePath: '/features',
      root: '/src'
    });

In /features (or whatever you specified as the featurePath):

module.exports = {
  featureName: 'Feature 1',
  buildTimeEnabled: false,
  runTimeEnabled: function() { return !!Modernizr.history; },
  jsFiles: [
    'feature1.js',
  ],
  vendorFiles: [],
  scssFiles: [
    '_feature1.scss',
  ],
};

---

featurama.isBuildTimeEnabled(buildTimeEnabled)

Return the boolean value or execute the function that defines if this feature is enabled or not.

Parameters

buildTimeEnabled: boolean | function, data from the config file that indicates enabled status

Returns: boolean, true if enabled

featurama.buildFeatureExclusions()

Build a list of files to exclude

Returns: object, object of arrays containing files to exclude

featurama.buildFeatureInclusions()

Build a list of files to include

Returns: object, object of arrays containing files to include

featurama.featureValuesList()

Get a list of all of the declared features, teir states, and file lists

Returns: object, Combined feature configs

featurama.featureList()

Build a key:value list of features and their enabled states

Returns: object, key: value pairs

---