feat(dev-server): export package version (#7305)

* chore: add type * chore: lint * chore: add comment --------- Co-authored-by: SoonIter <sooniter@gmail.com>
web-infra-dev · Aug 5, 2024 · 9347ecc · 9347ecc · rspack-bot · Aug 5, 2024
1 parent f44c966
commit 9347ecc
Show file tree

Hide file tree

Showing 6 changed files with 28 additions and 18 deletions.
diff --git a/packages/rspack-dev-server/etc/api.md b/packages/rspack-dev-server/etc/api.md
@@ -72,6 +72,8 @@ export class RspackDevServer extends WebpackDevServer {
     // (undocumented)
     staticWatchers: FSWatcher[];
     // (undocumented)
+    static version: string;
+    // (undocumented)
     webSocketServer: WebpackDevServer.WebSocketServerImplementation | undefined;
 }
 

diff --git a/packages/rspack-dev-server/src/server.ts b/packages/rspack-dev-server/src/server.ts
@@ -15,6 +15,8 @@ import { type Compiler, MultiCompiler } from "@rspack/core";
 import type { FSWatcher } from "chokidar";
 import rdm from "webpack-dev-middleware";
 import WebpackDevServer from "webpack-dev-server";
+// @ts-ignore 'package.json' is not under 'rootDir'
+import { version } from "../package.json";
 
 import type { DevServer, ResolvedDevServer } from "./config";
 import { applyDevServerPatch } from "./patch";
@@ -35,7 +37,10 @@ export class RspackDevServer extends WebpackDevServer {
 	// TODO: remove @ts-ignore here
 	/** @ts-ignore */
 	public compiler: Compiler | MultiCompiler;
-	webSocketServer: WebpackDevServer.WebSocketServerImplementation | undefined;
+	public webSocketServer:
+		| WebpackDevServer.WebSocketServerImplementation
+		| undefined;
+	static version: string = version;
 
 	constructor(options: DevServer, compiler: Compiler | MultiCompiler) {
 		super(options, compiler as any);

diff --git a/packages/rspack-dev-server/tsconfig.json b/packages/rspack-dev-server/tsconfig.json
@@ -1,10 +1,9 @@
 {
   "extends": "../../tsconfig.base.json",
-  "include": [
-    "src"
-  ],
   "compilerOptions": {
     "outDir": "dist",
-    "rootDir": "src"
-  }
-}
+    "rootDir": "src",
+    "resolveJsonModule": true
+  },
+  "include": ["src"]
+}
diff --git a/packages/rspack/etc/api.md b/packages/rspack/etc/api.md
@@ -13340,7 +13340,7 @@ export interface RspackPluginInstance {
 }
 
 // @public (undocumented)
-export const rspackVersion: any;
+export const rspackVersion: string;
 
 // @public
 type Rule = RegExp | string;
@@ -14727,7 +14727,7 @@ export const util: {
 };
 
 // @public (undocumented)
-export const version: any;
+export const version: string;
 
 // @public (undocumented)
 interface Wasm {

diff --git a/packages/rspack/src/exports.ts b/packages/rspack/src/exports.ts
@@ -1,5 +1,14 @@
-const { version: rspackVersion, webpackVersion } = require("../package.json");
-export { rspackVersion, webpackVersion as version };
+import {
+	version as _version,
+	webpackVersion as _webpackVersion
+	// @ts-ignore 'package.json' is not under 'rootDir'
+} from "../package.json";
+
+// this is a hack to be compatible with plugin which detect webpack's version
+const rspackVersion = _version as string;
+const version = _webpackVersion as string;
+
+export { rspackVersion, version };
 
 export type {
 	Asset,

diff --git a/packages/rspack/tsconfig.json b/packages/rspack/tsconfig.json
@@ -18,16 +18,11 @@
       "json-parse-even-better-errors": [
         "../compiled/json-parse-even-better-errors"
       ],
-      "webpack-sources": [
-        "../compiled/webpack-sources"
-      ]
+      "webpack-sources": ["../compiled/webpack-sources"]
     }
   },
   "include": ["src", "src/**/*.json"],
-  "exclude": [
-    "src/config/schema.check.js",
-    "src/container/default.runtime.js"
-  ],
+  "exclude": ["src/config/schema.check.js", "src/container/default.runtime.js"],
   "ts-node": {
     "transpileOnly": true
   },
suite	result
modernjs	✅ success
_selftest	✅ success
nx	❌ failure
rspress	✅ success
rsbuild	✅ success
examples	✅ success
Name	Base (2024-08-05 b616f98)	Current	Change
10000_development-mode + exec	2.32 s ± 33 ms	2.32 s ± 29 ms	-0.13 %
10000_development-mode_hmr + exec	703 ms ± 9.4 ms	702 ms ± 15 ms	-0.20 %
10000_production-mode + exec	2.86 s ± 27 ms	2.85 s ± 27 ms	-0.14 %
arco-pro_development-mode + exec	1.91 s ± 71 ms	1.9 s ± 72 ms	-0.66 %
arco-pro_development-mode_hmr + exec	433 ms ± 3.7 ms	434 ms ± 2.9 ms	+0.17 %
arco-pro_production-mode + exec	3.46 s ± 69 ms	3.44 s ± 92 ms	-0.58 %
threejs_development-mode_10x + exec	1.7 s ± 20 ms	1.69 s ± 24 ms	-0.63 %
threejs_development-mode_10x_hmr + exec	811 ms ± 8.4 ms	808 ms ± 14 ms	-0.44 %
threejs_production-mode_10x + exec	5.52 s ± 28 ms	5.5 s ± 20 ms	-0.38 %