Merge branch 'main' into add-tests-stale-dependents

.github/pull_request_template.md

@@ -8,4 +8,4 @@ Fixes #
 
 ## Check List
 
-- [ ] `yarn run prettier` for formatting code and docs
+- [ ] `pnpm run prettier` for formatting code and docs

.github/workflows/compressed-size-action.yml

@@ -8,7 +8,13 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v2
-      - uses: preactjs/compressed-size-action@v2
+      - uses: actions/checkout@v3
+      - uses: pnpm/action-setup@v2
+        with:
+          version: 8.2.0
+      - uses: actions/setup-node@v3
         with:
-          repo-token: "${{ secrets.GITHUB_TOKEN }}"
+          node-version: 18
+          cache: 'pnpm'
+          cache-dependency-path: '**/pnpm-lock.yaml'
+      - uses: preactjs/compressed-size-action@v2

.github/workflows/lint-and-type.yml

@@ -10,16 +10,16 @@ jobs:
   lint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2
+      - uses: actions/checkout@v3
+      - uses: pnpm/action-setup@v2
         with:
-          node-version: '18'
-          cache: yarn
-      - run: git fetch --depth=1 origin +refs/tags/*:refs/tags/*
-      - run: yarn install --frozen-lockfile --check-files
-      - name: Prettier
-        run: yarn prettier:ci
-      - name: Lint
-        run: yarn eslint:ci
-      - name: Type
-        run: yarn pretest
+          version: 8.2.0
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18
+          cache: 'pnpm'
+          cache-dependency-path: '**/pnpm-lock.yaml'
+      - run: pnpm install --frozen-lockfile
+      - run: pnpm test:format
+      - run: pnpm test:types
+      - run: pnpm test:lint

.github/workflows/livecodes-preview.yml

@@ -7,8 +7,16 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
+      - uses: pnpm/action-setup@v2
+        with:
+          version: 8.2.0
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18
+          cache: 'pnpm'
+          cache-dependency-path: '**/pnpm-lock.yaml'
       - uses: live-codes/preview-in-livecodes@v1
         with:
-          install-command: "yarn install --frozen-lockfile --check-files"
-          build-command: "yarn build"
+          install-command: "pnpm install --frozen-lockfile"
+          build-command: "pnpm build"
           base-url: "https://{{LC::REF}}.preview-in-livecodes-demo.pages.dev"

.github/workflows/test-multiple-builds.yml

@@ -15,18 +15,21 @@ jobs:
         build: [cjs, esm, umd]
         env: [development, production]
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2
+      - uses: actions/checkout@v3
+      - uses: pnpm/action-setup@v2
         with:
-          node-version: '18'
-          cache: yarn
-      - run: git fetch --depth=1 origin +refs/tags/*:refs/tags/*
-      - run: yarn install --frozen-lockfile --check-files
-      - run: yarn build
+          version: 8.2.0
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18
+          cache: 'pnpm'
+          cache-dependency-path: '**/pnpm-lock.yaml'
+      - run: pnpm install --frozen-lockfile
+      - run: pnpm build
       - name: Use React 17 for production test
         if: ${{ matrix.env == 'production' }}
         run: |
-          yarn add -D [email protected] [email protected] @testing-library/[email protected]
+          pnpm add -D [email protected] [email protected] @testing-library/[email protected]
       - name: Patch for DEV-ONLY
         if: ${{ matrix.env == 'development' }}
         run: |
@@ -65,6 +68,6 @@ jobs:
           NODE_ENV: ${{ matrix.env }}
       - name: Test ${{ matrix.build }} ${{ matrix.env }}
         run: |
-          yarn test:ci:build # test:ci
+          pnpm test-build:spec # test:spec
         env:
           NODE_ENV: ${{ matrix.env }}

.github/workflows/test-multiple-versions.yml

@@ -10,17 +10,18 @@ jobs:
   test:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2
+      - uses: actions/checkout@v3
+      - uses: pnpm/action-setup@v2
         with:
-          node-version: '18'
-          cache: yarn
-      - run: git fetch --depth=1 origin +refs/tags/*:refs/tags/*
-      - run: yarn install --frozen-lockfile --check-files
-      - name: Test Build # we don't have any other workflows to test build
-        run: yarn build
-      - name: Test Default
-        run: yarn test:ci
+          version: 8.2.0
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18
+          cache: 'pnpm'
+          cache-dependency-path: '**/pnpm-lock.yaml'
+      - run: pnpm install --frozen-lockfile
+      - run: pnpm build # we don't have any other workflows to test build
+      - run: pnpm test:spec
 
   test_matrix:
     runs-on: ubuntu-latest
