Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 17 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,35 +36,38 @@ The enabling of the [Preact Refresh](https://github.com/preactjs/prefresh) is di
> In versions below 1.0.0, Rspack did not support preact refresh with `swc-loader`.

```js
const PreactRefreshPlugin = require("@rspack/plugin-preact-refresh");
const isDev = process.env.NODE_ENV === "development";
import { createRequire } from 'node:module';
import PreactRefreshPlugin from '@rspack/plugin-preact-refresh';

Comment thread
chenjiahan marked this conversation as resolved.
module.exports = {
const require = createRequire(import.meta.url);
const isDev = process.env.NODE_ENV === 'development';

export default {
// ...
mode: isDev ? "development" : "production",
mode: isDev ? 'development' : 'production',
module: {
rules: [
{
test: /\.jsx$/,
// exclude node_modules to avoid dependencies transformed by `@swc/plugin-prefresh`
exclude: /node_modules/,
use: {
loader: "builtin:swc-loader",
loader: 'builtin:swc-loader',
options: {
jsc: {
experimental: {
plugins: [
[
// enable prefresh specific transformation
require.resolve("@swc/plugin-prefresh"),
require.resolve('@swc/plugin-prefresh'),
{
library: ["preact-like-framework"], // the customizable preact name, default is `["preact", "preact/compat", "react"]`
library: ['preact-like-framework'], // the customizable preact name, default is `["preact", "preact/compat", "react"]`
},
],
],
},
parser: {
syntax: "ecmascript",
syntax: 'ecmascript',
jsx: true,
},
transform: {
Expand Down Expand Up @@ -114,15 +117,18 @@ new PreactRefreshPlugin({
### preactPath

- Type: `string`
- Default: `path.dirname(require.resolve('preact/package.json'))`
- Default: `path.dirname(require.resolve("preact/package.json"))`

Path to the `preact` package.

```js
const path = require("node:path");
import path from 'node:path';
import { createRequire } from 'node:module';

const require = createRequire(import.meta.url);

new PreactRefreshPlugin({
preactPath: path.dirname(require.resolve("preact/package.json")),
preactPath: path.dirname(require.resolve('preact/package.json')),
});
```

Expand Down
10 changes: 0 additions & 10 deletions index.cjs

This file was deleted.

11 changes: 5 additions & 6 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@
"license": "MIT",
"description": "Preact refresh plugin for Rspack",
"type": "module",
"main": "index.cjs",
"types": "dist/index.d.ts",
"exports": {
".": {
"types": "./dist/index.d.ts",
"import": "./dist/index.js",
"require": "./index.cjs"
"default": "./dist/index.js"
},
"./prefresh": {
"import": "./client/prefresh.js"
},
"./prefresh": "./client/prefresh.js",
"./package.json": "./package.json"
},
"scripts": {
Expand All @@ -28,8 +28,7 @@
},
"files": [
"client",
"dist",
"index.cjs"
"dist"
],
"simple-git-hooks": {
"pre-commit": "npx nano-staged"
Expand Down
5 changes: 1 addition & 4 deletions rslib.config.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
import { defineConfig } from '@rslib/core';

export default defineConfig({
lib: [
{ syntax: 'es2021', dts: true },
{ format: 'cjs', syntax: 'es2021' },
],
lib: [{ format: 'esm', syntax: 'es2023', dts: true }],
});
12 changes: 8 additions & 4 deletions test/configCases/condition/exclude/rspack.config.js
Original file line number Diff line number Diff line change
@@ -1,12 +1,16 @@
const ReactRefreshRspackPlugin = require('../../../..');
const {
default: ReactRefreshRspackPlugin,
} = require('../../../../dist/index.js');

/** @type {import('@rspack/core').Configuration} */
module.exports = {
mode: 'development',
target: 'web',
context: __dirname,
entry: './index.js',
plugins: [new ReactRefreshRspackPlugin({
exclude: /file\.js/,
})],
plugins: [
new ReactRefreshRspackPlugin({
exclude: /file\.js/,
}),
],
};
14 changes: 9 additions & 5 deletions test/configCases/condition/include/rspack.config.js
Original file line number Diff line number Diff line change
@@ -1,13 +1,17 @@
const ReactRefreshRspackPlugin = require('../../../..');
const {
default: ReactRefreshRspackPlugin,
} = require('../../../../dist/index.js');

/** @type {import('@rspack/core').Configuration} */
module.exports = {
mode: 'development',
target: 'web',
context: __dirname,
entry: './index.js',
plugins: [new ReactRefreshRspackPlugin({
exclude: /$^/, // match nothing
include: /foo/,
})],
plugins: [
new ReactRefreshRspackPlugin({
exclude: /$^/, // match nothing
include: /foo/,
}),
],
};
4 changes: 3 additions & 1 deletion test/hotCases/hook/useContext_initial/rspack.config.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
const ReactRefreshRspackPlugin = require('../../../..');
const {
default: ReactRefreshRspackPlugin,
} = require('../../../../dist/index.js');

/** @type {import('@rspack/core').Configuration} */
module.exports = {
Expand Down
4 changes: 3 additions & 1 deletion test/hotCases/hook/useContext_keep/rspack.config.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
const ReactRefreshRspackPlugin = require('../../../..');
const {
default: ReactRefreshRspackPlugin,
} = require('../../../../dist/index.js');

/** @type {import('@rspack/core').Configuration} */
module.exports = {
Expand Down
4 changes: 3 additions & 1 deletion test/hotCases/hook/useContext_provide/rspack.config.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
const ReactRefreshRspackPlugin = require('../../../..');
const {
default: ReactRefreshRspackPlugin,
} = require('../../../../dist/index.js');

/** @type {import('@rspack/core').Configuration} */
module.exports = {
Expand Down
4 changes: 3 additions & 1 deletion test/hotCases/hook/useState_keep/rspack.config.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
const ReactRefreshRspackPlugin = require('../../../..');
const {
default: ReactRefreshRspackPlugin,
} = require('../../../../dist/index.js');

/** @type {import('@rspack/core').Configuration} */
module.exports = {
Expand Down
4 changes: 3 additions & 1 deletion test/hotCases/hook/useState_reset/rspack.config.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
const ReactRefreshRspackPlugin = require('../../../..');
const {
default: ReactRefreshRspackPlugin,
} = require('../../../../dist/index.js');

/** @type {import('@rspack/core').Configuration} */
module.exports = {
Expand Down
4 changes: 3 additions & 1 deletion test/hotCases/jsx/basic/rspack.config.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
const ReactRefreshRspackPlugin = require('../../../..');
const {
default: ReactRefreshRspackPlugin,
} = require('../../../../dist/index.js');

/** @type {import('@rspack/core').Configuration} */
module.exports = {
Expand Down
4 changes: 3 additions & 1 deletion test/hotCases/jsx/child/rspack.config.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
const ReactRefreshRspackPlugin = require('../../../..');
const {
default: ReactRefreshRspackPlugin,
} = require('../../../../dist/index.js');

/** @type {import('@rspack/core').Configuration} */
module.exports = {
Expand Down
4 changes: 3 additions & 1 deletion test/hotCases/jsx/value/rspack.config.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
const ReactRefreshRspackPlugin = require('../../../..');
const {
default: ReactRefreshRspackPlugin,
} = require('../../../../dist/index.js');

/** @type {import('@rspack/core').Configuration} */
module.exports = {
Expand Down
4 changes: 3 additions & 1 deletion test/hotCases/jsx/with-same-name-component/rspack.config.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
const ReactRefreshRspackPlugin = require('../../../..');
const {
default: ReactRefreshRspackPlugin,
} = require('../../../../dist/index.js');

/** @type {import('@rspack/core').Configuration} */
module.exports = {
Expand Down
4 changes: 3 additions & 1 deletion test/hotCases/with-worker/basic/rspack.config.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
const ReactRefreshRspackPlugin = require('../../../..');
const {
default: ReactRefreshRspackPlugin,
} = require('../../../../dist/index.js');

/** @type {import('@rspack/core').Configuration} */
module.exports = {
Expand Down