vnfmarket/src/main/webapp/vnfmarket/node_modules/karma-spec-reporter/README.md

   1 # karma-spec-reporter
   2
   3 [![Join the chat at https://gitter.im/mlex/karma-spec-reporter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/mlex/karma-spec-reporter?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![Build Status](https://travis-ci.org/mlex/karma-spec-reporter.svg)](https://travis-ci.org/mlex/karma-spec-reporter)
   4
   5 Test reporter, that prints detailed results to console (similar to mocha's spec reporter).
   6
   7 ## Usage
   8
   9 To use in your own Node.js project, just execute
  10 ```
  11 npm install karma-spec-reporter --save-dev
  12 ```
  13 This will download the karma-spec-reporter and add the dependency to `package.json`.
  14
  15 Then add ``'spec'`` to reporters in karma.conf.js, e.g.
  16
  17 ```
  18 reporters: ['spec']
  19 ```
  20
  21 Take a look at the [karma-spec-reporter-example](http://github.com/mlex/karma-spec-reporter-example) repository to see the reporter in action.
  22
  23 ## Configuration
  24
  25 To limit the number of lines logged per test or suppress specific reporting, use the `specReporter` configuration in your
  26 karma.conf.js file
  27 ``` js
  28 //karma.conf.js
  29 ...
  30   config.set({
  31     ...
  32       reporters: ["spec"],
  33       specReporter: {
  34         maxLogLines: 5,         // limit number of lines logged per test
  35         suppressErrorSummary: true,  // do not print error summary
  36         suppressFailed: false,  // do not print information about failed tests
  37         suppressPassed: false,  // do not print information about passed tests
  38         suppressSkipped: true  // do not print information about skipped tests
  39       },
  40       plugins: ["karma-spec-reporter"],
  41     ...
  42 ```
  43
  44 ## Contributing
  45
  46 ### Running tests
  47
  48 To run the tests for the index.js file, run: `npm test`
  49
  50 ### Generating Coverage
  51
  52 To see the coverage report for the module, run: `npm run coverage`