json-reporter - npm Package Compare versions

Comparing version 0.0.1 to 0.1.0

CHANGELOG.md

 # Change Log
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
+
+<a name="0.1.0"></a>
+# 0.1.0 (2017-03-01)
+
+
+### Bug Fixes
+
+* improve readme ([84272ce](https://github.com/gemini-testing/json-reporter/commit/84272ce))
+
+
+### Features
+
+* implement core functionality ([65fc627](https://github.com/gemini-testing/json-reporter/commit/65fc627))
+
+
+
+# Change Log
+
+All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.

package.json

 {
   "name": "json-reporter",
-  "version": "0.0.1",
+  "version": "0.1.0",
   "description": "Common plugin for gemini and hermione which is intended to aggregate the results of tests running",
@@ -38,2 +38,3 @@ "main": "gemini.js",
     "fs-extra": "^2.0.0",
+    "gemini-configparser": "^0.3.0",
     "lodash": "^4.17.4"
@@ -49,2 +50,3 @@ },
     "mocha": "^3.0.2",
+    "proxyquire": "^1.7.11",
     "sinon": "^1.17.5",
@@ -51,0 +53,0 @@ "standard-version": "^4.0.0"

README.md

 # json-reporter
 
-[![npm](https://img.shields.io/npm/v/json-reporter.svg?maxAge=2592000)](https://www.npmjs.com/package/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)
@@ -22,1 +22,62 @@ [![Coverage Status](https://img.shields.io/coveralls/gemini-testing/json-reporter.svg?style=flat)](https://coveralls.io/r/gemini-testing/json-reporter?branch=master)
 ```
+
+## 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)).
+
+### Gemini usage
+
+Add plugin to your `gemini` config file:
+
+```js
+module.exports = {
+    // ...
+    plugins: {
+        'json-reporter/gemini': {
+            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
+```

New alerts

Environment variable access

Supply chain risk

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

Found 1 instance in 1 package

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

Fixed alerts

Empty package

Supply chain risk

Package does not contain any code. It may be removed, is name squatting, or the result of a faulty package publish.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

29199

456.28%

Number of package files

16

166.67%

Lines of code

178

Infinity%

Number of lines in readme file

83

277.27%

Number of medium supply chain risk alerts

0

-100%

Worsened metrics

Dependency count

4

33.33%

Dev dependency count

10

11.11%

Number of low supply chain risk alerts

2

Infinity%

Dependency changes

• + Added

  gemini-configparser@^0.3.0

• + Added

  babel-runtime@5.8.38
  (transitive)

• + Added

  core-js@1.2.7
  (transitive)

• + Added

  gemini-configparser@0.3.0
  (transitive)

• + Added

  lodash@3.10.1
  (transitive)