chai-roughly-v2 - npm Package Compare versions

Comparing version 2.0.8 to 2.0.9

index.js

 const debug = require('debug')
 const deep_eql = require('deep-eql')
 
-const log = debug('chai-roughly')
+const log = debug('chai-roughly-v2')
 
@@ -6,0 +6,0 @@ module.exports = function (chai, utils) {

package.json

 {
   "name": "chai-roughly-v2",
-  "version": "2.0.8",
+  "version": "2.0.9",
   "description": "deep equals assertions with tolerance for chai (with fixed dependency on deep-eql)",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -1,29 +0,29 @@
-
 chai-roughly
 ==============================================================================
 
-[![Build Status](https://travis-ci.org/Turbo87/chai-roughly.svg?branch=master)](https://travis-ci.org/Turbo87/chai-roughly)
-[![Build status](https://ci.appveyor.com/api/projects/status/github/Turbo87/chai-roughly?svg=true)](https://ci.appveyor.com/project/Turbo87/chai-roughly/branch/master)
-[![npm](https://img.shields.io/npm/v/chai-roughly.svg)](https://www.npmjs.com/package/chai-roughly)
+![CI Build](https://github.com/micdah/chai-roughly/actions/workflows/ci.yml/badge.svg)
+[![npm](https://img.shields.io/npm/v/chai-roughly-v2.svg)](https://www.npmjs.com/package/chai-roughly-v2)
 
-deep equals assertions with tolerance for chai
+deep equals assertions with tolerance for chai.
 
+### Why a v2?
 
-Installation
-------------------------------------------------------------------------------
+This is a forked version from [Turbo87/chai-roughly](https://github.com/Turbo87/chai-roughly), which have been updated
+to use the latest version of [chaijs/deep-eql](https://github.com/chaijs/deep-eql), rather than using a modified forked
+version.
 
+## Installation
+
+```shell
+npm install --save-dev chai-roughly-v2
 ```
-npm install --save-dev chai-roughly
-```
 
-Usage
-------------------------------------------------------------------------------
+## Usage
 
-After importing `chai` add the following code to use `chai-roughly` assertions:
+After importing `chai` add the following code to use `chai-roughly-v2` assertions:
 
 ```js
-var chai = require('chai');
-var expect = chai.expect;
+const chai = require('chai');
 
-chai.use(require('chai-roughly'));
+chai.use(require('chai-roughly-v2'));
 ```
@@ -37,10 +37,9 @@
 ```js
-it('works', function() {
-  expect({ value: 42 }).to.roughly.deep.equal({ value: 41.9999999 });
+it('works', function () {
+    expect({value: 42}).to.roughly.deep.equal({value: 41.9999999});
 });
 ```
 
+## License
 
-License
-------------------------------------------------------------------------------
 chai-roughly is licensed under the [MIT License](LICENSE).

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

Worsened metrics

Total package byte prevSize

5324

decreased by-2.56%

Number of lines in readme file

45

decreased by-2.17%

No dependency changes