Merge pull request #10 from javierbrea/v1.1.0

V1.1.0

Author: javierbrea

.gitignore

@@ -8,6 +8,10 @@
 
 # tests
 /coverage
+/test-acceptance/app/build
+/test-acceptance/app/node_modules
+/test-acceptance/app/cypress/screenshots
+/test-acceptance/app/cypress/fixtures
 
 # misc
 .DS_Store

.travis.yml

@@ -1,14 +1,20 @@
 language: node_js
 
 node_js:
-  - "10"
+  - 10.8
 
 cache:
   directories:
-    - "node_modules"
-    - "$HOME/.sonar/cache"
+    - ~/.npm
+    - ~/.cache
+    - node_modules
+    - test-acceptance/app/node_modules
+    - ~/.sonar/cache
 
 addons:
+  apt:
+    packages:
+      - libgconf-2-4
   sonarcloud:
     organization: "javierbrea"
     token:
@@ -19,6 +25,12 @@ addons:
 script:
   - npm run lint
   - npm run test
+  - cd test-acceptance/app
+  - npm ci
+  - npm run cypress:install
+  - npm run cypress:verify
+  - npm run test:ci
+  - cd ../..
   - npm run coveralls
   - 'if [ "$TRAVIS_PULL_REQUEST" = "false" ]; then sonar-scanner; fi'
 

CHANGELOG.md

@@ -11,6 +11,16 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 ### Removed
 ### BREAKING CHANGES
 
+## [1.1.0] - 2019-10-27
+### Added
+- Add getLocalStorage command
+- Add setLocalStorage command
+- Add removeLocalStorage command
+- Add acceptance tests
+
+### Changed
+- Improve documentation
+
 ## [1.0.0] - 2019-10-26
 ### Added
 - Add saveLocalStorage command

README.md

@@ -31,21 +31,65 @@ npm i --save-dev cypress-localstorage-commands
 Add this line to your project's `cypress/support/commands.js`:
 
 ```js
-import 'cypress-localstorage-commands'
+import "cypress-localstorage-commands"
 ```
 
 You can now use all next commands:
 
+### Commands
+
+Save current localStorage values into an internal "snapshot":
+
+```js
+cy.saveLocalStorage();
+```
+
+Restore localStorage to previously "snapshot" saved values:
+
 ```js
-cy.saveLocalStorage() // Save current localStorage values into an internal "snapshot"
+cy.restoreLocalStorage();
 ```
 
+Clear localStorage "snapshot" values:
+
+```js
+cy.clearLocalStorageSnapshot();
+```
+
+Get localStorage item. Equivalent to `localStorage.getItem` in browser:
+
 ```js
-cy.restoreLocalStorage() // Restore localStorage to previously "snapshot" saved values
+cy.getLocalStorage("item");
 ```
 
+Set localStorage item. Equivalent to `localStorage.setItem` in browser:
+
+```js
+cy.setLocalStorage("item", "value");
+```
+
+Remove localStorage item. Equivalent to `localStorage.removeItem` in browser:
+
+```js
+cy.removeLocalStorage("item");
+```
+
+### Preserving local storage between tests
+
+Use `saveLocalStorage` to save a snapshot of current `localStorage` at the end of one test, and use the `restoreLocalStorage` command to restore it at the beginning of another one:
+
 ```js
-cy.clearLocalStorageSnapshot() // Clear localStorage "snapshot" values
+it("should hide privacy policy message on click accept cookies button", () => {
+  cy.get("#accept-cookies").click();
+  cy.get("#privacy-policy").should("not.be.visible");
+  cy.saveLocalStorage();
+});
+
+it("should not show privacy policy message after reloading page", () => {
+  cy.restoreLocalStorage();
+  cy.reload();
+  cy.get("#privacy-policy").should("not.be.visible");
+});
 ```
 
 ## Contributing

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "cypress-localstorage-commands",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Extends Cypress' cy commands with localStorage methods. Allows preserving localStorage between tests",
   "keywords": [
     "cypress",
@@ -22,16 +22,18 @@
   "main": "index.js",
   "scripts": {
     "coveralls": "cat ./coverage/lcov.info | coveralls",
-    "lint": "eslint src test",
+    "lint": "eslint src test test-acceptance/app/src test-acceptance/app/cypress",
     "lint-staged": "lint-staged",
     "test": "jest"
   },
   "dependencies": {},
   "devDependencies": {
+    "babel-eslint": "^10.0.3",
     "coveralls": "^3.0.7",
     "eslint": "6.6.0",
     "eslint-config-prettier": "^6.4.0",
     "eslint-plugin-prettier": "^3.1.1",
+    "eslint-plugin-react": "^7.16.0",
     "husky": "^3.0.9",
     "jest": "^24.9.0",
     "lint-staged": "^9.4.2",
@@ -43,7 +45,9 @@
   },
   "lint-staged": {
     "src/**/*.js": "eslint",
-    "test/**/*.js": "eslint"
+    "test/**/*.js": "eslint",
+    "test-acceptance/app/src/**/*.js": "eslint",
+    "test-acceptance/app/cypress/**/*.js": "eslint"
   },
   "husky": {
     "hooks": {

package.json

@@ -1,14 +1,14 @@
 sonar.organization=javierbrea
 sonar.projectKey=cypress-localstorage-commands
-sonar.projectVersion=1.0.0
+sonar.projectVersion=1.1.0
 
 sonar.javascript.file.suffixes=.js
 sonar.sourceEncoding=UTF-8
-sonar.exclusions=node_modules/**
-sonar.coverage.exclusions=test/**/*,index.js,jest.config.js
+sonar.exclusions=node_modules/**,test-acceptance/app/node_modules/**
+sonar.coverage.exclusions=test/**/*,index.js,jest.config.js,test-acceptance/**/*
 sonar.javascript.lcov.reportPaths=coverage/lcov.info
 sonar.host.url=https://sonarcloud.io
 
 sonar.issue.ignore.multicriteria=j1
 sonar.issue.ignore.multicriteria.j1.ruleKey=javascript:S4144
-sonar.issue.ignore.multicriteria.j1.resourceKey=test/**/*
+sonar.issue.ignore.multicriteria.j1.resourceKey=test/**/*,test-acceptance/**/*