alvarlagerlof / rsc-parser

A parser for the React Server components when sent over the network

Home Page:https://rsc-parser.vercel.app

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

RSC Parser

This is a parser for React Server Components (RSC) when sent over the network. React uses a format to represent a tree of components/html or metadata such as requiered imports, suspense boundaries, and css/fonts that needs to be loaded.

I made this tool to more easily let you understand the data and explore it visually.

Comparsion

image image

How do I use this?

Extension

There is a Chrome Extension than you can add here.

npm package

You can also add the parser as a package to your project. You'll get an embedded panel component that you can render in a layout.tsx for example.

First, install @rsc-parser/embedded from npm like: yarn add @rsc-parser/embedded

Then you can load it in a layout.tsx for example.

import { Suspense, lazy } from "react";

const RscDevtoolsPanel = lazy(() =>
  import("@rsc-parser/embedded").then(module => ({
    default: module.RscDevtoolsPanel,
  })),
);

export default function RootLayout({ children }) {
  return (
    <html lang="en">
      <body>
        {children}
        {/* Use any condition or flag you want here */ }
        {process.env.NODE_ENV === "development" ? (
          <Suspense>
            <RscDevtoolsPanel />
          </Suspense>
        ) : null}
      </body>
    </html>
  );

Website

There is also a website that you can use by manually copy pasing RSC payloads.

  1. Go to a site that uses the NextJS App router or generally is based on React Server components.
  2. Open the network tab in your dev tools
  3. Reload.
  4. Look for fetch responses the payload roughly looks like json, but each like starts with something like O:, 1:I, b: or similar.
  5. Copy the text and paste it into the form on https://rsc-parser.vercel.app/
  6. Explore!

It crashed!

Please make an issue on https://github.com/alvarlagerlof/rsc-parser/issues/new and include the text content that the parser was unable to handle.

About

A parser for the React Server components when sent over the network

https://rsc-parser.vercel.app

License:MIT License


Languages

Language:TypeScript 99.4%Language:JavaScript 0.5%Language:HTML 0.1%Language:Shell 0.0%Language:CSS 0.0%