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

fix(docs): Update usage without React on recipes.mdx #2047

Merged
merged 4 commits into from
Sep 14, 2023

Conversation

ivanquirino
Copy link
Contributor

I've noticed that the usage without React in the recipes section of the documentation shows a deprecated use, which is different from the usage from the readme. This PR makes the recipes usage inline with the readme one.

Makes recipes.mdx usage without React inline with the readme.md description, because the current recipes.mdx usage is deprecated
@vercel
Copy link

vercel bot commented Sep 11, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
zustand-demo ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 13, 2023 1:29am

@codesandbox-ci
Copy link

codesandbox-ci bot commented Sep 11, 2023

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 439cdfb:

Sandbox Source
React Configuration
React TypeScript Configuration
React Browserify Configuration
React Snowpack Configuration
React Parcel Configuration
Next.js Configuration
@pavlobu/zustand demo Configuration

Copy link
Member

@dai-shi dai-shi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

I'm a bit worried about the duplication between readme.md and redupes.mdx.
There's a historical reason, but if someone has an idea to improve it, it's welcome.
cc: @dbritto-dev @sewera @chrisk-7777

docs/recipes/recipes.mdx Outdated Show resolved Hide resolved
ivanquirino and others added 2 commits September 12, 2023 18:21
Change copy

Co-authored-by: Blazej Sewera <code@sewera.dev>
@dai-shi
Copy link
Member

dai-shi commented Sep 12, 2023

I think the docs should implicitly be for the current version of Zustand.

@sewera It's how described in readme.md. Maybe, it's time to revisit.

@ivanquirino
Copy link
Contributor Author

I don't know why it is failing. I've read the job log but no idea.

@dbritto-dev
Copy link
Collaborator

I don't know why it is failing. I've read the job log but no idea.

just run yarn prettier

@ivanquirino
Copy link
Contributor Author

I don't know why it is failing. I've read the job log but no idea.

just run yarn prettier

I did this PR directly on github and missed that. Thank you.

