https://github.com/sublimino/karma-story-reporter

A Karma plugin. Report results in a hierarchical BDD-style user story format.
https://github.com/sublimino/karma-story-reporter

Last synced: about 1 month ago
JSON representation

A Karma plugin. Report results in a hierarchical BDD-style user story format.

• Host: GitHub
• URL: https://github.com/sublimino/karma-story-reporter
• Owner: sublimino
• License: mit
• Created: 2013-09-20T16:22:36.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2015-03-13T14:13:55.000Z (almost 10 years ago)
• Last Synced: 2024-10-07T17:35:50.973Z (2 months ago)
• Language: JavaScript
• Homepage:
• Size: 438 KB
• Stars: 7
• Watchers: 2
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# karma-story-reporter

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

## Installation

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

```json

{

  "devDependencies": {

    "karma": "~0.10",

    "karma-story-reporter": "~0.1"

  }

}

```

You can simply do this with:

```bash

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

```

## Configuration

Minimum configuration:

```js

// karma.conf.js

module.exports = function(config) {

  config.set({

    reporters: ['story'],

  });

};

```

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

```js

// 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:

```bash

karma start --reporters story,dots

```

## Todo

- 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].

[homepage]: http://karma-runner.github.com