V5 : Split package, formatter support and Jotai 2.20 support by Wendystraite · Pull Request #5 · Wendystraite/jotai-logger

Wendystraite · 2026-05-02T14:43:10Z

Future V5 API.

Checks

Splitting Vanilla and React imports
Ability to provide a custom formatter
Future Jotai 2.20 "rev3" API support
Replace jotai and jotai-devtools packages versions in package.json when jotai is out
Internal refactor with less hacks to track states

What's new ?

Split the package into vanilla/react/formatter entry points

Split the core logger from its console formatter.
The core handle only scheduling and filtering options and accepts a new formatter option.
The new consoleFormatter factory creates the built in console formatter and accepts the old display options (domain, logger, colorScheme, etc.).
Add the formatter option to bindAtomsLoggerToStore and useAtomsLogger to replace the default console output with any custom function.

Replace the mutation-based API with a derived-store API

The store is no longer mutated. Instead, createLoggedStore returns a new store that shares all internal state with the parent but intercepts get, set and sub for logging.
On the React side, AtomLoggerProvider propagates the logged store to children via a Jotai <Provider>, retrieving the parent store from context automatically.
This approach aligns with Jotai's internal INTERNAL_buildStoreRev2 API introduced in jotai v2.15 (see feat(internals): External building blocks surface pmndrs/jotai#3149)).

Jotai 2.20 "Rev3" API support

Waiting for Jotai 2.20 due to a future breaking change in pmndrs/jotai#3293.

See milestone: https://github.com/pmndrs/jotai/milestone/120.

Breaking changes

A migration guide from v4 to v5 is present in the README.

Migration:

only jotai 2.20.0 and up is supported due to changes in their internal APIs.
formatting options that were present in bindAtomsLoggerToStore and useAtomsLogger are now moved to the new consoleFormatter factory options.
- Before: bindAtomsLoggerToStore(store, { stringifyLimit: 100 })
- After: createLoggedStore(store, { formatter: consoleFormatter({ stringifyLimit: 100 }) })
useAtomsLogger is replaced by AtomLoggerProvider, a Provider-like component that automatically picks up the nearest Jotai store from context and wraps children in a new logged store.
bindAtomsLoggerToStore is replaced by createLoggedStore that creates and return a new store.
isAtomsLoggerBoundToStore removed → use isLoggedStore
createLoggedStore throws instead of returning false

Split the core logger from its console formatter. The core handle only scheduling and filtering options and accepts a new `formatter` option. The new `consoleFormatter` factory creates the built in console formatter and accepts the old display options (`domain`, `logger`, `colorScheme`, etc.). Add the `formatter` option to `bindAtomsLoggerToStore` and `useAtomsLogger` to replace the default console output with any custom function. BREAKING CHANGE: formatting options that were present in `bindAtomsLoggerToStore` and `useAtomsLogger` are now moved to the new `consoleFormatter` factory options. Migration: Before: `bindAtomsLoggerToStore(store, { stringifyLimit: 100 })` After: `bindAtomsLoggerToStore(store, { formatter: consoleFormatter({ stringifyLimit: 100 }) })`

codecov · 2026-05-02T14:44:04Z

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

BREAKING CHANGE: rename logger's type AtomsLoggerOptions to AtomLoggerOptions

The store is no longer mutated. Instead, `createLoggedStore` returns a **new** store that shares all internal state with the parent but intercepts `get`, `set` and `sub` for logging. On the React side, `AtomLoggerProvider` propagates the logged store to children via a Jotai `<Provider>`, retrieving the parent store from context automatically. This approach aligns with Jotai's internal `INTERNAL_buildStoreRev2` API introduced in jotai v2.15 (see [pmndrs/jotai#3149](pmndrs/jotai#3149)). BREAKING CHANGE: A migration guide from v4 to v5 is present in the README. TLDR : - `useAtomsLogger` is replaced by `AtomLoggerProvider`, a Provider-like component that automatically picks up the nearest Jotai store from context and wraps children in a new logged store. - `bindAtomsLoggerToStore` is replaced by `createLoggedStore` that creates and return a new store. - `isAtomsLoggerBoundToStore` removed → use `isLoggedStore` - `createLoggedStore` **throws** instead of returning `false`

BREAKING CHANGE: only jotai 2.20.0 and up is supported due to changes in their internal APIs.

…e consistent types with dependencies

…eferences to some helpers

…d of storing it in the logger's state

…are mutable

…ggedStore

…d of atomStateMap

pkg-pr-new · 2026-05-07T20:33:50Z

Open in StackBlitz

npm i https://pkg.pr.new/jotai-logger@d363290

commit: d363290

changeset-bot · 2026-05-07T20:43:46Z

🦋 Changeset detected

Latest commit: d363290

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
jotai-logger	Major

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

…mounted events Initialized, changed and mounted events now show their dependents and pending promises atoms that were added later in the transaction. This act like how dependencies were tracked.

…s on initialized/mounted events

…nsis

Wendystraite added 2 commits May 1, 2026 20:29

feat: split api between vanilla and react

a67310d

Wendystraite added 3 commits May 2, 2026 19:53

refactor: change dependencies tracking logic and its resulting event

2dc0023

refactor: rename internal types that are now exposed to the formatter

fba7fa1

BREAKING CHANGE: rename logger's type AtomsLoggerOptions to AtomLoggerOptions

Wendystraite force-pushed the v5_split_core_react_format branch from 81dec2c to 934fe14 Compare May 3, 2026 15:17

