ms-vite-plugin 1.0.3 → 1.0.4

package/dist/cli.js

@@ -41,11 +41,16 @@ const build_1 = require("./build");
 const fsExtra = __importStar(require("fs-extra"));
 const project_1 = require("./project");
 const ws_manager_1 = require("./ws-manager");
+/**
+ * WS 状态持久化文件路径（用于跨进程查询 ws-status）
+ */
 const WS_PID_FILE = path.join(os.tmpdir(), "ms-cli-ws-server.json");
 /**
  * 检查工作目录是否为有效的 KuaiJS 项目
  * @param workspacePath 工作目录路径
  * @returns 是否为有效项目
+ * @example
+ * await isValidKuaiJSProject(process.cwd())
  */
 async function isValidKuaiJSProject(workspacePath) {
     try {
@@ -61,24 +66,36 @@ async function isValidKuaiJSProject(workspacePath) {
         return false;
     }
 }
+/**
+ * 统一校验项目目录合法性
+ * @param workspacePath 待校验的项目目录
+ * @returns 校验通过返回 Promise<void>
+ * @example
+ * await ensureValidKuaiJSProject("/Users/demo/project")
+ */
+async function ensureValidKuaiJSProject(workspacePath) {
+    if (await isValidKuaiJSProject(workspacePath)) {
+        return;
+    }
+    console.error("❌ 错误: 当前目录不是有效的 快点JS 项目");
+    console.error("请确保目录包含以下文件:");
+    console.error("  - package.json");
+    console.error("  - scripts/ 目录");
+    process.exit(1);
+}
 /**
  * 构建命令处理函数
  * @param options 命令选项
+ * @returns 请求完成后退出
+ * @example
+ * ms build -d
  */
 async function buildCommand(options) {
     try {
-        const workspacePath = options.path
-            ? path.resolve(options.path)
-            : process.cwd();
+        const workspacePath = process.cwd();
         const isDev = options.dev || false;
         console.log(`🔍 检查项目目录: ${workspacePath}`);
-        if (!(await isValidKuaiJSProject(workspacePath))) {
-            console.error("❌ 错误: 当前目录不是有效的 快点JS 项目");
-            console.error("请确保目录包含以下文件:");
-            console.error("  - package.json");
-            console.error("  - scripts/ 目录");
-            process.exit(1);
-        }
+        await ensureValidKuaiJSProject(workspacePath);
         console.log(`🚀 开始构建项目 (${isDev ? "开发模式" : "生产模式"})...`);
         await (0, build_1.buildAll)(isDev, workspacePath);
         console.log("✅ 构建完成!");
@@ -96,10 +113,12 @@ async function buildCommand(options) {
  * @param options 命令选项
  * @returns 请求完成后退出
  * @example
- * ms run --ip 192.168.1.100 --port 9800 --path ./
+ * ms run --ip 192.168.1.100 --port 9800
  */
 async function runCommand(options) {
     try {
+        const workspacePath = process.cwd();
+        await ensureValidKuaiJSProject(workspacePath);
         await (0, project_1.runOnDevice)(options);
         console.log("✅ 运行请求已发送");
     }
@@ -113,10 +132,12 @@ async function runCommand(options) {
  * @param options 命令选项
  * @returns 请求完成后退出
  * @example
- * ms run-ui --ip 192.168.1.100 --port 9800 --path ./
+ * ms run-ui --ip 192.168.1.100 --port 9800
  */
 async function runUICommand(options) {
     try {
+        const workspacePath = process.cwd();
+        await ensureValidKuaiJSProject(workspacePath);
         await (0, project_1.runUIOnDevice)(options);
         console.log("✅ UI 预览请求已发送");
     }
@@ -134,6 +155,8 @@ async function runUICommand(options) {
  */
 async function stopCommand(options) {
     try {
+        const workspacePath = process.cwd();
+        await ensureValidKuaiJSProject(workspacePath);
         await (0, project_1.stopOnDevice)(options);
         console.log("✅ 停止请求已发送");
     }
@@ -151,6 +174,7 @@ async function stopCommand(options) {
  */
 async function wsStartCommand(options) {
     try {
+        await ensureValidKuaiJSProject(process.cwd());
         const wsPortText = (options.wsPort ?? "31111").trim();
         const wsPort = Number.parseInt(wsPortText, 10);
         if (!Number.isInteger(wsPort) || wsPort < 1 || wsPort > 65535) {
@@ -158,17 +182,40 @@ async function wsStartCommand(options) {
         }
         const ws = ws_manager_1.WSManager.get();
         await ws.start(wsPort);
+        /**
+         * 写入 WS 运行状态到临时文件，供 ws-status 命令跨进程读取
+         */
+        const writeStatus = async () => {
+            const payload = {
+                pid: process.pid,
+                port: wsPort,
+                address: ws.getAddress(),
+                startedAt: Date.now(),
+                connected: ws.isClientConnected(),
+                clientIp: ws.getConnectedClientIp(),
+            };
+            await fsExtra.writeJSON(WS_PID_FILE, payload);
+        };
+        await writeStatus();
+        const statusTimer = setInterval(() => {
+            writeStatus().catch(() => {
+                // ignore periodic write errors
+            });
+        }, 1000);
         await fsExtra.writeJSON(WS_PID_FILE, {
             pid: process.pid,
             port: wsPort,
             address: ws.getAddress(),
             startedAt: Date.now(),
+            connected: ws.isClientConnected(),
+            clientIp: ws.getConnectedClientIp(),
         });
         console.log("按 Ctrl+C 停止 WS 服务");
         await new Promise((resolve) => {
             const shutdown = async () => {
                 process.off("SIGINT", shutdown);
                 process.off("SIGTERM", shutdown);
+                clearInterval(statusTimer);
                 await ws.stop();
                 await fsExtra.remove(WS_PID_FILE);
                 resolve();
@@ -190,6 +237,7 @@ async function wsStartCommand(options) {
  */
 async function wsStopCommand() {
     try {
+        await ensureValidKuaiJSProject(process.cwd());
         if (!(await fsExtra.pathExists(WS_PID_FILE))) {
             console.log("WS 服务未运行");
             return;
@@ -221,6 +269,7 @@ async function wsStopCommand() {
  * ms ws-status
  */
 async function wsStatusCommand() {
+    await ensureValidKuaiJSProject(process.cwd());
     if (!(await fsExtra.pathExists(WS_PID_FILE))) {
         console.log("服务状态: stopped");
         return;
@@ -228,6 +277,10 @@ async function wsStatusCommand() {
     const info = await fsExtra.readJSON(WS_PID_FILE);
     const pid = Number(info.pid);
     const address = String(info.address || "unknown");
+    const connected = Boolean(info.connected);
+    const clientIp = info.clientIp === null || info.clientIp === undefined
+        ? null
+        : String(info.clientIp);
     let running = false;
     try {
         process.kill(pid, 0);
@@ -243,15 +296,44 @@ async function wsStatusCommand() {
     }
     console.log(`服务状态: running (pid=${pid})`);
     console.log(`WS 地址: ${address}`);
+    console.log(`连接状态: ${connected ? "connected" : "disconnected"}`);
+    if (connected) {
+        console.log(`设备IP: ${clientIp || "unknown"}`);
+    }
+}
+/**
+ * 生成顶层 help 的详细命令参数说明
+ * @returns 返回格式化后的帮助文本
+ * @example
+ * renderDetailedCommandHelp()
+ */
+function renderDetailedCommandHelp() {
+    const lines = [];
+    lines.push("");
+    lines.push("详细命令参数:");
+    const commands = commander_1.program.commands.filter((cmd) => cmd.name() !== "help");
+    for (const cmd of commands) {
+        lines.push(`  ${cmd.name()}:`);
+        if (cmd.options.length === 0) {
+            lines.push("    (无额外参数)");
+            continue;
+        }
+        for (const opt of cmd.options) {
+            const desc = opt.description ? `  ${opt.description}` : "";
+            lines.push(`    ${opt.flags}${desc}`);
+        }
+    }
+    lines.push("");
+    return lines.join("\n");
 }
 // 配置 CLI 程序
-commander_1.program.name("ms-cli").description("快点JS 构建工具").version("0.0.7");
+commander_1.program.name("ms-cli").description("快点JS 构建工具").version("1.0.4");
+commander_1.program.addHelpText("after", renderDetailedCommandHelp);
 // 构建命令
 commander_1.program
     .command("build")
     .description("构建 快点JS 项目")
     .option("-d, --dev", "开发模式构建 (包含 source map)")
-    .option("-p, --path <path>", "指定项目路径")
     .action(buildCommand);
 // 运行命令
 commander_1.program
@@ -262,7 +344,6 @@ commander_1.program
     .option("-t, --transport <transport>", "传输方式: http|ws", "http")
     .option("--ws-port <wsPort>", "WS 服务端口 (默认: 31111)", "31111")
     .option("--ws-wait-ms <wsWaitMs>", "WS 等待设备连接时间(毫秒)", "30000")
-    .option("-p, --path <path>", "指定项目路径")
     .action(runCommand);
 // UI 预览命令
 commander_1.program
@@ -273,7 +354,6 @@ commander_1.program
     .option("-t, --transport <transport>", "传输方式: http|ws", "http")
     .option("--ws-port <wsPort>", "WS 服务端口 (默认: 31111)", "31111")
     .option("--ws-wait-ms <wsWaitMs>", "WS 等待设备连接时间(毫秒)", "30000")
-    .option("-p, --path <path>", "指定项目路径")
     .action(runUICommand);
 // 停止命令
 commander_1.program

package/dist/project.d.ts

@@ -4,7 +4,6 @@
 export interface DeviceCliOptions {
     ip?: string;
     port?: string;
-    path?: string;
     transport?: string;
     wsPort?: string;
     wsWaitMs?: string;

package/dist/project.js

@@ -403,9 +403,7 @@ async function ensureWsReady(options) {
  * await runOnDevice({ ip: "192.168.1.10", port: "9800", path: "./demo" })
  */
 async function runOnDevice(options) {
-    const workspacePath = options.path
-        ? path.resolve(options.path)
-        : process.cwd();
+    const workspacePath = process.cwd();
     const transport = parseTransport(options);
     console.log(`🔧 开始构建项目: ${workspacePath}`);
     await runDevBuild(workspacePath);
@@ -433,9 +431,7 @@ async function runOnDevice(options) {
  * await runUIOnDevice({ ip: "192.168.1.10", port: "9800", path: "./demo" })
  */
 async function runUIOnDevice(options) {
-    const workspacePath = options.path
-        ? path.resolve(options.path)
-        : process.cwd();
+    const workspacePath = process.cwd();
     const transport = parseTransport(options);
     console.log(`🔧 开始构建项目: ${workspacePath}`);
     await runDevBuild(workspacePath);

package/dist/ws-manager.d.ts

@@ -15,6 +15,7 @@ export declare class WSManager {
     private wss;
     private client;
     private checkInterval;
+    private connectedClientIp;
     private readonly hostIp;
     private port;
     private pending;
@@ -56,6 +57,20 @@ export declare class WSManager {
      * ws.isStarted()
      */
     isStarted(): boolean;
+    /**
+     * 获取设备连接状态
+     * @returns 已连接返回 true，否则 false
+     * @example
+     * ws.isClientConnected()
+     */
+    isClientConnected(): boolean;
+    /**
+     * 获取当前连接设备 IP
+     * @returns 返回设备 IP，未连接时返回 null
+     * @example
+     * ws.getConnectedClientIp()
+     */
+    getConnectedClientIp(): string | null;
     /**
      * 启动 WS 服务
      * @param port 指定端口，默认 31111

package/dist/ws-manager.js

@@ -105,6 +105,12 @@ class WSManager {
             writable: true,
             value: null
         });
+        Object.defineProperty(this, "connectedClientIp", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: null
+        });
         Object.defineProperty(this, "hostIp", {
             enumerable: true,
             configurable: true,
@@ -175,6 +181,24 @@ class WSManager {
     isStarted() {
         return this.wss !== null;
     }
+    /**
+     * 获取设备连接状态
+     * @returns 已连接返回 true，否则 false
+     * @example
+     * ws.isClientConnected()
+     */
+    isClientConnected() {
+        return this.client !== null;
+    }
+    /**
+     * 获取当前连接设备 IP
+     * @returns 返回设备 IP，未连接时返回 null
+     * @example
+     * ws.getConnectedClientIp()
+     */
+    getConnectedClientIp() {
+        return this.connectedClientIp;
+    }
     /**
      * 启动 WS 服务
      * @param port 指定端口，默认 31111
@@ -196,12 +220,14 @@ class WSManager {
                 return;
             }
             this.client = ws;
+            const socket = ws;
+            this.connectedClientIp = socket._socket?.remoteAddress || null;
             ws.on("close", () => {
                 if (this.client === ws) {
-                    const socket = ws;
-                    console.log(`设备已断开，设备IP: ${socket._socket?.remoteAddress || "unknown"}`);
+                    console.log(`设备已断开，设备IP: ${this.connectedClientIp || "unknown"}`);
                     this.stopStatusInterval();
                     this.client = null;
+                    this.connectedClientIp = null;
                 }
             });
             ws.on("message", (data) => {
@@ -224,8 +250,7 @@ class WSManager {
                     p.resolve(message);
                 }
             });
-            const socket = ws;
-            console.log(`设备已连接，设备IP: ${socket._socket?.remoteAddress || "unknown"}`);
+            console.log(`设备已连接，设备IP: ${this.connectedClientIp || "unknown"}`);
             this.startStatusInterval();
         });
         await new Promise((resolve, reject) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ms-vite-plugin",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "type": "commonjs",
   "license": "MIT",
   "publishConfig": {