Merge pull request #2 from javierbrea/v1.0.0

V1.0.0

Author: javierbrea

.travis.yml

@@ -19,7 +19,6 @@ addons:
 script:
   - npm run lint
   - npm run test
-  # - npm run check-coverage
   - npm run coveralls
   - 'if [ "$TRAVIS_PULL_REQUEST" = "false" ]; then sonar-scanner; fi'
 

CHANGELOG.md

@@ -11,6 +11,12 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 ### Removed
 ### BREAKING CHANGES
 
+## [1.0.0] - 2019-10-26
+### Added
+- Add saveLocalStorage command
+- Add restoreLocalStorage command
+- Add clearLocalStorageSnapshot command
+
 ## [1.0.0-alpha.1] - 2019-10-26
 ### Added
 - Add package structure.

README.md

@@ -8,8 +8,6 @@
 
 Extends Cypress' cy commands with localStorage methods. Allows preserving localStorage between tests.
 
-> IMPORTANT NOTE: Current alpha version is not functional. This package is still in development.
-
 ## The problem
 
 You want to preserve localStorage between Cypress tests.
@@ -39,13 +37,16 @@ import 'cypress-localstorage-commands'
 You can now use all next commands:
 
 ```js
-cy.localStorageSave() // Save current localStorage values
+cy.saveLocalStorage() // Save current localStorage values into an internal "snapshot"
 ```
 
 ```js
-cy.localStorageRestore() // Restore localStorage to previously saved values
+cy.restoreLocalStorage() // Restore localStorage to previously "snapshot" saved values
 ```
 
+```js
+cy.clearLocalStorageSnapshot() // Clear localStorage "snapshot" values
+```
 
 ## Contributing
 

index.js

@@ -1 +1,5 @@
-require("./src/register");
+/* global Cypress, localStorage */
+
+const { register } = require("./src/register");
+
+register(Cypress, localStorage);

jest.config.js

@@ -0,0 +1,32 @@
+// For a detailed explanation regarding each configuration property, visit:
+// https://jestjs.io/docs/en/configuration.html
+
+module.exports = {
+  // Automatically clear mock calls and instances between every test
+  clearMocks: true,
+
+  // Indicates whether the coverage information should be collected while executing the test
+  collectCoverage: true,
+
+  // An array of glob patterns indicating a set of files for which coverage information should be collected
+  collectCoverageFrom: ["src/**"],
+
+  // The directory where Jest should output its coverage files
+  coverageDirectory: "coverage",
+
+  // An object that configures minimum threshold enforcement for coverage results
+  coverageThreshold: {
+    global: {
+      branches: 100,
+      functions: 100,
+      lines: 100,
+      statements: 100
+    }
+  },
+
+  // The test environment that will be used for testing
+  testEnvironment: "node",
+
+  // The glob patterns Jest uses to detect test files
+  testMatch: ["**/test/**/*.spec.js"]
+};