@liveblocks/codemod

@liveblocks/codemod

Codemods for updating Liveblocks apps.

Transforms

General

remove-liveblocks-config-contexts

Replaces createRoomContext and createLiveblocksContext in liveblock.config files with global Liveblocks types and updates all imports to @liveblocks/react accordingly.

npx @liveblocks/codemod@latest remove-liveblocks-config-contexts

If you export the Suspense versions of hooks from createRoomContext and createLiveblocksContext, add the --suspense flag to update all imports to @liveblocks/react/suspense instead.

npx @liveblocks/codemod@latest remove-liveblocks-config-contexts --suspense

remove-unneeded-type-params

Removes no longer needed type params from Liveblocks types (only use this if you are using the global types).

npx @liveblocks/codemod@latest remove-unneeded-type-params

simplify-client-side-suspense-children

Removes any function-style body from <ClientSideSuspense>’s children prop.

npx @liveblocks/codemod@latest simplify-client-side-suspense-children

2.0 (breaking changes)

Liveblocks 2.0 comes with a number of breaking changes and most are covered by the following codemods, see the upgrade guide to learn more about the changes.

react-comments-to-react-ui

Updates @liveblocks/react-comments to @liveblocks/react-ui and renames <CommentsConfig /> to <LiveblocksUIConfig />.

npx @liveblocks/codemod@latest react-comments-to-react-ui

room-info-to-room-data

Renames RoomInfo type from @liveblocks/node to RoomData.

npx @liveblocks/codemod@latest room-info-to-room-data

remove-yjs-default-export

Replaces the default import of @liveblocks/yjs by a named LiveblocksYjsProvider one, and update its usage accordingly.

npx @liveblocks/codemod@latest remove-yjs-default-export

live-list-constructor

Adds an array to empty LiveList constructors.

npx @liveblocks/codemod@latest live-list-constructor