https://github.com/gemini-testing/json-reporter

Common json reporter for gemini and hermione
https://github.com/gemini-testing/json-reporter

gemini-plugin hermione-plugin json-report

Last synced: about 2 months ago
JSON representation

Common json reporter for gemini and hermione

• Host: GitHub
• URL: https://github.com/gemini-testing/json-reporter
• Owner: gemini-testing
• License: mit
• Created: 2017-02-06T09:49:46.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2024-04-22T13:28:30.000Z (9 months ago)
• Last Synced: 2024-04-28T04:48:39.331Z (8 months ago)
• Topics: gemini-plugin, hermione-plugin, json-report
• Language: JavaScript
• Size: 156 KB
• Stars: 1
• Watchers: 6
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Authors: AUTHORS

Awesome Lists containing this project

README

        
# json-reporter

[![npm](https://img.shields.io/npm/v/json-reporter.svg)](https://www.npmjs.com/package/json-reporter)

[![Build Status](https://travis-ci.org/gemini-testing/json-reporter.svg?branch=master)](https://travis-ci.org/gemini-testing/json-reporter)

Common plugin for:

* [testplane](https://github.com/gemini-testing/testplane)

* [hermione](https://github.com/gemini-testing/testplane/tree/hermione)

which is intended to aggregate the results of tests running.

You can read more about testplane plugins [here](https://github.com/gemini-testing/testplane/blob/master/docs/config.md#plugins).

## Installation

```bash

npm install json-reporter

```

## Usage

Plugin has following configuration:

* **enabled** (optional) `Boolean` – enable/disable the plugin; by default plugin is enabled

* **path** (optional) `String` - path for saving json report file; by default json report will be saved into `json-reporter.json` inside current work directory.

Also there is ability to override plugin parameters by CLI options or environment variables

(see [configparser](https://github.com/gemini-testing/configparser)).

### Testplane usage

Add plugin to your `testplane` config file:

```ts

export default {

    // ...

    plugins: {

        'json-reporter/testplane': {

            enabled: true,

            path: 'my/custom/report.json'

        }

    },

    //...

}

```

### Hermione usage

Add plugin to your `hermione` config file:

```js

module.exports = {

    // ...

    plugins: {

        'json-reporter/hermione': {

            enabled: true,

            path: 'my/custom/report.json'

        }

    },

    //...

}

```

## Testing

Run [mocha](http://mochajs.org) tests:

```bash

npm run test-unit

```

Run tests with [istanbul](https://github.com/gotwarlost/istanbul) coverage calculation:

```bash

npm run cover

```

Run [eslint](http://eslint.org) codestyle verification

```bash

npm run lint

```