byzantine - npm Package Compare versions

Comparing version 1.0.0 to 1.1.0

package.json

 {
   "name": "byzantine",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "istanbul coverage json parser",
@@ -28,3 +28,6 @@ "main": "index.js",
   },
-  "homepage": "https://github.com/pveyes/byzantine#readme"
+  "homepage": "https://github.com/pveyes/byzantine#readme",
+  "devDependencies": {
+    "jest": "^21.2.1"
+  }
 }

README.md

 # Byzantine
 
 > Istanbul json coverage parser
+
+## Install
+
+Byzantine expects node 6
+
+```sh
+yarn add byzantine
+# or
+npm install byzantine --save
+```
+
+## Usage
+
+Byzantine has 2 module: `parse` and `aggregate`:
+
+```js
+const parse = require('byzantine');
+const aggregate = require('byzantine/aggregate');
+const json = require('./coverage/coverage-final.json');
+
+// returns Array<Coverage>
+const coverages = parse(json);
+// returns CoverageAggregate
+const { statements, branches, functions } = aggregate(coverages);
+```
+
+The main module (`byzantine`) returns array of simplified coverage information.
+
+```js
+type Coverage {
+  path: String
+  statements: CoverageData
+  branches: CoverageData
+  functions: CoverageData
+}
+
+type CoverageData {
+  covered: Int
+  all: Int
+}
+```
+
+`aggregate` returns percentage of coverage for each category in `Float`, or `null` for empty array
+
+```js
+type CoverageAggregate {
+  statements: ?Float
+  branches: ?Float
+  functions: ?Float
+}
+```
+
+## License
+
+MIT

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

90297

increased by3127.2%

Number of package files

8

increased by166.67%

Lines of code

187

increased by114.94%

Number of lines in readme file

59

increased by1375%

Worsened metrics

Dev dependency count

1

increased byInfinity%

No dependency changes