Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aleclarson/react-dev-ssr
JSX runtime + Babel transform – Step through React component trees with a synchronous stack trace
https://github.com/aleclarson/react-dev-ssr
Last synced: 19 days ago
JSON representation
JSX runtime + Babel transform – Step through React component trees with a synchronous stack trace
- Host: GitHub
- URL: https://github.com/aleclarson/react-dev-ssr
- Owner: aleclarson
- License: other
- Created: 2022-10-19T17:56:46.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2022-10-20T14:39:06.000Z (about 2 years ago)
- Last Synced: 2024-10-13T04:06:25.664Z (24 days ago)
- Language: TypeScript
- Homepage:
- Size: 46.9 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# react-dev-ssr
A custom JSX runtime + Babel transform that runs your React SSR code in a way that makes the stack trace actually useful. You can see every ancestor component and where the current component exists in its immediate parent.
## How it works
Every JSX element using a custom component is wrapped with the `jsxCallSite` function from `react-dev-ssr/jsx-runtime` module. This wraps the element with a closure, creating a stack frame where the element was declared. Since the `react-dev-ssr` runtime is synchronous, you will which JSX elements led to the invocation of the current stack of components being rendered.
Every JSX child expression is also wrapped with `jsxCallSite`, so you can see where exactly each component was declared inside its parent component.
Since the `react-dev-ssr` runtime only runs on the server, it doesn't need to implement any concept of re-rendering. This allows for a drastically simplified runtime. Many of React's features are no-ops on the server (eg: `useEffect`, `React.memo`, etc).
## Help wanted
This is a work-in-progress. Many React features are missing that you might be using. If you find a missing feature, please open an issue or PR. **If your React app is relatively basic, this package should work just fine!**
- Suspense
- Class components
- `cloneElement`
- `isValidElement`
- `React.Children`
- `React.lazy`
- `useReducer`
- `useId`
## Usage
```
pnpm install react-dev-ssr
```
### Using with Vite
In your Vite config, add the following code:
```ts
import reactDevSSR from 'react-dev-ssr/vite'
import react from '@vitejs/plugin-react'
export default defineConfig({
plugins: [react(), reactDevSSR()],
})
```
> **Warning**
> Vite support is pending a PR to Vite:
> https://github.com/vitejs/vite/pull/10552
### Using with Babel
In your Babel config, add the following to your plugins array:
```ts
'react-dev-ssr/jsx-transform'
```
You also need to swap out `react` and `react-dom/server` imports with `react-dev-ssr`. The bundler you're using will determine how this is done.
- **Webpack**
Use the [`resolve.alias`](https://webpack.js.org/configuration/resolve/#resolvealias) built-in option.
- **Parcel**
Use the ["Package Aliases"](https://parceljs.org/features/dependency-resolution/#aliases) built-in feature.
- **Rollup**
Use the [`@rollup/plugin-alias`](https://www.npmjs.com/package/@rollup/plugin-alias) plugin.
- **ESBuild**
Use the [`esbuild-plugin-alias`](https://github.com/igoradamenko/esbuild-plugin-alias) plugin.
- **Babel**
If you're not using a bundler, you can try using the [`babel-plugin-import-replacement`](https://github.com/BuggMaker/babel-plugin-import-replacement) plugin.
Depending on which tool you're using, it might be difficult for you to apply `react-dev-ssr` aliases **in development SSR only**. If you figure it out, please open a PR to add it to this README.