A story reporter for the Karma test framework. Outputs test descriptions in hierarchical BDD-style user story format.

The easiest way is to keep karma-story-reporter as a devDependency in your package.json.

{
  "devDependencies": {
    "karma": "~0.10",
    "karma-story-reporter": "~0.1"
  }
}

You can simply do this with:

npm install karma-story-reporter --save-dev

Minimum configuration:

// karma.conf.js
module.exports = function(config) {
  config.set({
    reporters: ['story'],
  });
};

Only setting reporters to 'story' is required - storyReporter keys are optional.

// karma.conf.js
module.exports = function(config) {
  config.set({
    reporters: ['story'],
    // these are optional
    storyReporter: {
      showSkipped:        true, // default: false
      showSkippedSummary: true  // default: false
    }
  });
};

You can pass list of reporters as a CLI argument too:

karma start --reporters story,dots

• Output one browser at a time
• Suppress Karma's slow test output during test run
• Correctly indent sequential, un-nested describe blocks of same name (suites require unique ids instead of names)

For more information on Karma see the homepage.