swc-plugin-react-compiler 0.0.0 → 0.1.0

package/README.md

@@ -1,20 +1,11 @@
 # swc-plugin-react-compiler
 
-SWC Wasm plugin that runs the Rust port of React Compiler through SWC.
+SWC plugin that runs the Rust port of React Compiler through SWC.
 
 ![Preview](./preview.png)
 
-## Important Notice
-
-This is **not** an official React plugin.
-
-This package builds a SWC Wasm plugin around the Rust React Compiler work that is
-currently being developed in the React repository. It is experimental, tracks
-internal compiler APIs, and may break as the upstream Rust port changes.
-
-Use it when you want to try the Rust React Compiler path with SWC today. Do not
-treat it as a production-supported replacement for an official React Compiler
-integration.
+> [!NOTE]
+> This is an unofficial plugin built to use the Rust port of React Compiler with SWC before an official SWC integration is available.
 
 ## Install
 
@@ -32,19 +23,9 @@ pnpm add -D swc-plugin-react-compiler
 yarn add -D swc-plugin-react-compiler
 ```
 
-For Vite React apps using SWC, also install `@vitejs/plugin-react-swc` if it is
-not already present.
-
-```sh
-npm install -D @vitejs/plugin-react-swc
-pnpm add -D @vitejs/plugin-react-swc
-yarn add -D @vitejs/plugin-react-swc
-```
-
 ## Vite Usage
 
-The package exports the absolute path to the compiled Wasm plugin. Pass that
-path to `@vitejs/plugin-react-swc`.
+The package exports the absolute path to the compiled Wasm plugin. Pass that path to `@vitejs/plugin-react-swc`.
 
 ```ts
 // vite.config.ts
@@ -61,10 +42,9 @@ export default defineConfig({
 });
 ```
 
-The options object is forwarded to the React Compiler plugin options. For quick
-experiments, `compilationMode: 'all'` makes the transform easier to verify.
+The options object is forwarded to the React Compiler plugin options. For quick experiments, `compilationMode: 'all'` makes the transform easier to verify.
 
-## Direct SWC Usage
+## SWC Usage
 
 You can also pass the exported Wasm path directly to `@swc/core`.
 
@@ -89,35 +69,9 @@ const result = await transform(source, {
 console.log(result.code);
 ```
 
-## Current Constraints
-
-- This package is experimental and unofficial.
-- The Rust implementation is pulled from the React repository and wrapped as a
-  SWC Wasm plugin.
-- The SWC plugin is built against the SWC versions required by the upstream
-  `react_compiler_swc` crate.
-- The transform expects SWC plugin metadata to provide the original source text.
-  If source text cannot be read from the source map, the plugin leaves the module
-  unchanged.
-- Transformed output may import `react/compiler-runtime`, so the consuming app
-  must use a React version that provides that runtime entry.
-
-## Repository Layout
-
-```text
-.
-├── crates/swc-plugin-react-compiler/  # Rust SWC Wasm plugin
-├── src/                               # JS package entry that exports the Wasm path
-├── example/                           # Vite TODO app using the plugin
-├── Cargo.toml                         # Rust workspace
-├── package.json                       # JS workspace
-├── justfile                           # Development tasks
-└── mise.toml                          # Tool versions
-```
-
 ## Development
 
-This repository uses `mise` for local tool versions and Yarn 4 with PnP.
+This repository uses `mise`.
 
 Install the configured tools:
 
@@ -131,34 +85,28 @@ Set up the workspace:
 mise exec -- just setup
 ```
 
-Build the Wasm plugin:
+Build the plugin:
 
 ```sh
 npm run build
 ```
 
-Run all checks:
-
-```sh
-npm run check
-```
-
 Run tests:
 
 ```sh
 npm run test
 ```
 
-Build the Vite example:
+Run all checks:
 
 ```sh
-npm run example
+npm run check
 ```
 
 Run the Vite example in development mode:
 
 ```sh
-mise exec -- just example-dev
+mise exec -- just example
 ```
 
 The dev server serves the TODO example at `http://127.0.0.1:5173/`.
@@ -169,13 +117,12 @@ The `justfile` defines the main development tasks:
 
 ```sh
 just build        # Build the Wasm plugin and copy it to the package root
-just check        # cargo check, TypeScript, oxlint, and oxfmt
-just test         # Rust tests
-just example      # Build the Vite TODO example
-just example-dev  # Run the Vite TODO example locally
+just check        # cargo check, typecheck, oxlint, and oxfmt
 just format       # Apply oxfmt
+just test         # Rust tests
+just example      # Run the Vite TODO example locally
 ```
 
 ## License
 
-MIT. See [LICENSE](./LICENSE).
+[MIT](./LICENSE)

package/package.json

@@ -1,6 +1,16 @@
 {
   "name": "swc-plugin-react-compiler",
-  "version": "0.0.0",
+  "version": "0.1.0",
+  "description": "SWC plugin for the Rust React Compiler port",
+  "homepage": "https://github.com/leegeunhyeok/swc-plugin-react-compiler#readme",
+  "bugs": {
+    "url": "https://github.com/leegeunhyeok/swc-plugin-react-compiler/issues"
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/leegeunhyeok/swc-plugin-react-compiler.git"
+  },
   "workspaces": [
     "example"
   ],
@@ -20,6 +30,10 @@
     },
     "./package.json": "./package.json"
   },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
   "scripts": {
     "build": "mise exec -- just build",
     "check": "mise exec -- just check",