eslint-plugin-cypress - npm Package Compare versions

Comparing version 2.1.3 to 2.2.0

docs/rules/no-assigning-return-values.md

 ## No Assigning Return Values
 
-See [the Cypress Best Practices guide](https://docs.cypress.io/guides/references/best-practices.html#Assigning-Return-Values).
+See [the Cypress Best Practices guide](https://on.cypress.io/best-practices#Assigning-Return-Values).

docs/rules/no-unnecessary-waiting.md

 ## No Assigning Return Values
 
-See [the Cypress Best Practices guide](https://docs.cypress.io/guides/references/best-practices.html#Unnecessary-Waiting).
+See [the Cypress Best Practices guide](https://on.cypress.io/best-practices#Unnecessary-Waiting).

index.js

@@ -7,2 +7,3 @@ const globals = require('globals')
     'no-unnecessary-waiting': require('./lib/rules/no-unnecessary-waiting'),
+    'assertion-before-screenshot': require('./lib/rules/assertion-before-screenshot'),
   },
@@ -9,0 +10,0 @@ configs: {

lib/rules/no-assigning-return-values.js

@@ -25,3 +25,3 @@ /**
       recommended: true,
-      url: 'https://docs.cypress.io/guides/references/best-practices.html#Assigning-Return-Values',
+      url: 'https://on.cypress.io/best-practices#Assigning-Return-Values',
     },
@@ -28,0 +28,0 @@ schema: [],

lib/rules/no-unnecessary-waiting.js

@@ -14,3 +14,3 @@ /**
       recommended: true,
-      url: 'https://docs.cypress.io/guides/references/best-practices.html#Unnecessary-Waiting',
+      url: 'https://on.cypress.io/best-practices#Unnecessary-Waiting',
     },
@@ -17,0 +17,0 @@ schema: [],

package.json

@@ -1,1 +0,1 @@
-{"name":"eslint-plugin-cypress","version":"2.1.3","description":"An ESLint plugin for projects using Cypress","main":"index.js","author":"Chris Breiding ([e-mail])","license":"MIT","keywords":["eslint","eslintplugin","cypress"],"repository":{"type":"git","url":"git+https://github.com/cypress-io/eslint-plugin-cypress.git"},"bugs":{"url":"https://github.com/cypress-io/eslint-plugin-cypress/issues"},"homepage":"https://github.com/cypress-io/eslint-plugin-cypress#readme","peerDependencies":{"eslint":">= 3.2.1"},"dependencies":{"globals":"^11.0.1"},"devDependencies":{"condition-circle":"1.5.0","eslint":"^5.7.0","eslint-plugin-cypress-dev":"1.1.2","github-post-release":"1.13.1","husky":"^0.14.3","jest":"^23.6.0","semantic-release":"8.2.0","simple-commit-message":"3.3.1"},"scripts":{"precommit":"npm run lint","lint":"eslint *.js","semantic-release":"semantic-release pre && npm publish --access public && semantic-release post","start":"yarn run test:watch","test":"jest","test-watch":"jest --watchAll"},"release":{"verifyConditions":"condition-circle","analyzeCommits":"simple-commit-message","generateNotes":"github-post-release"},"jest":{"testMatch":["**/tests/**/*.js"]}}
+{"name":"eslint-plugin-cypress","version":"2.2.0","description":"An ESLint plugin for projects using Cypress","main":"index.js","author":"Chris Breiding ([e-mail])","license":"MIT","keywords":["eslint","eslintplugin","cypress"],"repository":{"type":"git","url":"git+https://github.com/cypress-io/eslint-plugin-cypress.git"},"bugs":{"url":"https://github.com/cypress-io/eslint-plugin-cypress/issues"},"homepage":"https://github.com/cypress-io/eslint-plugin-cypress#readme","peerDependencies":{"eslint":">= 3.2.1"},"dependencies":{"globals":"^11.0.1"},"devDependencies":{"condition-circle":"1.5.0","eslint":"^5.7.0","eslint-plugin-cypress-dev":"1.1.2","github-post-release":"1.13.1","husky":"^0.14.3","jest":"^23.6.0","semantic-release":"8.2.0","simple-commit-message":"3.3.1"},"scripts":{"precommit":"npm run lint","lint":"eslint *.js","semantic-release":"semantic-release pre && npm publish --access public && semantic-release post","start":"yarn run test:watch","test":"jest","test-watch":"jest --watchAll"},"release":{"verifyConditions":"condition-circle","analyzeCommits":"simple-commit-message","generateNotes":"github-post-release"},"jest":{"testMatch":["**/tests/**/*.js"]}}

README.md

@@ -24,5 +24,2 @@ # Cypress ESLint Plugin
   ],
-  "extends": [
-    "plugin:cypress/recommended"
-  ],
   "env": {
@@ -36,12 +33,17 @@ "cypress/globals": true
 
-Rules are grouped by category to help you understand their purpose.
+These rules enforce some of the [best practices recommended for using Cypress](https://on.cypress.io/best-practices). Use them by adding the following to your eslint config:
 
-Rules with a check mark (✅) are enabled by default while using
-the `plugin:cypress/recommended` config.
+```json
+// my-project/cypress/.eslintrc.json
 
-The --fix option on the command line automatically fixes problems reported by
-rules which have a wrench (🔧) below.
+{
+  "extends": [
+    "plugin:cypress/recommended"
+  ]
+}
+```
 
+Rules with a check mark (✅) are enabled by default while using the `plugin:cypress/recommended` config.
 
-### Possible Errors
+**NOTE**: These rules currently require eslint 5.0 or greater. If you would like support added for eslint 4.x, please 👍  [this issue](https://github.com/cypress-io/eslint-plugin-cypress/issues/14).
 
@@ -52,2 +54,3 @@ |    | Rule ID | Description |
 | ✅ | [no-unnecessary-waiting](./docs/rules/no-unnecessary-waiting.md) | Prevent waiting for arbitrary time periods |
+| | [assertion-before-screenshot](./docs/rules/assertion-before-screenshot.md) | Ensure screenshots are preceded by an assertion |
 
@@ -54,0 +57,0 @@ ## Chai and `no-unused-expressions`

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

15805

increased by59.97%

Number of package files

15

increased by25%

Lines of code

304

increased by65.22%

Number of lines in readme file

88

increased by3.53%

No dependency changes