Merge foretagsplatsen fork into core

circle.yml → .circleci/config.yml

@@ -5,15 +5,15 @@ workflows:
   main:
     jobs:
       - lint
-      - test-v4
       - test-v5
       - test-v6
+      - test-v7
       - release:
           requires:
             - lint
-            - test-v4
             - test-v5
             - test-v6
+            - test-v7
           filters:
             branches:
               only:
@@ -22,7 +22,7 @@ workflows:
 jobs:
   lint:
     docker:
-      - image: circleci/node:8
+      - image: circleci/node:14
     steps:
       - checkout
       - run:
@@ -32,45 +32,45 @@ jobs:
           name: Lint code
           command: npm run lint
 
-  test-v4:
+  test-v5:
     docker:
-      - image: circleci/node:8
+      - image: circleci/node:14
     steps:
       - checkout
       - run:
           name: Install dependencies
           command: npm install
       - run:
-          name: Test ESLint 4
-          command: npm run test:v4
+          name: Test ESLint 5
+          command: npm run test
 
-  test-v5:
+  test-v6:
     docker:
-      - image: circleci/node:8
+      - image: circleci/node:14
     steps:
       - checkout
       - run:
           name: Install dependencies
           command: npm install
       - run:
-          name: Test ESLint 5
-          command: npm run test
+          name: Test ESLint 6
+          command: npm run test:v6
 
-  test-v6:
+  test-v7:
     docker:
-      - image: circleci/node:8
+      - image: circleci/node:14
     steps:
       - checkout
       - run:
           name: Install dependencies
           command: npm install
       - run:
-          name: Test ESLint 6
-          command: npm run test:v6
+          name: Test ESLint 7
+          command: npm run test:v7
 
   release:
     docker:
-      - image: circleci/node:8
+      - image: circleci/node:14
     steps:
       - checkout
       - run:

.editorconfig

@@ -0,0 +1,14 @@
+root = true
+
+[*]
+insert_final_newline = true
+trim_trailing_whitespace = true
+charset = utf-8
+indent_style = space
+
+[*.{js,cjs,mjs}]
+indent_style = space
+indent_size = 2
+
+[*.json]
+indent_size = 2

.github/dependabot.yml

@@ -0,0 +1,7 @@
+version: 2
+updates:
+  - package-ecosystem: "npm"
+    directory: "/"
+    open-pull-requests-limit: 1000 # we don't want to limit PRs
+    schedule:
+      interval: "weekly"

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npm run lint

.ignore

@@ -0,0 +1 @@
+.git

README.md

@@ -114,18 +114,24 @@ These rules enforce some of the [best practices recommended for using Cypress](h
 
 Rules with a check mark (✅) are enabled by default while using the `plugin:cypress/recommended` config.
 
-**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).
-
-|     | Rule ID                                                                    | Description                                                     |
-| :-- | :------------------------------------------------------------------------- | :-------------------------------------------------------------- |
-| ✅  | [no-assigning-return-values](./docs/rules/no-assigning-return-values.md)   | Prevent assigning return values of cy calls                     |
-| ✅  | [no-unnecessary-waiting](./docs/rules/no-unnecessary-waiting.md)           | Prevent waiting for arbitrary time periods                      |
-| ✅  | [no-async-tests](./docs/rules/no-async-tests.md)                           | Prevent using async/await in Cypress test case                  |
-|     | [no-force](./docs/rules/no-force.md)                                       | Disallow using `force: true` with action commands               |
-|     | [assertion-before-screenshot](./docs/rules/assertion-before-screenshot.md) | Ensure screenshots are preceded by an assertion                 |
-|     | [require-data-selectors](./docs/rules/require-data-selectors.md)           | Only allow data-\* attribute selectors (require-data-selectors) |
-|     | [no-pause](./docs/rules/no-pause.md)           | Disallow `cy.pause()` parent command |
-
+|    | Rule ID                                                                                  | Description                                                     |
+|:---|:-----------------------------------------------------------------------------------------|:----------------------------------------------------------------|
+| ✅ | [no-assigning-return-values](./docs/rules/no-assigning-return-values.md)                 | Prevent assigning return values of cy calls                     |
+| ✅ | [no-unnecessary-waiting](./docs/rules/no-unnecessary-waiting.md)                         | Prevent waiting for arbitrary time periods                      |
+| ✅ | [no-async-tests](./docs/rules/no-async-tests.md)                                         | Prevent using async/await in Cypress test case                  |
+|    | [no-force](./docs/rules/no-force.md)                                                     | Disallow using `force: true` with action commands               |
+|    | [assertion-before-screenshot](./docs/rules/assertion-before-screenshot.md)               | Ensure screenshots are preceded by an assertion                 |
+|    | [require-data-selectors](./docs/rules/require-data-selectors.md)                         | Only allow data-\* attribute selectors (require-data-selectors) |
+|    | [no-pause](./docs/rules/no-pause.md)                                                     | Disallow `cy.pause()` parent command                            |
+|    | [no-single-expect-in-then-or-should](./docs/rules/no-single-expect-in-then-or-should.md) | Simplify tests by avoiding lonely expect()                      |
+|    | [no-expect-for-stub](./docs/rules/no-expect-for-stub.md)                                 | Avoid expect(stub)…                                             |
+|    | [no-useless-then-or-should](./docs/rules/no-useless-then-or-should.md)                   | Avoid `.should()` and `.then()` when only wrapping commands     |
+
+## Creating a rule
+Use the `make-rule` script for an interactive guide to scaffold out the rule with associated spec and documentation files.
+```sh
+npm run make-rule
+```
 ## Chai and `no-unused-expressions`
 
 Using an assertion such as `expect(value).to.be.true` can fail the ESLint rule `no-unused-expressions` even though it's not an error in this case. To fix this, you can install and use [eslint-plugin-chai-friendly](https://www.npmjs.com/package/eslint-plugin-chai-friendly).
