unplugin-devpilot 0.0.2 → 0.0.3

package/README.md

@@ -0,0 +1,105 @@
+# unplugin-devpilot
+
+[![npm version][npm-version-src]][npm-version-href]
+[![npm downloads][npm-downloads-src]][npm-downloads-href]
+[![Unit Test][unit-test-src]][unit-test-href]
+
+## Installation
+
+```bash
+npm i -D unplugin-devpilot
+```
+
+<details>
+<summary>Vite</summary><br>
+
+```ts
+// vite.config.ts
+import Devpilot from 'unplugin-devpilot/vite';
+
+export default defineConfig({
+  plugins: [Devpilot()],
+});
+```
+
+<br></details>
+
+<details>
+<summary>Webpack</summary><br>
+
+```js
+// webpack.config.js
+import Devpilot from 'unplugin-devpilot/webpack';
+
+export default {
+  /* ... */
+  plugins: [Devpilot()],
+};
+```
+
+<br></details>
+
+<details>
+<summary>Rspack</summary><br>
+
+```ts
+// rspack.config.js
+import Devpilot from 'unplugin-devpilot/rspack';
+
+export default {
+  /* ... */
+  plugins: [Devpilot()],
+};
+```
+
+<br></details>
+
+## Client Import
+
+Add this import to your project entry point to enable the devpilot client:
+
+```ts
+// main.ts or main.js (entry point)
+import 'virtual:devpilot-client';
+```
+
+This import activates the WebSocket connection to the development server and initializes all registered plugins on the client side.
+
+## Configuration
+
+You can customize the plugin behavior by passing options:
+
+```ts
+// vite.config.ts
+import Devpilot from 'unplugin-devpilot/vite';
+
+export default defineConfig({
+  plugins: [
+    Devpilot({
+      wsPort: 3100, // Optional: Specify WebSocket port (will be randomly allocated if not specified)
+      mcpPort: 3101, // Optional: Specify MCP server port (will use random port if specified port is occupied)
+      plugins: [], // Optional: Array of DevpilotPlugin instances
+    }),
+  ],
+});
+```
+
+### Port Allocation Strategy
+
+- **wsPort**: When provided, the specified port is used if available; otherwise, a random available port is allocated. When not provided, a random available port is automatically allocated
+- **mcpPort**: When not provided, defaults to 3101. If the port is already in use, an error will be thrown
+
+This ensures your MCP server runs on a predictable port. If the default port is occupied, you'll need to specify a different port or free up the occupied port.
+
+## License
+
+[MIT](./LICENSE) License © 2025-PRESENT [Huali](https://github.com/zcf0508)
+
+<!-- Badges -->
+
+[npm-version-src]: https://img.shields.io/npm/v/unplugin-devpilot.svg
+[npm-version-href]: https://npmjs.com/package/unplugin-devpilot
+[npm-downloads-src]: https://img.shields.io/npm/dm/unplugin-devpilot
+[npm-downloads-href]: https://www.npmcharts.com/compare/unplugin-devpilot?interval=30
+[unit-test-src]: https://github.com/zcf0508/unplugin-devpilot/actions/workflows/unit-test.yml/badge.svg
+[unit-test-href]: https://github.com/zcf0508/unplugin-devpilot/actions/workflows/unit-test.yml

package/dist/farm.mjs

@@ -1,4 +1,4 @@
-import { n as unpluginDevpilot } from "./src-D62s1VAN.mjs";
+import { n as unpluginDevpilot } from "./src-Bm2tOOQC.mjs";
 
 //#region src/farm.ts
 /**

package/dist/index.mjs

@@ -1,4 +1,4 @@
-import { n as unpluginDevpilot, r as clientManager, t as src_default } from "./src-D62s1VAN.mjs";
+import { n as unpluginDevpilot, r as clientManager, t as src_default } from "./src-Bm2tOOQC.mjs";
 import { n as defineMcpToolRegister, t as resolveClientModule } from "./plugin-BPkoZQbf.mjs";
 
 export { clientManager, src_default as default, defineMcpToolRegister, resolveClientModule, unpluginDevpilot };

package/dist/rspack.mjs

@@ -1,4 +1,4 @@
-import { n as unpluginDevpilot } from "./src-D62s1VAN.mjs";
+import { n as unpluginDevpilot } from "./src-Bm2tOOQC.mjs";
 
 //#region src/rspack.ts
 /**

package/dist/{src-D62s1VAN.mjs → src-Bm2tOOQC.mjs}

@@ -5,6 +5,10 @@ import { createServer } from "node:http";
 import { Http2ServerRequest } from "http2";
 import { Readable } from "stream";
 import crypto$1 from "crypto";
+import { createServer as createServer$1 } from "node:net";
+import { networkInterfaces } from "node:os";
+import { join } from "node:path";
+import { exec } from "node:child_process";
 
 //#region rolldown:runtime
 var __create = Object.create;
@@ -19793,7 +19797,7 @@ var StreamableHTTPServerTransport = class {
 
 //#endregion
 //#region package.json
-var version = "0.0.2";
+var version = "0.0.3";
 
 //#endregion
 //#region ../../node_modules/.pnpm/es-toolkit@1.44.0/node_modules/es-toolkit/dist/compat/util/uniqueId.mjs
@@ -20196,16 +20200,184 @@ function stopMcpServer() {
 	}
 }
 
+//#endregion
+//#region ../../node_modules/.pnpm/get-port-please@3.2.0/node_modules/get-port-please/dist/index.mjs
+const unsafePorts = /* @__PURE__ */ new Set([
+	1,
+	7,
+	9,
+	11,
+	13,
+	15,
+	17,
+	19,
+	20,
+	21,
+	22,
+	23,
+	25,
+	37,
+	42,
+	43,
+	53,
+	69,
+	77,
+	79,
+	87,
+	95,
+	101,
+	102,
+	103,
+	104,
+	109,
+	110,
+	111,
+	113,
+	115,
+	117,
+	119,
+	123,
+	135,
+	137,
+	139,
+	143,
+	161,
+	179,
+	389,
+	427,
+	465,
+	512,
+	513,
+	514,
+	515,
+	526,
+	530,
+	531,
+	532,
+	540,
+	548,
+	554,
+	556,
+	563,
+	587,
+	601,
+	636,
+	989,
+	990,
+	993,
+	995,
+	1719,
+	1720,
+	1723,
+	2049,
+	3659,
+	4045,
+	5060,
+	5061,
+	6e3,
+	6566,
+	6665,
+	6666,
+	6667,
+	6668,
+	6669,
+	6697,
+	10080
+]);
+function isUnsafePort(port) {
+	return unsafePorts.has(port);
+}
+function isSafePort(port) {
+	return !isUnsafePort(port);
+}
+var GetPortError = class extends Error {
+	constructor(message, opts) {
+		super(message, opts);
+		this.message = message;
+	}
+	name = "GetPortError";
+};
+function _log(verbose, message) {
+	if (verbose) console.log(`[get-port] ${message}`);
+}
+function _tryPort(port, host) {
+	return new Promise((resolve) => {
+		const server = createServer$1();
+		server.unref();
+		server.on("error", () => {
+			resolve(false);
+		});
+		server.listen({
+			port,
+			host
+		}, () => {
+			const { port: port2 } = server.address();
+			server.close(() => {
+				resolve(isSafePort(port2) && port2);
+			});
+		});
+	});
+}
+function _getLocalHosts(additional) {
+	const hosts = new Set(additional);
+	for (const _interface of Object.values(networkInterfaces())) for (const config of _interface || []) if (config.address && !config.internal && !config.address.startsWith("fe80::") && !config.address.startsWith("169.254")) hosts.add(config.address);
+	return [...hosts];
+}
+function _fmtOnHost(hostname) {
+	return hostname ? `on host ${JSON.stringify(hostname)}` : "on any host";
+}
+async function getRandomPort(host) {
+	const port = await checkPort(0, host);
+	if (port === false) throw new GetPortError(`Unable to find a random port ${_fmtOnHost(host)}`);
+	return port;
+}
+async function checkPort(port, host = process.env.HOST, verbose) {
+	if (!host) host = _getLocalHosts([void 0, "0.0.0.0"]);
+	if (!Array.isArray(host)) return _tryPort(port, host);
+	for (const _host of host) {
+		const _port = await _tryPort(port, _host);
+		if (_port === false) {
+			if (port < 1024 && verbose) _log(verbose, `Unable to listen to the privileged port ${port} ${_fmtOnHost(_host)}`);
+			return false;
+		}
+		if (port === 0 && _port !== 0) port = _port;
+	}
+	return port;
+}
+
 //#endregion
 //#region src/core/options.ts
-function resolveOptions(options) {
+async function resolveOptions(options) {
+	let wsPort;
+	if (options.wsPort !== void 0) if (await checkPort(options.wsPort) === false) wsPort = options.wsPort;
+	else wsPort = await getRandomPort();
+	else wsPort = await getRandomPort();
+	const preferredMcpPort = options.mcpPort || 3101;
+	if (await checkPort(preferredMcpPort) === false) throw new Error(`MCP port ${preferredMcpPort} is already in use. Please specify a different port or free up the port.`);
 	return {
-		wsPort: options.wsPort || 3100,
-		mcpPort: options.mcpPort || 3101,
+		wsPort,
+		mcpPort: preferredMcpPort,
 		plugins: options.plugins || []
 	};
 }
 
+//#endregion
+//#region src/core/utils.ts
+/**
+* npx free-port :port
+*/
+async function killPort(port) {
+	return new Promise((resolve, reject) => {
+		exec(`npx -y @maxbo/free-port ${port} -s`, (err, stdout, _stderr) => {
+			if (err) reject(err);
+			else {
+				console.log(stdout);
+				resolve();
+			}
+		});
+	});
+}
+
 //#endregion
 //#region ../../node_modules/.pnpm/birpc@4.0.0/node_modules/birpc/dist/index.mjs
 const TYPE_REQUEST = "q";
@@ -24025,22 +24197,29 @@ ${handlerCollection}
 `;
 }
 const unpluginDevpilot = createUnplugin((rawOptions = {}) => {
-	const options = resolveOptions(rawOptions);
+	let options = null;
 	let serversStarted = false;
 	const name = "unplugin-devpilot";
+	async function ensureOptionsResolved() {
+		if (!options) options = await resolveOptions(rawOptions);
+		return options;
+	}
 	async function startServers() {
 		if (serversStarted) return;
 		serversStarted = true;
-		registerPluginServerMethods(options.plugins);
-		registerPluginMcpRegisterMethods(options.plugins);
-		startWebSocketServer(options.wsPort);
-		await startMcpServer(options.mcpPort);
+		const resolvedOptions = await ensureOptionsResolved();
+		registerPluginServerMethods(resolvedOptions.plugins);
+		registerPluginMcpRegisterMethods(resolvedOptions.plugins);
+		startWebSocketServer(resolvedOptions.wsPort);
+		await startMcpServer(resolvedOptions.mcpPort);
 	}
-	function stopServers() {
+	async function stopServers() {
 		if (!serversStarted) return;
+		const resolvedOptions = await ensureOptionsResolved();
 		serversStarted = false;
 		stopWebSocketServer();
 		stopMcpServer();
+		await killPort(resolvedOptions.mcpPort);
 	}
 	return {
 		name,
@@ -24051,18 +24230,18 @@ const unpluginDevpilot = createUnplugin((rawOptions = {}) => {
 		loadInclude(id) {
 			return id === RESOLVED_VIRTUAL_MODULE_ID;
 		},
-		load(id) {
-			if (id === RESOLVED_VIRTUAL_MODULE_ID) return generateVirtualClientModule(options, process$1.env.NODE_ENV !== "production");
+		async load(id) {
+			if (id === RESOLVED_VIRTUAL_MODULE_ID) return generateVirtualClientModule(await ensureOptionsResolved(), process$1.env.NODE_ENV !== "production");
 		},
 		buildStart() {
 			if (process$1.env.NODE_ENV === "production") return;
-			startServers();
+			return startServers();
 		},
 		buildEnd() {
 			stopServers();
 		},
 		vite: { configureServer() {
-			startServers();
+			return startServers();
 		} },
 		webpack(compiler) {
 			compiler.hooks.watchRun.tapPromise(name, async () => {

package/dist/vite.mjs

@@ -1,4 +1,4 @@
-import { n as unpluginDevpilot } from "./src-D62s1VAN.mjs";
+import { n as unpluginDevpilot } from "./src-Bm2tOOQC.mjs";
 
 //#region src/vite.ts
 /**

package/dist/webpack.mjs

@@ -1,4 +1,4 @@
-import { n as unpluginDevpilot } from "./src-D62s1VAN.mjs";
+import { n as unpluginDevpilot } from "./src-Bm2tOOQC.mjs";
 
 //#region src/webpack.ts
 /**

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "unplugin-devpilot",
   "type": "module",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "description": "Description.",
   "author": "zcf0508 <zcf0508@live.com>",
   "license": "MIT",
@@ -60,6 +60,7 @@
     "@types/ws": "^8.18.1",
     "birpc": "^4.0.0",
     "es-toolkit": "^1.44.0",
+    "get-port-please": "^3.2.0",
     "hookable": "^6.0.1",
     "mitt": "^3.0.1",
     "ws": "^8.19.0",