@rspack/dev-server 1.2.1 → 2.0.0-beta.2

package/README.md

@@ -9,7 +9,10 @@
 
 Use Rspack with a development server that provides live reloading. This should be used for development only.
 
-> `@rspack/dev-server` is based on `webpack-dev-server@5`
+## Versions
+
+- `2.x`: For Rspack v2
+- `1.x`: For Rspack v1, see [v1.x - README](https://github.com/rstackjs/rspack-dev-server/tree/v1.x#rspackdev-server) for usage guide.
 
 ## Installation
 
@@ -17,16 +20,16 @@ First of all, install `@rspack/dev-server` and `@rspack/core` by your favorite p
 
 ```bash
 # npm
-$ npm install @rspack/dev-server @rspack/core --save-dev
+$ npm install -D @rspack/dev-server @rspack/core
 
 # yarn
-$ yarn add @rspack/dev-server @rspack/core --dev
+$ yarn add -D @rspack/dev-server @rspack/core
 
 # pnpm
-$ pnpm add @rspack/dev-server @rspack/core --save-dev
+$ pnpm add -D @rspack/dev-server @rspack/core
 
 # bun
-$ bun add @rspack/dev-server @rspack/core -D
+$ bun add -D @rspack/dev-server @rspack/core
 ```
 
 ## Usage
@@ -41,16 +44,16 @@ You can install it in your project by:
 
 ```bash
 # npm
-$ npm install @rspack/cli --save-dev
+$ npm install -D @rspack/cli
 
 # yarn
-$ yarn add @rspack/cli --dev
+$ yarn add -D @rspack/cli
 
 # pnpm
-$ pnpm add @rspack/cli --save-dev
+$ pnpm add -D @rspack/cli
 
 # bun
-$ bun add @rspack/cli -D
+$ bun add -D @rspack/cli
 ```
 
 And then start the development server by:
@@ -70,7 +73,6 @@ While starting the development server, you can specify the configuration by the
 ```js
 // rspack.config.mjs
 export default {
-  // ...
   devServer: {
     // the configuration of the development server
     port: 8080,
@@ -78,7 +80,7 @@ export default {
 };
 ```
 
-> See [DevServer](https://rspack.rs/config/dev-server) for all configuration options.
+> See [Rspack - devServer](https://rspack.rs/config/dev-server) for all configuration options.
 
 ### With the API
 
@@ -86,12 +88,12 @@ While it's recommended to run `@rspack/dev-server` via the CLI, you may also cho
 
 ```js
 import { RspackDevServer } from '@rspack/dev-server';
-import rspack from '@rspack/core';
-import rspackConfig from './rspack.config.mjs';
+import { rspack } from '@rspack/core';
+import config from './rspack.config.mjs';
 
-const compiler = rspack(rspackConfig);
+const compiler = rspack(config);
 const devServerOptions = {
-  ...rspackConfig.devServer,
+  ...config.devServer,
   // override
   port: 8888,
 };
@@ -103,8 +105,6 @@ server.startCallback(() => {
 });
 ```
 
-> 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
 
 This plugin is forked from [webpack-dev-server](https://github.com/webpack/webpack-dev-server), and is used to smooth out some differences between rspack and webpack, while also providing rspack-specific new features.

package/client/clients/WebSocketClient.d.ts

@@ -0,0 +1,17 @@
+/**
+ * The following code is modified based on
+ * https://github.com/webpack/webpack-dev-server
+ *
+ * MIT Licensed
+ * Author Tobias Koppers @sokra
+ * Copyright (c) JS Foundation and other contributors
+ * https://github.com/webpack/webpack-dev-server/blob/main/LICENSE
+ */
+import { CommunicationClient } from '../type.js';
+export default class WebSocketClient implements CommunicationClient {
+    private client;
+    constructor(url: string);
+    onOpen(fn: (...args: unknown[]) => void): void;
+    onClose(fn: (...args: unknown[]) => void): void;
+    onMessage(fn: (...args: unknown[]) => void): void;
+}

package/client/clients/WebSocketClient.js

@@ -1,32 +1,32 @@
-/**
- * The following code is modified based on
- * https://github.com/webpack/webpack-dev-server
- *
- * MIT Licensed
- * Author Tobias Koppers @sokra
- * Copyright (c) JS Foundation and other contributors
- * https://github.com/webpack/webpack-dev-server/blob/main/LICENSE
- */
-import { log } from '../utils/log.js';
-var WebSocketClient = /** @class */ (function () {
-    function WebSocketClient(url) {
-        this.client = new WebSocket(url);
-        this.client.onerror = function (error) {
-            log.error(error);
-        };
-    }
-    WebSocketClient.prototype.onOpen = function (fn) {
+import { log } from "../utils/log.js";
+function _define_property(obj, key, value) {
+    if (key in obj) Object.defineProperty(obj, key, {
+        value: value,
+        enumerable: true,
+        configurable: true,
+        writable: true
+    });
+    else obj[key] = value;
+    return obj;
+}
+class WebSocketClient {
+    onOpen(fn) {
         this.client.onopen = fn;
-    };
-    WebSocketClient.prototype.onClose = function (fn) {
+    }
+    onClose(fn) {
         this.client.onclose = fn;
-    };
-    // call fn with the message string as the first argument
-    WebSocketClient.prototype.onMessage = function (fn) {
-        this.client.onmessage = function (event) {
+    }
+    onMessage(fn) {
+        this.client.onmessage = (event)=>{
             fn(event.data);
         };
-    };
-    return WebSocketClient;
-}());
-export default WebSocketClient;
+    }
+    constructor(url){
+        _define_property(this, "client", void 0);
+        this.client = new WebSocket(url);
+        this.client.onerror = (error)=>{
+            log.error(error);
+        };
+    }
+}
+export { WebSocketClient as default };

package/client/index.d.ts

@@ -0,0 +1,17 @@
+/**
+ * The following code is modified based on
+ * https://github.com/webpack/webpack-dev-server
+ *
+ * MIT Licensed
+ * Author Tobias Koppers @sokra
+ * Copyright (c) JS Foundation and other contributors
+ * https://github.com/webpack/webpack-dev-server/blob/main/LICENSE
+ */
+declare const parseURL: (resourceQuery: string) => {
+    [key: string]: string;
+};
+declare const getCurrentScriptSource: () => string;
+declare const createSocketURL: (parsedURL: URL & {
+    fromCurrentScript?: boolean;
+}) => string;
+export { getCurrentScriptSource, parseURL, createSocketURL };