@@ -36,25 +37,28 @@ jobs:
           - 18.3.0-canary-4b84f1161-20240318
           - 0.0.0-experimental-4b84f1161-20240318
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2
+      - uses: actions/checkout@v3
+      - uses: pnpm/action-setup@v2
+        with:
+          version: 8.2.0
+      - uses: actions/setup-node@v3
         with:
-          node-version: '18'
-          cache: yarn
-      - run: git fetch --depth=1 origin +refs/tags/*:refs/tags/*
-      - run: yarn install --frozen-lockfile --check-files
+          node-version: 18
+          cache: 'pnpm'
+          cache-dependency-path: '**/pnpm-lock.yaml'
+      - run: pnpm install --frozen-lockfile
       - name: Install legacy testing-library
         if: ${{ startsWith(matrix.react, '16.') || startsWith(matrix.react, '17.') }}
-        run: yarn add -D @testing-library/[email protected]
+        run: pnpm add -D @testing-library/[email protected]
       - name: Patch for React 16
         if: ${{ startsWith(matrix.react, '16.') }}
         run: |
           sed -i~ '1s/^/import React from "react";/' tests/*/*.tsx tests/*/*/*.tsx
           sed -i~ 's/"jsx": "react-jsx"/"jsx": "react"/' tsconfig.json
           sed -i~ 's/import\.meta\.env[?]\.MODE/"DEVELOPMENT".toLowerCase()/' src/*.ts src/*/*.ts src/*/*/*.ts
       - name: Test Build # we need to build for babel tests
-        run: yarn build
+        run: pnpm build
       - name: Test ${{ matrix.react }}
         run: |
-          yarn add -D react@${{ matrix.react }} react-dom@${{ matrix.react }}
-          yarn test:ci
+          pnpm add -D react@${{ matrix.react }} react-dom@${{ matrix.react }}
+          pnpm test:spec

.github/workflows/test-old-typescript.yml

@@ -31,14 +31,17 @@ jobs:
           - 3.9.7
           - 3.8.3
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2
+      - uses: actions/checkout@v3
+      - uses: pnpm/action-setup@v2
         with:
-          node-version: '18'
-          cache: yarn
-      - run: git fetch --depth=1 origin +refs/tags/*:refs/tags/*
-      - run: yarn install --frozen-lockfile --check-files
-      - run: yarn build
+          version: 8.2.0
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18
+          cache: 'pnpm'
+          cache-dependency-path: '**/pnpm-lock.yaml'
+      - run: pnpm install --frozen-lockfile
+      - run: pnpm build
       - name: Patch for Newer TS
         if: ${{ matrix.typescript == '4.9.5' || matrix.typescript == '4.8.4' }}
         run: |
