Merge pull request #385 from javierbrea/release

Release v1.7.0

Author: javierbrea

.eslintrc.js

@@ -0,0 +1,37 @@
+module.exports = {
+  env: {
+    node: true,
+    es6: true,
+  },
+  parserOptions: {
+    ecmaVersion: 2018,
+  },
+  plugins: ["prettier", "jest", "no-only-tests", "mocha"],
+  rules: {
+    "prettier/prettier": [
+      "error",
+      {
+        printWidth: 99,
+        parser: "flow",
+      },
+    ],
+    "no-shadow": [2, { builtinGlobals: true, hoist: "all" }],
+    "no-undef": "error",
+    "no-unused-vars": ["error", { vars: "all", args: "after-used", ignoreRestSiblings: false }],
+    "mocha/no-setup-in-describe": [0],
+    "mocha/no-mocha-arrows": [0],
+    "no-only-tests/no-only-tests": [2],
+    "jest/expect-expect": [0],
+  },
+  extends: ["prettier", "plugin:jest/recommended", "plugin:mocha/recommended"],
+  overrides: [
+    {
+      files: ["test-e2e/**/integration/*.js"],
+      rules: {
+        "jest/valid-expect": [0],
+        "jest/valid-expect-in-promise": [0],
+      },
+    },
+  ],
+  root: true,
+};

.eslintrc.json

@@ -11,7 +11,7 @@ jobs:
     strategy:
       matrix:
         # NodeJS v17 still not supported in tests due to incompatibility with react-scripts
-        node: ["12.22.7", "14.16.1", "15.14.0", "16.13.0"]
+        node: ["12.22.7", "14.16.1", "16.13.0", "17.5.0"]
     steps:
       - name: Checkout
         uses: actions/checkout@v2
@@ -39,6 +39,8 @@ jobs:
         run: npm ci
       - name: Lint
         run: npm run lint
+      - name: Check types
+        run: npm run tsc
       - name: Test unit
         run: npm run test:unit
       - name: Test mutation

.github/workflows/build.yml

@@ -8,6 +8,7 @@
 
 # tests
 /coverage
+/dist
 
 # misc
 .DS_Store

.gitignore

@@ -11,6 +11,20 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 ### Removed
 ### BREAKING CHANGES
 