@@ -161,7 +167,8 @@ Or you can simply add its `recommended` config:
 
 To add a new rule:
   * Fork and clone this repository
-  * Generate a new rule (a [yeoman generator](https://github.com/eslint/generator-eslint) is available)
+  * Install dependencies with `npm install`
+  * Generate a new rule with `npm run make-rule`
   * Run `yarn start` or `npm start`
   * Write test scenarios then implement logic
   * Describe the rule in the generated `docs` file
@@ -170,3 +177,7 @@ To add a new rule:
   * Create a PR
 
 Use the following commit message conventions: https://github.com/semantic-release/semantic-release#commit-message-format
+
+## Community Recognition
+
+This package was made with the help and contribution of [Damien Cassou](https://github.com/DamienCassou).

docs/rules/no-expect-for-stub.md

@@ -0,0 +1,49 @@
+# Avoid expect(stub)… (no-expect-for-stub)
+
+Disallow usage of `expect()` with a [Sinon-Chai
+chainer](https://docs.cypress.io/guides/references/assertions#Sinon-Chai)
+(e.g., `expect(stub).to.have.been.calledOnce`) preferring the usage of
+`should()`.
+
+Some problems reported by this rule are automatically fixable by the
+`--fix` command line option. Please be aware that fixing the code with
+this rule requires that the stub is aliased (using the [`.as()`
+Cypress command](https://docs.cypress.io/api/commands/as)): if that's
+not the case, you will have to add an alias manually for the test to
+pass.
+
+## Rule Details
+
+This rule makes code easier to read when `expect()` is used on a stub
+with [Sinon-Chai chainer
+chainer](https://docs.cypress.io/guides/references/assertions#Sinon-Chai).
+
+Example of **incorrect** code for this rule:
+
+```js
+let onBudgetChanged = cy.stub().as("onBudgetChanged");
+// … do something with onBudgetChanged…
+
+cy.get("foo").click();
+
+cy.then(() => {
+	expect(onBudgetChanged).to.be.called;
+});
+```
+
+Note that the `expect()` call is wrapped in a `cy.then()`. This is
+mandatory if the `expect()` is to be called after the Cypress commands
+above it which is usually the case.
+
+Example of **correct** code for this rule:
+
+```js
+// do something with cy.stub().as("onBudgetChanged")
+cy.get("foo").click();
+cy.get("@onBudgetChanged").should("be.called");
+```
+
+## When Not To Use It
+
+- When you don't mind having code that is harder to read than necessary.
+- When you don't want to add aliases to the stubs/spies.

docs/rules/no-single-expect-in-then-or-should.md

@@ -0,0 +1,35 @@
+# Simplify tests by avoiding lonely expect()
+
+Disallow usage of expect() statements when they are alone in a
+`then()` or `should()`.
+
+Some problems reported by this rule are automatically fixable by the
+`--fix` command line option.
+
+## Rule Details
+
+This rule makes code easier to read when both conditions are met:
+1. a `then()` (or `should()`) contains a single call to `expect()` and
+2. the `then()` (or `should()`) has the same argument as `expect()`.
+
+Example of **incorrect** code for this rule:
+
+```js
+cy.wait("@PutCountry")
+  .its("request.body.userIds")
+  .then((userIds) => {
+    expect(userIds).to.have.members(expectedUserIds);
+  });
+```
+
+Example of **correct** code for this rule:
+
+```js
+cy.wait("@PutCountry")
+  .its("request.body.userIds")
+  .should("have.members", expectedUserIds);
+```
+
+## When Not To Use It
+
+When you don't mind having code that is harder to read than necessary.

docs/rules/no-useless-then-or-should.md

@@ -0,0 +1,32 @@
+# Avoid `.should()` and `.then()` when only wrapping commands (no-useless-then-or-should)
+
+.should()` and `.then()` can be removed when they only wrap commands
+and their function argument doesn't take any argument.
+
+## Rule Details
+
+This rule simplifies code by removing unneeded calls to `cy.should()`
+and `cy.then()`.
+
+Examples of **incorrect** code for this rule:
+
+```js
+cy.then(() => cy.contains("foo"))
+
+cy.should(() => {
+  cy.get("@stub").should("have.been.called");
+  cy.contains("foo");
+})
+```
+
+Examples of **correct** code for this rule:
+
+```js
+cy.contains("foo")
+
+cy.get("@stub").should("have.been.called");
+```
+
+## When Not To Use It
+
+When you don't mind having code that is harder to read than necessary.

index.js

@@ -6,6 +6,9 @@ module.exports = {
     'no-unnecessary-waiting': require('./lib/rules/no-unnecessary-waiting'),
     'no-async-tests': require('./lib/rules/no-async-tests'),
     'assertion-before-screenshot': require('./lib/rules/assertion-before-screenshot'),
+    'no-single-expect-in-then-or-should': require('./lib/rules/no-single-expect-in-then-or-should'),
+    'no-useless-then-or-should': require('./lib/rules/no-useless-then-or-should'),
+    'no-expect-for-stub': require('./lib/rules/no-expect-for-stub'),
     'require-data-selectors': require('./lib/rules/require-data-selectors'),
     'no-force': require('./lib/rules/no-force'),
     'no-pause': require('./lib/rules/no-pause'),