@@ -66,34 +69,23 @@ jobs:
           sed -i~ 's/"jsx": "react-jsx",/"jsx": "react",/' tsconfig.json
           sed -i~ 's/"noUncheckedIndexedAccess": true,//' tsconfig.json
           sed -i~ 's/^import type /import /' tests/*/*.tsx tests/*/*/*.tsx
-          yarn json -I -f package.json -e "this.resolutions={};  this.resolutions['@types/prettier']='2.4.2'; this.resolutions['@types/node']='18.11.18';"
-          yarn add -D @types/[email protected] @types/[email protected] @types/[email protected] @types/[email protected]
+          pnpm json -I -f package.json -e "this.resolutions={};  this.resolutions['@types/prettier']='2.4.2'; this.resolutions['@types/node']='18.11.18';"
+          pnpm add -D @types/[email protected] @types/[email protected] @types/[email protected] @types/[email protected]
           rm -r tests/react/vanilla-utils/atomWithObservable.*
       - name: Install old TypeScript
-        run: yarn add -D typescript@${{ matrix.typescript }}
+        run: pnpm add -D typescript@${{ matrix.typescript }}
       - name: Patch testing setup for Old TS
         if: ${{ matrix.typescript == '4.4.4' || matrix.typescript == '4.3.5' || matrix.typescript == '4.2.3' || matrix.typescript == '4.1.5' ||  matrix.typescript == '4.0.5' || startsWith(matrix.typescript, '3.') }}
         run: |
-          rm node_modules/@vitest/expect/dist/*.d.ts
-          echo "declare module '@vitest/expect'" >> ./src/types.d.ts
-          rm node_modules/@vitest/runner/dist/*.d.ts
-          echo "declare module '@vitest/runner'" >> ./src/types.d.ts
-          rm node_modules/@vitest/spy/dist/*.d.ts
-          echo "declare module '@vitest/spy'" >> ./src/types.d.ts
-          rm node_modules/@vitest/utils/dist/*.d.ts
-          echo "declare module '@vitest/utils'" >> ./src/types.d.ts
-          rm node_modules/vite-node/dist/*.d.ts
-          echo "declare module 'vite-node'" >> ./src/types.d.ts
-          rm node_modules/vitest/dist/*.d.ts
-          echo "declare module 'vitest'" >> ./src/types.d.ts
+          pnpm add -D [email protected] @vitest/[email protected] @vitest/[email protected]
       - name: Patch testing setup for older TS
         if: ${{ matrix.typescript == '4.0.5' || startsWith(matrix.typescript, '3.') }}
         run: |
-          yarn add -D @testing-library/[email protected] @testing-library/[email protected]
+          pnpm add -D @testing-library/[email protected] @testing-library/[email protected]
           rm node_modules/vitest/dist/*.d.ts
           echo "declare module 'vitest'" >> ./src/types.d.ts
       - name: Test ${{ matrix.typescript }}
         run: |
           rm -r node_modules/@types/babel__core/node_modules
           sed -i~ 's/">=4.2": {/">=4.1": {/' node_modules/rxjs/package.json
-          yarn tsc --noEmit
+          pnpm test:types

CONTRIBUTING.md

@@ -19,25 +19,25 @@ If you would like to contribute by fixing an open issue or developing a new feat
 1. Fork this repository
 2. Create a new feature branch based off the `main` branch
 3. Follow the [Core lib](#core-lib) and/or the [docs](#docs) guide below and come back to this once done
-4. Run `yarn run prettier` to format the code
+4. Run `pnpm run prettier` to format the code
 5. Git stage your required changes and commit (review the commit guidelines below)
 6. Submit the PR for review
 
 ### Core lib
 
-1. Install dependencies by running `yarn`. We use [version 1](https://classic.yarnpkg.com/lang/en/docs/install) of yarn
+1. Install dependencies by running `pnpm`.
 2. Create failing tests for your fix or new feature in the `tests` folder
 3. Implement your changes
-4. Build the library `yarn run build` _(Pro-tip: `yarn run build-watch` runs the build in watch mode)_
-5. Run the tests and ensure that they pass. _(Pro-tip: `yarn test:dev` runs the test in watch mode)_
-6. You can use `yarn link` or `yalc` to sym-link this package and test it locally on your own project. Alternatively, you may use CodeSandbox CI's canary releases to test the changes in your own project (requires a PR to be created first)
+4. Build the library `pnpm run build` _(Pro-tip: `pnpm run build-watch` runs the build in watch mode)_
+5. Run the tests and ensure that they pass.
+6. You can use `pnpm link` or `yalc` to sym-link this package and test it locally on your own project. Alternatively, you may use CodeSandbox CI's canary releases to test the changes in your own project (requires a PR to be created first)
 7. Follow step 4 and onwards from the [general](#general) guide above to bring it to the finish line
 
 ### Docs
 
 1. Navigate to the `website` folder. Eg. `cd website`
-2. Install dependencies by running `yarn` in the `website` folder We use [version 1](https://classic.yarnpkg.com/lang/en/docs/install) of yarn
-3. Run `yarn dev` to start the dev server
+2. Install dependencies by running `pnpm` in the `website` folder
+3. Run `pnpm dev` to start the dev server
 4. Navigate to [`http://localhost:9000`](http://localhost:9000) to view the docs
 5. Navigate to the `docs` folder and make necessary changes to the docs
 6. Add your changes to the docs and see them live reloaded in the browser
@@ -49,7 +49,7 @@ We follow the [conventional commit spec](https://www.conventionalcommits.org/en/
 
 Your commit type must be one of the following:
 
-- **build**: Changes that affect the build system or external dependencies (example scopes: yarn, npm, rollup, etc.)
+- **build**: Changes that affect the build system or external dependencies (example scopes: pnpm, npm, rollup, etc.)
 - **ci**: Changes to our CI configuration files and scripts (example scopes: GitHub Actions)
 - **docs**: Documentation only changes
 - **feat**: A new feature

docs/extensions/immer.mdx

@@ -15,7 +15,7 @@ npm i immer jotai-immer
 
 ## atomWithImmer
 
-`atomWithImmer` creates a new atom similar to the regular [`atom`](../core/atom.mdx) [atom] with a different `writeFunction`. In this bundle, we don't have read-only atoms, because the point of these functions is the immer produce(mutability) function.
+`atomWithImmer` creates a new atom similar to the regular [`atom`](../core/atom.mdx) with a different `writeFunction`. In this bundle, we don't have read-only atoms, because the point of these functions is the immer produce(mutability) function.
 The signature of writeFunction is `(get, set, update: (draft: Draft<Value>) => void) => void`.
 
 ```jsx

docs/extensions/query.mdx

@@ -30,19 +30,18 @@ npm i jotai-tanstack-query @tanstack/query-core wonka
 You can incrementally adopt `jotai-tanstack-query` in your app. It's not an all or nothing solution. You just have to ensure you are using the same QueryClient instance. [QueryClient Setup](#referencing-the-same-instance-of-query-client-in-your-project).
 
 ```jsx
-# existing useQueryHook
-  const { data, isPending, isError } = useQuery({
-    queryKey: ['todos'],
-    queryFn: fetchTodoList
-  });
-
-# jotai-tanstack-query
-  const todosAtom = atomWithQuery(() => ({
-    queryKey: ['todos'],
-  }))
+// existing useQueryHook
+const { data, isPending, isError } = useQuery({
+  queryKey: ['todos'],
+  queryFn: fetchTodoList,
+})
 
-  const [{ data, isPending, isError }] = useAtom(todosAtom)
+// jotai-tanstack-query
+const todosAtom = atomWithQuery(() => ({
+  queryKey: ['todos'],
+}))
 
+const [{ data, isPending, isError }] = useAtom(todosAtom)
 ```
 
 ### Exported functions

docs/guides/debugging.mdx

@@ -73,6 +73,7 @@ const countAtom = atom(0)
 function Counter() {
   const [count, setCount] = useAtom(countAtom)
   useAtomDevtools(countAtom)
+}
 ```
 
 Now if we try `setCount`, we can see that the Redux Dev Tools logs those changes immediately.

docs/guides/migrating-to-v2-api.mdx

@@ -209,7 +209,7 @@ const allAtom = waitForAll([fooAtom, barAtom])
 const allAtom = atom((get) => Promise.all([get(fooAtom), get(barAtom)]))
 ```
 
-Note that creating an atom in render function can cause [infinite loop](../api/atom.mdx#note-about-creating-an-atom-in-render-function)
+Note that creating an atom in render function can cause [infinite loop](../core/atom.mdx#note-about-creating-an-atom-in-render-function)
 
 #### `splitAtom` util (or some other utils) with async atoms
 

docs/guides/performance.mdx

@@ -98,7 +98,7 @@ But Jotai also provides its set of tools to handle the "when" our atoms should t
 - Out of the box, Jotai encourages you to split your data into atomic parts, hence each atom is stored separately and will only trigger a re-render when their own value change
 - `selectAtom` allows you to subscribe to specific part of a large object and only re-render on value change
 - `focusAtom` same as selectAtom, but creating a new atom for the part, giving a setter to update that specific part easily
-- `splitAtom` does the work of selectAtom/focus atom for a dynamic list
+- `splitAtom` does the work of selectAtom/focusAtom for a dynamic list
 
 While this seems simplistic, it is simple to reason about. That was the goal, let's keep it simple to keep it fast.
 

docs/guides/persistence.mdx

@@ -53,7 +53,7 @@ const atomWithLocalStorage = (key, initialValue) => {
 
 ### A helper function with AsyncStorage and JSON parse
 
-This requires [onMount](../core/atom.mdx#on-mount).
+This requires [onMount](../core/atom.mdx#onmount-property).
 
 ```js
 const atomWithAsyncStorage = (key, initialValue) => {

docs/recipes/atom-with-refresh.mdx

@@ -5,4 +5,4 @@ keywords: creators,refresh
 ---
 
 `atomWithRefresh` has been provided by `jotai/utils` since v2.7.0.
-[Jump to the doc](../utilities/resettable.mdx#atomWithRefresh)
+[Jump to the doc](../utilities/resettable.mdx#atomwithrefresh)

docs/recipes/large-objects.mdx

@@ -42,7 +42,7 @@ const initialData = {
 
 ## focusAtom
 
-> `focusAtom` creates a new atom, based on the focus that you pass to it. [jotai-optics](../extensions/optics.mdx#focus-atom)
+> `focusAtom` creates a new atom, based on the focus that you pass to it. [jotai-optics](../extensions/optics.mdx#focusatom)
 
 We use this utility to focus an atom and create an atom from a specific part of the data. For example we may need to consume the people property of the above data, Here's how we do it:
 

docs/utilities/ssr.mdx

@@ -1,7 +1,7 @@
 ---
 title: SSR
 nav: 3.02
-keywords: ssr,server,hydrate,hydration,next,nextjs,gatsby,remix,framework
+keywords: ssr,server,hydrate,hydration,next,nextjs,gatsby,remix,waku,framework
 ---
 
 ## useHydrateAtoms