@dai-shi dai-shi changed the title Update usage without React on recipes.mdx fix(docs): Update usage without React on recipes.mdx Sep 14, 2023
@dai-shi dai-shi merged commit deba6ed into pmndrs:main Sep 14, 2023
31 checks passed
bodinsamuel referenced this pull request in specfy/specfy Nov 8, 2023
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [zustand](https://togithub.com/pmndrs/zustand) | [`4.4.1` ->
`4.4.6`](https://renovatebot.com/diffs/npm/zustand/4.4.1/4.4.6) |
[![age](https://developer.mend.io/api/mc/badges/age/npm/zustand/4.4.6?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/zustand/4.4.6?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/zustand/4.4.1/4.4.6?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/zustand/4.4.1/4.4.6?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>pmndrs/zustand (zustand)</summary>

### [`v4.4.6`](https://togithub.com/pmndrs/zustand/releases/tag/v4.4.6)

[Compare
Source](https://togithub.com/pmndrs/zustand/compare/v4.4.5...v4.4.6)

v4.4.5 has an issue with some TypeScript configs about module
resolution. It should be fixed now. Thanks for the patience.

#### What's Changed

- Update export types by
[@&#8203;dbritto-dev](https://togithub.com/dbritto-dev) in
[https://github.com/pmndrs/zustand/pull/2170](https://togithub.com/pmndrs/zustand/pull/2170)

#### New Contributors

- [@&#8203;cheatkey](https://togithub.com/cheatkey) made their first
contribution in
[https://github.com/pmndrs/zustand/pull/2147](https://togithub.com/pmndrs/zustand/pull/2147)
- [@&#8203;frixaco](https://togithub.com/frixaco) made their first
contribution in
[https://github.com/pmndrs/zustand/pull/2166](https://togithub.com/pmndrs/zustand/pull/2166)

**Full Changelog**:
pmndrs/zustand@v4.4.5...v4.4.6

### [`v4.4.5`](https://togithub.com/pmndrs/zustand/releases/tag/v4.4.5)

[Compare
Source](https://togithub.com/pmndrs/zustand/compare/v4.4.4...v4.4.5)

Hopefully, it should fix some issues with Node.js environment including
Next.js.

#### What's Changed

- fix: importing CJS React in ESM by
[@&#8203;dai-shi](https://togithub.com/dai-shi) in
[https://github.com/pmndrs/zustand/pull/2154](https://togithub.com/pmndrs/zustand/pull/2154)
- Apply publint recommendations by
[@&#8203;dbritto-dev](https://togithub.com/dbritto-dev) in
[https://github.com/pmndrs/zustand/pull/2157](https://togithub.com/pmndrs/zustand/pull/2157)

#### New Contributors

- [@&#8203;plrs9816](https://togithub.com/plrs9816) made their first
contribution in
[https://github.com/pmndrs/zustand/pull/2137](https://togithub.com/pmndrs/zustand/pull/2137)
- [@&#8203;Brammm](https://togithub.com/Brammm) made their first
contribution in
[https://github.com/pmndrs/zustand/pull/2139](https://togithub.com/pmndrs/zustand/pull/2139)
- [@&#8203;sobies93](https://togithub.com/sobies93) made their first
contribution in
[https://github.com/pmndrs/zustand/pull/2142](https://togithub.com/pmndrs/zustand/pull/2142)

**Full Changelog**:
pmndrs/zustand@v4.4.4...v4.4.5

### [`v4.4.4`](https://togithub.com/pmndrs/zustand/releases/tag/v4.4.4)

[Compare
Source](https://togithub.com/pmndrs/zustand/compare/v4.4.3...v4.4.4)

There was a tiny issue in v4.4.3, which broke with some bundlers, which
this version fixes.

#### What's Changed

- fix(build): patch entry points zustand/shallow for CJS by
[@&#8203;dai-shi](https://togithub.com/dai-shi) in
[https://github.com/pmndrs/zustand/pull/2128](https://togithub.com/pmndrs/zustand/pull/2128)

**Full Changelog**:
pmndrs/zustand@v4.4.3...v4.4.4

### [`v4.4.3`](https://togithub.com/pmndrs/zustand/releases/tag/v4.4.3)

[Compare
Source](https://togithub.com/pmndrs/zustand/compare/v4.4.2...v4.4.3)

The changes in v4.4.2 were troublesome for some users. This version
should fix/mitigate such cases.

#### What's Changed

- fix(shallow): Extract shallow vanilla and react by
[@&#8203;dbritto-dev](https://togithub.com/dbritto-dev) in
[https://github.com/pmndrs/zustand/pull/2097](https://togithub.com/pmndrs/zustand/pull/2097)
- fix(types): mitigate devtools typing by
[@&#8203;dai-shi](https://togithub.com/dai-shi) in
[https://github.com/pmndrs/zustand/pull/2099](https://togithub.com/pmndrs/zustand/pull/2099)

**Full Changelog**:
pmndrs/zustand@v4.4.2...v4.4.3

### [`v4.4.2`](https://togithub.com/pmndrs/zustand/releases/tag/v4.4.2)

[Compare
Source](https://togithub.com/pmndrs/zustand/compare/v4.4.1...v4.4.2)

This adds `useShallow` hook to cover some use cases that are deprecated
with v4.4.0 change. Check out [the
guide](https://togithub.com/pmndrs/zustand/blob/ec538e9d4c0b9b5759e6dfd0fd3c9a21f8236949/docs/guides/prevent-rerenders-with-use-shallow.md).

##### Migration Guide

[#&#8203;1991](https://togithub.com/pmndrs/zustand/issues/1991) requires
something like below if you are using the `devtools` middleware *and*
TypeScript.

```diff
  import { devtools } from 'zustand/middleware'
+ import type {} from '@&#8203;redux-devtools/extension'
```

##### What's Changed

- fix(types)(middleware/devtools): avoid copying types by
[@&#8203;dai-shi](https://togithub.com/dai-shi) in
[https://github.com/pmndrs/zustand/pull/1991](https://togithub.com/pmndrs/zustand/pull/1991)
- fix(traditional): make defaultEqualityFn optional in TS Types by
[@&#8203;charkour](https://togithub.com/charkour) in
[https://github.com/pmndrs/zustand/pull/2060](https://togithub.com/pmndrs/zustand/pull/2060)
- feat: add useShallow by
[@&#8203;FaberVitale](https://togithub.com/FaberVitale) in
[https://github.com/pmndrs/zustand/pull/2090](https://togithub.com/pmndrs/zustand/pull/2090)

##### New Contributors

- [@&#8203;aykutkardas](https://togithub.com/aykutkardas) made their
first contribution in
[https://github.com/pmndrs/zustand/pull/1993](https://togithub.com/pmndrs/zustand/pull/1993)
- [@&#8203;michelts](https://togithub.com/michelts) made their first
contribution in
[https://github.com/pmndrs/zustand/pull/1997](https://togithub.com/pmndrs/zustand/pull/1997)
- [@&#8203;elusive](https://togithub.com/elusive) made their first
contribution in
[https://github.com/pmndrs/zustand/pull/2001](https://togithub.com/pmndrs/zustand/pull/2001)
- [@&#8203;mayank1513](https://togithub.com/mayank1513) made their first
contribution in
[https://github.com/pmndrs/zustand/pull/2015](https://togithub.com/pmndrs/zustand/pull/2015)
- [@&#8203;fdb](https://togithub.com/fdb) made their first contribution
in
[https://github.com/pmndrs/zustand/pull/2029](https://togithub.com/pmndrs/zustand/pull/2029)
- [@&#8203;tmkx](https://togithub.com/tmkx) made their first
contribution in
[https://github.com/pmndrs/zustand/pull/2032](https://togithub.com/pmndrs/zustand/pull/2032)
- [@&#8203;OshriAsulin](https://togithub.com/OshriAsulin) made their
first contribution in
[https://github.com/pmndrs/zustand/pull/2028](https://togithub.com/pmndrs/zustand/pull/2028)
- [@&#8203;ivanquirino](https://togithub.com/ivanquirino) made their
first contribution in
[https://github.com/pmndrs/zustand/pull/2047](https://togithub.com/pmndrs/zustand/pull/2047)
- [@&#8203;stavkamil](https://togithub.com/stavkamil) made their first
contribution in
[https://github.com/pmndrs/zustand/pull/2071](https://togithub.com/pmndrs/zustand/pull/2071)
- [@&#8203;NaamuKim](https://togithub.com/NaamuKim) made their first
contribution in
[https://github.com/pmndrs/zustand/pull/2088](https://togithub.com/pmndrs/zustand/pull/2088)
- [@&#8203;FaberVitale](https://togithub.com/FaberVitale) made their
first contribution in
[https://github.com/pmndrs/zustand/pull/2090](https://togithub.com/pmndrs/zustand/pull/2090)

**Full Changelog**:
pmndrs/zustand@v4.4.1...v4.4.2

</details>

---

### Configuration

📅 **Schedule**: Branch creation - "after 4pm every weekday" in timezone
Europe/Paris, Automerge - At any time (no schedule defined).

🚦 **Automerge**: Enabled.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/specfy/specfy).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy40Ni4wIiwidXBkYXRlZEluVmVyIjoiMzcuNDYuMCIsInRhcmdldEJyYW5jaCI6ImNob3JlL3Jlbm92YXRlQmFzZUJyYW5jaCJ9-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants