Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/react18-tools/esbuild-plugin-react18
Build Awesome Libraries using React Server Components and make your Mark! - an esbuild plugin for compiling libraries compatible with React 18 server and client component, Nextjs13, Nextjs14
https://github.com/react18-tools/esbuild-plugin-react18
esbuild esbuild-plugin javascript nextjs nextjs13 nextjs14 nodejs react18-tools reactjs typescript
Last synced: about 2 months ago
JSON representation
Build Awesome Libraries using React Server Components and make your Mark! - an esbuild plugin for compiling libraries compatible with React 18 server and client component, Nextjs13, Nextjs14
- Host: GitHub
- URL: https://github.com/react18-tools/esbuild-plugin-react18
- Owner: react18-tools
- License: mpl-2.0
- Created: 2023-09-23T04:48:42.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-29T08:18:14.000Z (2 months ago)
- Last Synced: 2024-10-29T09:37:58.296Z (2 months ago)
- Topics: esbuild, esbuild-plugin, javascript, nextjs, nextjs13, nextjs14, nodejs, react18-tools, reactjs, typescript
- Language: TypeScript
- Homepage:
- Size: 3.08 MB
- Stars: 9
- Watchers: 2
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: contributing.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Esbuild Plugin React18 
[](https://github.com/react18-tools/esbuild-plugin-react18/actions/workflows/test.yml) [](https://codeclimate.com/github/react18-tools/esbuild-plugin-react18/maintainability) [](https://codecov.io/gh/react18-tools/esbuild-plugin-react18) [](https://www.npmjs.com/package/esbuild-plugin-react18) [](https://www.npmjs.com/package/esbuild-plugin-react18)  [](https://gitpod.io/from-referrer/)
> Build Awesome Libraries using React Server Components and make your Mark!
Esbuild Plugin React18 is an `esbuild` plugin designed to help library developers unlock the full potential of React 18 server components. It facilitates compiling libraries compatible with React 18 server and client components, Next.js 13, Remix, etc., seamlessly integrating with React and Next.js.
## Why?
✅ Unleash the full power of React18 Server components\
✅ Build libraries for all build systems/tools/frameworks supporting React18\
✅ Unleash the power of combining react client and server components in your libraries\
✅ Full TypeScript support out of the box\
✅ Supports CJS and ESM builds out of the box\
✅ Simple and tiny\
✅ Easy to use — just add the plugin, and you are good to go\
✅ All in one plugin for building react18 libraries with `tsup` or `esbuild`\
✅ add "use client" directive to indicate client component and the plugin will do the rest\
✅ Automatically ignore test files during build\
✅ Automatically remove `data-testid` attributes\
✅ Add `ignorePatterns` and `replacePatterns` to achieve much more control over your build\
✅ Fully Documented\
✅ Ready to use [GitHub repository template](https://github.com/mayank1513/turborepo-template.git) to create your next react18 library\
The introduction of React server components in React 18 has unlocked immense possibilities. However, library authors are not yet able to fully capitalize on this potential. Many libraries, like `chakra-ui`, simply add “use client” for each component. However, much more can be unleashed when we can use both server and client components to build libraries. Also, check out this [blog](https://mayank1513.medium.com/unleash-the-power-of-react-server-components-eb3fe7201231).
### Build the libraries that
✅ are Fully Treeshakable (import from `esbuild-plugin-react18/client/loader-container`)
✅ provide Fully TypeScript Supported
✅ Leverage the full power of React 18 Server components
✅ are Compatible with all React 18 build systems/tools/frameworks
✅ are Documented with [Typedoc](https://react18-tools.github.io/esbuild-plugin-react18) ([Docs](https://react18-tools.github.io/esbuild-plugin-react18))
✅ provide Examples for Next.js, Vite, and Remix
> Please consider starring [this repository](https://github.com/react18-tools/esbuild-plugin-react18) and sharing it with your friends.
## Compatibility
- JavaScript/TypeScript React libraries using `tsup` or other builders based on `esbuild`
This plugin seamlessly integrates with `tsup` and any other builders based on `esbuild`. With this, you can have both server and client components in your library and the plugin will take care of the rest. All you need to do is add this plugin and add `"use client";` on top of client components (in your source code). Additionally, test files will be removed automatically from the build resulting in a smaller package. Explore more functionalities in the docs.
## Getting Started
### Installation
```bash
$ pnpm add esbuild-plugin-react18
```
**_or_**
```bash
$ npm install esbuild-plugin-react18
```
**_or_**
```bash
$ yarn add esbuild-plugin-react18
```
> If you are using `monorepo` or `workspaces`, you can install this plugin to the root using `-w` or to a specific workspace using `--filter your-package` or `--scope your-package` for `pnpm` or `yarn` workspaces, respectively.
## Use with `tsup`
```ts
// tsup.config.ts or tsup.config.js
import { defineConfig } from "tsup";
import react18Plugin from "esbuild-react18-useclient";
const react18PluginOptions: React18PluginOptions = {}
export default defineConfig(options => ({
...
esbuildPlugins:[react18Plugin(react18PluginOptions)]
}));
```
## Use with `esbuild`
```ts
import react18Plugin from "esbuild-react18-useclient";
const react18PluginOptions: React18PluginOptions = {}
esbuild.build({
...
plugins: [react18Plugin()],
});
```
## Plugin Options
```ts
interface React18PluginOptions {
/** to not ignore test files */
keepTests?: boolean;
/** to not remove `data-testid` attributes. If `keepTests` is true,
* `data-testid` attributes will not be removed irrespective of
* `keepTestIds` value.
* This attribute is useful when setting `sourceReplacePatterns`
*/
keepTestIds?: boolean;
/**
* regExp patterns to match file paths to be ignored.
* If contentPatterns are provided, only the files at matching paths
* containing one or more of the content patterns will be ignored
*/
ignorePatterns?: { pathPattern: RegExp; contentPatterns?: RegExp[] }[];
/**
* regExp patterns to find and replace in source files before build
*
* Use with caution! Make sure the same file does not match multiple patterns
* to avoid any unexpected results.
*
* Caution! - if you have not enabled `keepTests`, we are already using
* `/.*\.(j|t)s(x)?$/` pattern to remove `
data-testid` attributes. If your
* `sourceReplacePatterns` collide with these files, please set `keepTestIds`
* to `true` and handle removing testids yourself.
*/
sourceReplacePatterns?: {
pathPattern: RegExp;
replaceParams: { pattern: RegExp; substitute: string }[];
}[];
/**
* regExp patterns to find and replace in build files after build
* Use with caution! Make sure the same file does not match multiple patterns
* to avoid any unexpected results.
*/
buildReplacePatterns?: {
pathPattern: RegExp;
replaceParams: { pattern: RegExp; substitute: string }[];
}[];
}
```
### [🤩 Don't forget to star this repo!](https://github.com/react18-tools/esbuild-plugin-react18)
[💖](https://github.com/react18-tools/esbuild-plugin-react18) [🌟](https://github.com/react18-tools/esbuild-plugin-react18)
Want a hands-on course for getting started with Turborepo? Check out [React and Next.js with TypeScript](https://www.udemy.com/course/react-and-next-js-with-typescript/?referralCode=7202184A1E57C3DCA8B2) and [The Game of Chess with Next.js, React, and TypeScript](https://www.udemy.com/course/game-of-chess-with-nextjs-react-and-typescrypt/?referralCode=851A28F10B254A8523FE)
## License
This library is licensed under the MPL-2.0 open-source license.
> Please consider enrolling in [our courses](https://mayank-chaudhari.vercel.app/courses) or [sponsoring](https://github.com/sponsors/mayank1513) our work.
with 💖 by Mayank Kumar Chaudhari