cypress-localstorage-commands/src/plugin.js

Extends Cypress' cy commands with localStorage methods. Allows preserving localStorage between tests

const {
  GET_SNAPSHOT_TASK,
  SET_SNAPSHOT_TASK,
  CLEAR_SNAPSHOT_TASK,
  NODE_EVENTS_INSTALLED,
} = require("./constants");

const plugin = (on, config) => {
  const namedSnapshots = {};
  let globalSnapshot = {};

  if (config.expose === undefined) {
    config.env[NODE_EVENTS_INSTALLED] = true;
  } else {
    config.expose[NODE_EVENTS_INSTALLED] = true;
  }

  // Create cypress-local-storage-commands tasks
  on("task", {
    [GET_SNAPSHOT_TASK]: function (name) {
      return name ? namedSnapshots[name] || {} : globalSnapshot;
    },
    [SET_SNAPSHOT_TASK]: function ({ name, snapshot }) {
      if (name) {
        namedSnapshots[name] = snapshot;
      } else {
        globalSnapshot = snapshot;
      }
      return null;
    },
    [CLEAR_SNAPSHOT_TASK]: function (name) {
      if (name) {
        namedSnapshots[name] = {};
      } else {
        globalSnapshot = {};
      }
      return null;
    },
  });

  return config;
};

module.exports = plugin;