Wendystraite changed the title ~~V5 split core react format~~ V5 : Split package, formatter support and Jotai 2.20 support May 3, 2026

Wendystraite commented May 3, 2026

View reviewed changes

Wendystraite commented May 4, 2026

View reviewed changes

Comment thread README.md Outdated

Comment thread README.md Outdated

Comment thread README.md

Wendystraite added 5 commits May 6, 2026 22:37

docs(changeset): replace mutation-based API with a derived-store API

496b4e0

docs(changeset): split package into vanilla/react/formatter entry points

4436d69

feat: jotai 2.20 support

62c24f7

BREAKING CHANGE: only jotai 2.20.0 and up is supported due to changes in their internal APIs.

docs(changeset): jotai 2.20 support

43291e2

refactor: convert to Set pending promises and dependents atoms to hav…

62082f6

…e consistent types with dependencies

Wendystraite force-pushed the v5_split_core_react_format branch from bc683a0 to 62082f6 Compare May 6, 2026 20:38

Wendystraite added 3 commits May 6, 2026 22:45

fixup: feat: replace mutation-based API with a derived-store API

1aa6397

refactor: use internal building blocks functions instead of storing r…

21974ea

…eferences to some helpers

refactor: pass store and building blocks to internal functions instea…

ff2001b

…d of storing it in the logger's state

Wendystraite commented May 7, 2026

View reviewed changes

Comment thread src/vanilla/transactions/add-event-to-transaction.ts Outdated

refactor: do not mutate the new store at all, only the store options …

ccff37e

…are mutable

Wendystraite commented May 7, 2026

View reviewed changes

Comment thread src/vanilla/create-logged-store.ts Outdated

Wendystraite added 4 commits May 7, 2026 14:12

fix: track dependencies that have the same name

0a1b791

docs(changeset): fix: track dependencies that have the same name

ffa5442

doc: add section in README for changing options at runtime

b12a8d2

refactor: do not use parent store building blocks outside of createLo…

7e33ac5

…ggedStore

Wendystraite commented May 7, 2026

View reviewed changes

Comment thread src/vanilla/transactions/add-event-to-transaction.ts Outdated

Comment thread src/vanilla/callbacks/on-store-sub.ts Outdated

Comment thread src/vanilla/transactions/add-event-to-transaction.ts

Comment thread src/vanilla/transactions/debounce-end-transaction.ts

Wendystraite added 2 commits May 7, 2026 19:04

refactor: move dependencies tracking logic inside storeHooks.i instea…

2ec4599

…d of atomStateMap

refactor: remove an extra object created on every store.sub

039dc7d

Wendystraite added 2 commits May 7, 2026 22:12

doc: document store functions

6f42086

fix: does not expose the logger state function

6d810dd

Wendystraite marked this pull request as ready for review May 7, 2026 20:13

ci: setup pkg-pr-new

b24ac67

Wendystraite force-pushed the v5_split_core_react_format branch 4 times, most recently from 0ee3840 to b24ac67 Compare May 7, 2026 20:54

Wendystraite added 5 commits May 8, 2026 12:04

fix: don't add empty or undefined data to events

a5c7876

docs(changeset): fix: don't add empty or undefined data to events

ff5a893

doc: explain why the transaction atom can be undefined

5cfb5ce

test: add formatter test for all event types

3f79334

test: split and reorganize test files

d70f059

Wendystraite marked this pull request as draft May 8, 2026 12:21

Wendystraite added 4 commits May 8, 2026 18:35

test: add tests on multiple store compositions

169bd52

fix: retroactively set dependents and pendingPromises on initialized/…

cb05089

…mounted events Initialized, changed and mounted events now show their dependents and pending promises atoms that were added later in the transaction. This act like how dependencies were tracked.

docs(changeset): fix: retroactively set dependents and pendingPromise…

096fdc0

…s on initialized/mounted events

doc: add a complete example of a custom formatter using logtape and a…

41241a2

…nsis

Wendystraite marked this pull request as ready for review May 8, 2026 22:10

perf: update benchmarks with empty and console formatters

39b9bf0

Wendystraite force-pushed the v5_split_core_react_format branch from 8849139 to e08d6c1 Compare May 8, 2026 23:26

Wendystraite added 3 commits May 9, 2026 11:41

perf: update benchmarks to match the new jotai benchmarks

39f16ca

chore: update jotai-devtools to 0.14.0

4e2d4ff

fix: do not export the logger's state type

c71a205

Wendystraite force-pushed the v5_split_core_react_format branch from fcf33af to c71a205 Compare May 9, 2026 09:45

Wendystraite added 2 commits May 9, 2026 12:01

doc: add titles in readme for better outline

b76a7e1

doc: update changesets

d363290

Wendystraite merged commit 5de8975 into main May 9, 2026
3 checks passed

Conversation

Wendystraite commented May 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Checks

What's new ?

Split the package into vanilla/react/formatter entry points

Replace the mutation-based API with a derived-store API

Jotai 2.20 "Rev3" API support

Breaking changes

Uh oh!

codecov Bot commented May 2, 2026

Codecov Report

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

pkg-pr-new Bot commented May 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

changeset-bot Bot commented May 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Wendystraite commented May 2, 2026 •

edited

Loading

pkg-pr-new Bot commented May 7, 2026 •

edited

Loading

changeset-bot Bot commented May 7, 2026 •

edited

Loading