eslint-plugin-should-promised - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

package.json

 {
   "name": "eslint-plugin-should-promised",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Eslint rule for checking that should-promised assertions return",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -29,2 +29,45 @@ # eslint-plugin-should-promised
 
-- [return-promise](docs/rules/return-promise.md)
+### Require promise assertions to return (return-promise)
+
+This rule is intended to be used with the [should-promised](https://www.npmjs.com/package/should-promised) plugin for the [should](https://www.npmjs.com/package/should) assertion library.
+
+When testing an async function by returning a promise to [mocha](https://www.npmjs.com/package/mocha) it is important to remember to actually return the promise. Forgetting to return will not cause the test case to fail.
+
+This rule will point out when a [should-promised](https://www.npmjs.com/package/should-promised) assertion is made without returning.
+
+#### Rule Details
+
+This rule looks for any of the properties `Promise`, `fulfilled`, `fulfilledWith`, `rejected`, `rejectedWith`, `finally` and `eventually`.
+
+The following patterns are considered warnings:
+
+```js
+describe('forgot to return the promise', function() {
+  it('warn when not returning the promise from should.be.fulfilled', function() {
+    thing.fn().should.be.fulfilled;
+  });
+
+  it('warn when not returning the promise from should.eventually', function() {
+    thing.fn().should.eventually.eql(1);
+  });
+});
+```
+
+These patterns would not be considered warnings:
+
+```js
+describe('forgot to return the promise', function() {
+  it('warn when not returning the promise from should.be.fulfilled', function() {
+    return thing.fn().should.be.fulfilled;
+  });
+
+  it('warn when not returning the promise from should.eventually', function() {
+    return thing.fn().should.eventually.eql(1);
+  });
+});
+```
+
+#### Further Reading
+
+- The [should](https://www.npmjs.com/package/should) assertion library
+- The [should-promised](https://www.npmjs.com/package/should-promised) plugin

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

Number of lines in readme file

73

increased by143.33%

Worsened metrics

Total package byte prevSize

9027

decreased by-0.47%

Number of package files

8

decreased by-11.11%

No dependency changes