@rspack/dev-server 1.0.6 → 1.0.7

package/README.md

@@ -5,12 +5,108 @@
 
 # @rspack/dev-server
 
-Development server for rspack.
+Use Rspack with a development server that provides live reloading. This should be used for development only.
 
-## Documentation
+> `@rspack/dev-server` is based on `webpack-dev-server@5`
 
-See [https://rspack.dev](https://rspack.dev) for details.
+## Installation
+
+First of all, install `@rspack/dev-server` and `@rspack/core` by your favorite package manager:
+
+```bash
+# npm
+$ npm install @rspack/dev-server @rspack/core --save-dev
+
+# yarn
+$ yarn add @rspack/dev-server @rspack/core --dev
+
+# pnpm
+$ pnpm add @rspack/dev-server @rspack/core --save-dev
+
+# bun
+$ bun add @rspack/dev-server @rspack/core -D
+```
+
+## Usage
+
+There are two recommended ways to use `@rspack/dev-server`:
+
+### With the CLI
+
+The easiest way to use it is with the [`@rspack/cli`](https://www.npmjs.com/package/@rspack/cli).
+
+You can install it in your project by:
+
+```bash
+# npm
+$ npm install @rspack/cli --save-dev
+
+# yarn
+$ yarn add @rspack/cli --dev
+
+# pnpm
+$ pnpm add @rspack/cli --save-dev
+
+# bun
+$ bun add @rspack/cli -D
+```
+
+And then start the development server by:
+
+```bash
+# with rspack.config.js
+$ rspack serve
+
+# with custom config file
+$ rspack serve -c ./your.config.js
+```
+
+> See [CLI](https://rspack.dev/api/cli) for more details.
+
+While starting the development server, you can specify the configuration by the `devServer` field of your Rspack config file:
+
+```js
+// rspack.config.js
+module.exports = {
+  // ...
+  devServer: {
+    // the configuration of the development server
+    port: 8080
+  },
+};
+```
+
+> See [DevServer](https://rspack.dev/config/dev-server) for all configuration options.
+
+### With the API
+
+While it's recommended to run `@rspack/dev-server` via the CLI, you may also choose to start a server via the API.
+
+```js
+import { RspackDevServer } from "@rspack/dev-server";
+import rspack from "@rspack/core";
+import rspackConfig from './rspack.config.js';
+
+const compiler = rspack(rspackConfig);
+const devServerOptions = {
+  ...rspackConfig.devServer,
+  // override
+  port: 8888
+};
+
+const server = new RspackDevServer(devServerOptions, compiler);
+
+server.startCallback(() => {
+  console.log('Successfully started server on http://localhost:8888');
+});
+```
+
+> Cause `@rspack/dev-server` is based on `webpack-dev-server@5`, you can see the [webpack-dev-server API](https://webpack.js.org/api/webpack-dev-server/) for more methods of the server instance.
+
+## Credits
+
+Thanks to the [webpack-dev-server](https://github.com/webpack/webpack-dev-server) project created by [@sokra](https://github.com/sokra)
 
 ## License
 
-Rspack is [MIT licensed](https://github.com/web-infra-dev/rspack/blob/main/LICENSE).
+[MIT licensed](https://github.com/web-infra-dev/rspack-dev-server/blob/main/LICENSE).

package/client/index.js

@@ -216,6 +216,7 @@ var overlay =
 		: {
 				send: function send() {}
 			};
+/* Rspack dev server runtime client */
 var onSocketMessage = {
 	hot: function hot() {
 		if (parsedResourceQuery.hot === "false") {

package/dist/alias.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.removeResolveAlias = exports.addResolveAlias = void 0;
+const Module = require("module");
+const MODULE_MAP = {};
 const RESOLVER_MAP = {};
 const addResolveAlias = (name, aliasMap) => {
     const modulePath = require.resolve(name);
@@ -17,6 +19,13 @@ const addResolveAlias = (name, aliasMap) => {
             id,
             options
         ]));
+    MODULE_MAP[modulePath] = Module._resolveFilename;
+    Module._resolveFilename = Module._resolveFilename = (request, mod, ...args) => {
+        if (mod.filename === modulePath && aliasMap[request]) {
+            return aliasMap[request];
+        }
+        return MODULE_MAP[modulePath](request, mod, ...args);
+    };
 };
 exports.addResolveAlias = addResolveAlias;
 const removeResolveAlias = (name) => {
@@ -29,6 +38,7 @@ const removeResolveAlias = (name) => {
         throw new Error("Failed to resolve webpack-dev-server");
     }
     if (RESOLVER_MAP[modulePath]) {
+        Module._resolveFilename = RESOLVER_MAP[modulePath];
         m.require.resolve = RESOLVER_MAP[modulePath];
         delete RESOLVER_MAP[modulePath];
     }

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "@rspack/dev-server",
-  "version": "1.0.6",
+  "version": "1.0.7",
   "license": "MIT",
   "description": "Development server for rspack",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "publishConfig": {
     "access": "public",
+    "registry": "https://registry.npmjs.org/",
     "provenance": true
   },
   "exports": {
@@ -17,19 +18,28 @@
     "./client/*.js": "./client/*.js",
     "./package.json": "./package.json"
   },
+  "simple-git-hooks": {
+    "pre-commit": "npx nano-staged"
+  },
+  "nano-staged": {
+    "*.{js,jsx,ts,tsx,mjs,cjs}": [
+      "biome check --write --no-errors-on-unmatched"
+    ]
+  },
   "files": [
     "dist",
     "client"
   ],
   "homepage": "https://rspack.dev",
-  "bugs": "https://github.com/web-infra-dev/rspack/issues",
+  "bugs": "https://github.com/web-infra-dev/rspack-dev-server/issues",
   "repository": {
     "type": "git",
-    "url": "https://github.com/web-infra-dev/rspack",
-    "directory": "packages/rspack-dev-server"
+    "url": "https://github.com/web-infra-dev/rspack-dev-server"
   },
   "devDependencies": {
+    "@biomejs/biome": "^1.8.3",
     "@jest/test-sequencer": "^29.7.0",
+    "@rspack/core": "1.0.6",
     "@rspack/plugin-react-refresh": "1.0.0",
     "@types/connect-history-api-fallback": "1.5.4",
     "@types/express": "4.17.21",
@@ -48,8 +58,23 @@
     "tcp-port-used": "^1.0.2",
     "typescript": "5.0.2",
     "wait-for-expect": "^3.0.2",
-    "@rspack/core": "1.0.6",
-    "@rspack/dev-server": "1.0.6"
+    "@jest/reporters": "29.7.0",
+    "@types/jest": "29.5.12",
+    "cross-env": "^7.0.3",
+    "husky": "^9.0.0",
+    "jest": "29.7.0",
+    "jest-cli": "29.7.0",
+    "jest-environment-node": "29.7.0",
+    "rimraf": "3.0.2",
+    "ts-jest": "29.1.2",
+    "webpack": "^5.94.0",
+    "webpack-cli": "5.1.4",
+    "react-refresh": "0.14.0",
+    "execa": "9.3.0",
+    "fs-extra": "11.2.0",
+    "nano-staged": "^0.8.0",
+    "semver": "7.6.3",
+    "simple-git-hooks": "^2.11.1"
   },
   "dependencies": {
     "chokidar": "^3.6.0",
@@ -67,10 +92,12 @@
   },
   "scripts": {
     "build": "tsc -b ./tsconfig.build.json",
-    "dev": "tsc -w -b ./tsconfig.build.json",
+    "dev": "tsc -b -w",
+    "lint": "biome check .",
+    "lint:write": "biome check . --write",
+    "format": "node ./node_modules/prettier/bin/prettier.cjs \"packages/**/src/**/*.{ts,tsx,js}\" \"crates/rspack_plugin_runtime/**/*.{ts,js}\" \"x.mjs\" --check",
     "test:install": "cross-env ./node_modules/.bin/puppeteer browsers install chrome",
-    "test": "pnpm run test:install && cross-env NO_COLOR=1 node --expose-gc --max-old-space-size=8192 --experimental-vm-modules ../../node_modules/jest-cli/bin/jest --colors",
-    "api-extractor": "api-extractor run --verbose",
-    "api-extractor:ci": "api-extractor run --verbose || diff temp/api.md etc/api.md"
+    "test": "pnpm run test:install && pnpm run build && cross-env NO_COLOR=1 node --expose-gc --max-old-space-size=8192 --experimental-vm-modules ./node_modules/jest-cli/bin/jest --colors",
+    "release": "node ./scripts/release.mjs"
   }
 }