+## [1.7.0] - 2022-02-22
+
+### Added
+- feat(#376): Support multiple snapshots allowing to define a name in save, restore and clear commands.
+- chore: Add command to check types. Run it in build workflow
+- chore: Add eslint plugins
+
+### Removed
+- docs: Remove broken dependencies badge
+
+### Changed
+- chore: Remove NodeJs v15 from tests workflow. Add NodeJs v17
+- chore(deps): Update devDependencies
+
 ## [1.6.1] - 2021-11-11
 ### Changed
 - chore(#382): Use Cypress v9 in E2E tests

CHANGELOG.md

@@ -1,6 +1,6 @@
 [![Build status][build-image]][build-url] [![Coverage Status][coveralls-image]][coveralls-url] [![Quality Gate][quality-gate-image]][quality-gate-url] [![Mutation testing status][mutation-image]][mutation-url]
 
-[![NPM dependencies][npm-dependencies-image]][npm-dependencies-url] [![Renovate](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com) [![Last commit][last-commit-image]][last-commit-url] [![Last release][release-image]][release-url]
+[![Renovate](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com) [![Last commit][last-commit-image]][last-commit-url] [![Last release][release-image]][release-url]
 
 [![NPM downloads][npm-downloads-image]][npm-downloads-url] [![License][license-image]][license-url] [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fjavierbrea%2Fcypress-localstorage-commands.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fjavierbrea%2Fcypress-localstorage-commands?ref=badge_shield)
 
@@ -39,18 +39,24 @@ You can now use all next commands:
 
 ### Commands
 
-##### `cy.saveLocalStorage()`
+##### `cy.saveLocalStorage([snapshotName])`
 
 Saves current localStorage values into an internal "snapshot".
 
-##### `cy.restoreLocalStorage()`
+* `snapshotName` _(String)_: Optionally, a `snapshotName` can be provided, and then data from localStorage will be saved into a snapshot with that name. So, multiple snapshots can be stored.
 
-Restores localStorage to previously "snapshot" saved values.
+##### `cy.restoreLocalStorage([snapshotName])`
 
-##### `cy.clearLocalStorageSnapshot()`
+Restores localStorage to previously "snapshot" saved values. __
+
+* `snapshotName` _(String)_: Optional. If provided, the localStorage will be restored using data from that specific snapshot.
+
+##### `cy.clearLocalStorageSnapshot([snapshotName])`
 
 Clears localStorage "snapshot" values, so previously saved values are cleaned.
 
+* `snapshotName` _(String)_: Optional. If provided, only data from that specific snapshot will be cleared.
+
 ##### `cy.getLocalStorage(item)`
 
 Gets localStorage item. Equivalent to `localStorage.getItem` in browser.
@@ -153,6 +159,44 @@ describe("localStorage cookies-accepted item", () => {
 });
 ```
 
+#### Named snapshots
+
+Next example shows how named snapshots can be used to storage different states of `localStorage` and restore one or another depending of the test:
+
+```js
+describe("Accept cookies button", () => {
+  const COOKIES_BUTTON = "#accept-cookies";
+
+  before(() => {
+    cy.clearLocalStorageSnapshot();
+  });
+
+  it("should be visible", () => {
+    cy.visit("/");
+    cy.get(COOKIES_BUTTON).should("be.visible");
+    cy.saveLocalStorage("cookies-not-accepted");
+  });
+
+  it("should not exist after clicked", () => {
+    cy.get(COOKIES_BUTTON).click();
+    cy.get(COOKIES_BUTTON).should("not.exist");
+    cy.saveLocalStorage("cookies-accepted");
+  });
+
+  it("should be visible when cookies are not accepted", () => {
+    cy.restoreLocalStorage("cookies-not-accepted");
+    cy.visit("/");
+    cy.get(COOKIES_BUTTON).should("be.visible");
+  });
+
+  it("should not exist when cookies are accepted", () => {
+    cy.restoreLocalStorage("cookies-accepted");
+    cy.visit("/");
+    cy.get(COOKIES_BUTTON).should("not.exist");
+  });
+});
+```
+
 ### Disabling localStorage
 
 Use `cy.disableLocalStorage()` to simulate that `localStorage` is disabled, producing that any invocation to `localStorage.setItem`, `localStorage.getItem`, `localStorage.removeItem` or `localStorage.clear` will throw an error. [As MDN docs recommend](https://developer.mozilla.org/en-US/docs/Web/API/Storage/setItem), _"developers should make sure to always catch possible exceptions from setItem()"_. This command allows to test that possible exceptions are handled correctly.
@@ -263,8 +307,6 @@ MIT, see [LICENSE](./LICENSE) for details.
 [license-url]: https://github.com/javierbrea/cypress-localstorage-commands/blob/master/LICENSE
 [npm-downloads-image]: https://img.shields.io/npm/dm/cypress-localstorage-commands.svg
 [npm-downloads-url]: https://www.npmjs.com/package/cypress-localstorage-commands
-[npm-dependencies-image]: https://img.shields.io/david/javierbrea/cypress-localstorage-commands.svg
-[npm-dependencies-url]: https://david-dm.org/javierbrea/cypress-localstorage-commands
 [quality-gate-image]: https://sonarcloud.io/api/project_badges/measure?project=javierbrea_cypress-localstorage-commands&metric=alert_status
 [quality-gate-url]: https://sonarcloud.io/dashboard?id=javierbrea_cypress-localstorage-commands
 [release-image]: https://img.shields.io/github/release-date/javierbrea/cypress-localstorage-commands.svg

README.md

@@ -4,21 +4,24 @@ declare namespace Cypress {
   interface Chainable {
     /**
      * Command to save current localStorage values into an internal "snapshot"
+     * @param {string} snapshotName - Name of the snapshot
      * @example cy.saveLocalStorage()
     */
-    saveLocalStorage(): Chainable<undefined>
+    saveLocalStorage(snapshotName?: string): Chainable<undefined>
 
     /**
      * Command to restore localStorage to previously "snapshot" saved values
+     * @param {string} snapshotName - Name of the snapshot
      * @example cy.restoreLocalStorage()
     */
-    restoreLocalStorage(): Chainable<undefined>
+    restoreLocalStorage(snapshotName?: string): Chainable<undefined>
 
     /**
      * Command to clear localStorage "snapshot" values
+     * @param {string} snapshotName - Name of the snapshot
      * @example cy.clearLocalStorageSnapshot()
     */
-    clearLocalStorageSnapshot(): Chainable<undefined>
+    clearLocalStorageSnapshot(snapshotName?: string): Chainable<undefined>
 
     /**
      * Command to get localStorage item value