Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: update localStorage mock in “Running Tests” #5919

Merged
merged 1 commit into from
Dec 5, 2018

Conversation

phacks
Copy link
Contributor

@phacks phacks commented Nov 28, 2018

On a project running redux-persist, declaring the current localStorage mock would yield warnings in tests, making them harder to visually grep:

image

Redux Persists checks for three methods to detect if localStorage is defined: getItem, setItem and removeItem (see relevant code).

I suggest adding a removeItem mock to the docs as it fixes the warnings in tests.

On a project running [redux-persist](https://github.com/rt2zz/redux-persist), declaring the current `localStorage` mock would yield warnings in tests, making them harder to visually grep:

![image](https://user-images.githubusercontent.com/2587348/49158354-3c3f0200-f322-11e8-825d-2a68e0760af1.png)

Redux Persists checks for three methods to detect if `localStorage` is defined: `getItem`, `setItem` and `removeItem` ([see relevant code](https://github.com/rt2zz/redux-persist/blob/208c6b112ead87b3701dfacaae2cdbe78377775a/src/integration/getStoredStateMigrateV4.js#L31-L43)).

I suggest adding a `removeItem` mock to the docs as it fixes the warnings in tests.
@facebook-github-bot
Copy link

Thank you for your pull request and welcome to our community. We require contributors to sign our Contributor License Agreement, and we don't seem to have you on file. In order for us to review and merge your code, please sign up at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need the corporate CLA signed.

If you have received this in error or have any questions, please contact us at cla@fb.com. Thanks!

@facebook-github-bot
Copy link

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Facebook open source project. Thanks!

@phacks phacks changed the title Update localStorage mock in “Running Tests” Docs: update localStorage mock in “Running Tests” Nov 28, 2018
@iansu iansu added this to the 2.1.2 milestone Dec 5, 2018
@iansu iansu merged commit af0a854 into facebook:master Dec 5, 2018
@iansu
Copy link
Contributor

iansu commented Dec 5, 2018

Thanks!

timsnadden added a commit to timsnadden/create-react-app that referenced this pull request Dec 7, 2018
* master: (39 commits)
  Added extension to .eslintrc (facebook#5988)
  Update links to docs in all package README files (facebook#5912)
  Use https for linked images in docs to fix mixed content warnings (facebook#5985)
  Improve error messaging in verifyPackageTree.js (facebook#5974)
  Add removeItem to localStorage mock in docs (facebook#5919)
  Add SASS_PATH instructions to Sass docs (facebook#5917)
  Suggest a different default for speed reasons (facebook#5959)
  Add pre-eject message about new features in v2 (facebook#5954)
  Add netlify.toml to prepare for deploy to netlify facebook#5807 (facebook#5930)
  Correct some comments (facebook#5927)
  Add note to docs about using Sass and Flow together (facebook#5823)
  Update PWA link in README (facebook#5907)
  Add placeholders to template README for bit.ly links. (facebook#5808)
  Disable copy to clipboard in cra --info (facebook#5905)
  Support setupTests.ts (facebook#5698)
  Remove unnecessary whitespace in template HTML
  Run prettier on HTML files (facebook#5839)
  Some Grammar fixes (facebook#5858)
  Fix link to page about running tests (facebook#5883)
  fix: make typescriptformatter support 0.5 of fork checker (facebook#5879)
  ...
@lock lock bot locked and limited conversation to collaborators Jan 18, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants