feat(prefresh): Add @swc/plugin-prefresh (#326)

Add `@swc/plugin-prefresh`, which is the SWC implementation of the
[prefresh babel
plugin](https://github.com/preactjs/prefresh/tree/main/packages/babel).

Prefresh babel plugin is a forked equivalent of the react-refresh babel
plugin difference being that we need a way to memoize createContext
between HMR.

And SWC has built-in React Refresh transformation, therefore, this
plugin only implements the `createContext` processing part and need to
be used with `jsc.transform.react.refresh`.

For example:

```json
{
  "jsc": {
    "experimental": {
      "plugins": [
        [
          // enable prefresh specific transformation
          "@swc/plugin-prefresh",
          {
            // the customizable preact name, default is `["preact", "preact/compat", "react"]`
            "library": ["preact-like-framework"]
          }
        ]
      ]
    },
    "parser": {
      "jsx": true
    },
    "transform": {
      "react": {
        "development": true,
        "refresh": true, // enable react refresh transformation
      }
    }
  }
}
```

---------

Co-authored-by: Donny/강동윤 <[email protected]>

Author: LingyuCoder

Cargo.lock

@@ -13,6 +13,7 @@ members = [
   "packages/swc-confidential",
   "packages/swc-magic",
   "packages/transform-imports",
+  "packages/prefresh",
 ]
 
 

Cargo.toml

@@ -16,3 +16,4 @@ Plugins for SWC, written in Rust
 - [`swc-confidential`](packages/swc-confidential) for hiding sensitive strings in your code.
 - [`swc-magic`](packages/swc-magic) for building high-performance frameworks.
 - [`transform-imports`](packages/transform-imports)
+- [`prefresh`](packages/prefresh) for preact refresh transformation.

README.md

@@ -6,6 +6,7 @@
     "lightningcss",
     "quasis",
     "rustc",
-    "swcrc"
+    "swcrc",
+    "prefresh"
   ]
-}
+}

cspell.json

@@ -0,0 +1,2 @@
+/target
+Cargo.lock

packages/prefresh/.gitignore

@@ -0,0 +1,2 @@
+transform/
+tests/

packages/prefresh/.npmignore

@@ -0,0 +1 @@
+# @swc/plugin-prefresh

packages/prefresh/CHANGELOG.md

@@ -0,0 +1,25 @@
+[package]
+
+description = "SWC plugin for preact refresh."
+
+
+authors      = { workspace = true }
+edition      = { workspace = true }
+homepage     = { workspace = true }
+license      = { workspace = true }
+name         = "swc_plugin_prefresh"
+publish      = false
+repository   = { workspace = true }
+rust-version = { workspace = true }
+version      = "0.1.0"
+
+
+[lib]
+crate-type = ["cdylib", "rlib"]
+
+[dependencies]
+serde_json = "1.0.117"
+swc_common = { version = "0.34.3" }
+swc_core   = { version = "0.96.0", features = ["ecma_plugin_transform"] }
+
+swc_prefresh = { path = "./transform" }

packages/prefresh/Cargo.toml

@@ -0,0 +1,39 @@
+# @swc/plugin-prefresh
+
+The SWC implementation of the [prefresh babel plugin](https://github.com/preactjs/prefresh/tree/main/packages/babel).
+
+## Usage
+
+Prefresh babel plugin is a forked equivalent of the react-refresh babel plugin difference being that we need a way to memoize createContext between HMR.
+
+And SWC has built-in React Refresh transformation, therefore, this plugin only implements the `createContext` processing part and need to be used with `jsc.transform.react.refresh`.
+
+.swcrc:
+
+```json
+{
+  "jsc": {
+    "experimental": {
+      "plugins": [
+        [
+          // enable prefresh specific transformation
+          "@swc/plugin-prefresh",
+          {
+            // the customizable preact name, default is `["preact", "preact/compat", "react"]`
+            "library": ["preact-like-framework"]
+          }
+        ]
+      ]
+    },
+    "parser": {
+      "jsx": true
+    },
+    "transform": {
+      "react": {
+        "development": true,
+        "refresh": true, // enable react refresh transformation
+      }
+    }
+  }
+}
+```

packages/prefresh/README.md

@@ -0,0 +1,41 @@
+# @swc/plugin-prefresh
+
+The SWC implementation of the [prefresh babel plugin](https://github.com/preactjs/prefresh/tree/main/packages/babel).
+
+## Usage
+
+Prefresh babel plugin is a forked equivalent of the react-refresh babel plugin difference being that we need a way to memoize createContext between HMR.
+
+And SWC has built-in React Refresh transformation, therefore, this plugin only implements the `createContext` processing part and need to be used with `jsc.transform.react.refresh`.
+
+.swcrc:
+
+```json
+{
+  "jsc": {
+    "experimental": {
+      "plugins": [
+        [
+          // enable prefresh specific transformation
+          "@swc/plugin-prefresh",
+          {
+            // the customizable preact name, default is `["preact", "preact/compat", "react"]`
+            "library": ["preact-like-framework"]
+          }
+        ]
+      ]
+    },
+    "parser": {
+      "jsx": true
+    },
+    "transform": {
+      "react": {
+        "development": true,
+        "refresh": true, // enable react refresh transformation
+      }
+    }
+  }
+}
+```
+
+${CHANGELOG}

packages/prefresh/README.tmpl.md

@@ -0,0 +1,24 @@
+{
+  "name": "@swc/plugin-prefresh",
+  "version": "2.0.7",
+  "description": "SWC plugin for preact refresh",
+  "main": "swc_plugin_prefresh.wasm",
+  "scripts": {
+    "prepack": "cargo build --release -p swc_plugin_prefresh --target wasm32-wasi && cp ../../target/wasm32-wasi/release/swc_plugin_prefresh.wasm ."
+  },
+  "homepage": "https://swc.rs",
+  "repository": {
+    "type": "git",
+    "url": "+https://github.com/swc-project/plugins.git"
+  },
+  "bugs": {
+    "url": "https://github.com/swc-project/plugins/issues"
+  },
+  "author": "강동윤 <[email protected]>",
+  "keywords": [],
+  "license": "Apache-2.0",
+  "preferUnplugged": true,
+  "dependencies": {
+    "@swc/counter": "^0.1.3"
+  }
+}

packages/prefresh/package.json

@@ -0,0 +1,23 @@
+#![allow(clippy::not_unsafe_ptr_arg_deref)]
+
+use swc_common::{SourceMapper, Spanned};
+use swc_core::{
+    ecma::{ast::Program, visit::FoldWith},
+    plugin::{plugin_transform, proxies::TransformPluginProgramMetadata},
+};
+#[plugin_transform]
+fn swc_plugin(program: Program, data: TransformPluginProgramMetadata) -> Program {
+    let config = serde_json::from_str::<Option<swc_prefresh::PrefreshPluginConfig>>(
+        &data
+            .get_transform_plugin_config()
+            .expect("failed to get plugin config for prefresh plugin"),
+    )
+    .expect("invalid packages")
+    .unwrap_or_default();
+
+    let source_map = std::sync::Arc::new(data.source_map);
+    let pos = source_map.lookup_char_pos(program.span().lo);
+    let hash = format!("{:x}", pos.file.src_hash);
+
+    program.fold_with(&mut swc_prefresh::swc_prefresh(config, hash))
+}

packages/prefresh/src/lib.rs

@@ -0,0 +1,27 @@
+[package]
+
+description = "AST Transforms for prefresh plugin"
+
+name = "swc_prefresh"
+
+authors      = { workspace = true }
+edition      = { workspace = true }
+homepage     = { workspace = true }
+license      = { workspace = true }
+repository   = { workspace = true }
+rust-version = { workspace = true }
+version      = "0.1.0"
+
+[dependencies]
+serde          = { version = "1", features = ["derive"] }
+swc_atoms      = "0.6.7"
+swc_common     = "0.34.3"
+swc_core       = { version = "0.96.0", features = ["ecma_quote"] }
+swc_ecma_ast   = "0.115.1"
+swc_ecma_visit = "0.101.0"
+
+[dev-dependencies]
+swc_ecma_parser             = "0.146.7"
+swc_ecma_transforms_base    = "0.140.1"
+swc_ecma_transforms_testing = "0.143.1"
+testing                     = "0.36.0"