weapp-ide-cli 3.1.1 → 4.0.0

package/README.md

@@ -1,51 +1,104 @@
 # weapp-ide-cli
 
-微信开发者工具的命令行(v2) 的一个二次封装的包裹实现，来让开发者更加方便的使用微信开发者工具。
+`weapp-ide-cli` 是对「微信开发者工具」官方命令行的增强封装，提供更友好的参数体验、路径兼容与配置管理能力，帮助你在本地与持续集成环境中高效调用工具链。
 
-> 要使用命令行，注意首先需要在开发者工具的设置 -> 安全设置中开启服务端口。
+> 开始前请在微信开发者工具中打开「设置 → 安全设置 → 服务端口」。
 
-## 快速安装
+## 功能亮点
+
+- 自动识别或记忆微信开发者工具 `cli` 所在位置，避免反复输入路径。
+- 为 `-p / --project`、`--qr-output` 等选项自动补全绝对路径，默认使用当前工作目录。
+- 使用与官方指令完全一致的调用方式，便于在脚本中无缝迁移。
+- 支持 macOS、Windows 以及安装了社区版工具的 Linux 桌面环境。
+
+## 安装
 
 ```sh
-npm i -g weapp-ide-cli
-# or
+# 使用 pnpm
+pnpm add -g weapp-ide-cli
+
+# 或使用 npm
+npm install -g weapp-ide-cli
+
+# 或使用 yarn
 yarn global add weapp-ide-cli
 ```
 
-### 执行命令
+## 快速开始
 
 ```sh
-weapp open
-# 等价
-weapp-ide-cli open
-
-# 在当前命令行所在位置，打开微信开发者工具
+# 打开微信开发者工具（项目目录为当前终端所在位置）
 weapp open -p
-# 等价
-weapp open --project
 
-# 在相对的路径，打开微信开发者工具
-# 比如 uni-app 就可以在项目目录执行
-weapp open -p dist/dev/mp-weixin
-# 工具会把相对路径转化为绝对路径，然后打开(绝对路径不转化)
+# 启动并加载指定项目
+weapp open --project ./dist/dev/mp-weixin
+
+# 执行预览、上传等官方支持的命令
+weapp preview
+weapp upload --project ./dist/build/mp-weixin
 ```
 
-## 常用命令
+`weapp` 与 `weapp-ide-cli` 等价，选择任一前缀即可。
+
+## 常用命令速查
+
+| 命令                                            | 说明                                 |
+| ----------------------------------------------- | ------------------------------------ |
+| `weapp login`                                   | 在终端扫码登录账号                   |
+| `weapp open -p [path]`                          | 启动工具并打开项目（默认为当前路径） |
+| `weapp preview --project <path>`                | 生成预览二维码                       |
+| `weapp upload --project <path> --version <ver>` | 上传小程序代码                       |
+| `weapp quit`                                    | 关闭微信开发者工具                   |
+
+更多原生命令与参数请参考官方文档：<https://developers.weixin.qq.com/miniprogram/dev/devtools/cli.html>
+
+## 路径与参数兼容
+
+- `-p` 会被自动替换为 `--project`，并且相对路径会解析为绝对路径。
+- `--qr-output`、`--result-output`、`--info-output` 及其短选项在缺省值时会默认指向当前工作目录。
+- 如果未显式提供路径参数，CLI 会自动注入当前终端所在目录，方便脚本化调用。
+
+## 配置 CLI 所在位置
+
+执行一次互动式配置即可持久化工具路径：
+
+```sh
+weapp config
+```
+
+配置数据保存在用户目录：
+
+- macOS / Linux：`~/.weapp-ide-cli/config.json`
+- Windows：`C:\Users\<用户名>\.weapp-ide-cli\config.json`
+
+可以直接编辑该文件或重新运行 `weapp config` 来更新路径。当配置文件缺失或留空时，CLI 会尝试按系统默认安装位置自动寻找。
+
+## 平台支持与限制
+
+| 平台            | 支持情况      | 默认查找路径                                               |
+| --------------- | ------------- | ---------------------------------------------------------- |
+| macOS           | ✅            | `/Applications/wechatwebdevtools.app/Contents/MacOS/cli`   |
+| Windows         | ✅            | `C:\Program Files (x86)\Tencent\微信web开发者工具\cli.bat` |
+| Linux（社区版） | ⚠️ 需手动安装 | 通过 `PATH` 搜索 `wechat-devtools-cli`                     |
+
+若所属平台未检测到 CLI，请使用 `weapp config` 指定安装位置。
+
+## 在脚本或 CI 中使用
 
-1. `weapp login` 在命令行进行微信扫码登录
-2. `weapp open -p` 启动工具进行调试开发
-3. `weapp preview` 开始预览
-4. `weapp upload` 上传代码
-5. `weapp quit` 关闭开发者工具
+1. 确保执行环境已安装微信开发者工具并开启服务端口。
+2. 首次运行前可通过 `weapp config` 写入 CLI 路径，也可在 CI 中直接向 `~/.weapp-ide-cli/config.json` 写入。
+3. 在自动化流程中建议加上 `--qr-output`、`--result-output` 等参数，以便收集产物或日志。
 
-### 自定义配置
+## 常见问题
 
-`weapp config` 可以对微信开发者工具的 `cli` 目录进行配置，而配置文件就存放在用户的 `${homedir}/.weapp-ide-cli/config.json` 中，您可以随时进行更改。
+- **命令执行后无反应**：请确认微信开发者工具已开启服务端口，并尝试重新登录或升级工具版本。
+- **提示未找到 CLI**：检查配置文件中的路径是否真实存在，可使用绝对路径避免解析误差。
+- **Linux 环境报错**：需安装社区版工具并将 `wechat-devtools-cli` 加入 `PATH`，否则只能手动指定路径。
 
-> 比如 windows 存放位置就在 `C:\Users\${你的用户名}\.weapp-ide-cli/config.json`
+## 贡献
 
-### 更多命令
+欢迎通过 Issues 或 Pull Request 提交优化建议，开发前请阅读仓库根目录的 `CONTRIBUTING.md`。
 
-这个工具本质是一个 `cli` 二次处理工具，所以绝大部分命令都是透传的。
+## 许可证
 
-全部的命令请查看 <https://developers.weixin.qq.com/miniprogram/dev/devtools/cli.html>
+MIT

package/dist/chunk-FJJOQAVP.js

@@ -0,0 +1,302 @@
+// src/utils/path.ts
+import process from "process";
+import path from "pathe";
+function resolvePath(filePath) {
+  if (path.isAbsolute(filePath)) {
+    return filePath;
+  }
+  return path.resolve(process.cwd(), filePath);
+}
+
+// src/config/paths.ts
+import os from "os";
+import path2 from "pathe";
+var homedir = os.homedir();
+var defaultCustomConfigDirPath = path2.join(homedir, ".weapp-ide-cli");
+var defaultCustomConfigFilePath = path2.join(
+  defaultCustomConfigDirPath,
+  "config.json"
+);
+
+// src/config/custom.ts
+import fs from "fs-extra";
+var JSON_OPTIONS = {
+  encoding: "utf8",
+  spaces: 2
+};
+async function createCustomConfig(params) {
+  const trimmedCliPath = params.cliPath.trim();
+  if (!trimmedCliPath) {
+    throw new Error("cliPath cannot be empty");
+  }
+  const normalizedCliPath = resolvePath(trimmedCliPath);
+  await fs.ensureDir(defaultCustomConfigDirPath);
+  await fs.writeJSON(
+    defaultCustomConfigFilePath,
+    {
+      cliPath: normalizedCliPath
+    },
+    JSON_OPTIONS
+  );
+  return normalizedCliPath;
+}
+
+// src/logger.ts
+import logger from "@weapp-core/logger";
+var logger_default = logger;
+
+// src/cli/prompt.ts
+import { stdin as input, stdout as output } from "process";
+import { createInterface } from "readline/promises";
+import fs2 from "fs-extra";
+async function promptForCliPath() {
+  const rl = createInterface({ input, output });
+  try {
+    logger_default.log("\u8BF7\u8BBE\u7F6E\u5FAE\u4FE1web\u5F00\u53D1\u8005\u5DE5\u5177 CLI \u7684\u8DEF\u5F84");
+    logger_default.log("> \u63D0\u793A\uFF1A\u547D\u4EE4\u884C\u5DE5\u5177\u9ED8\u8BA4\u6240\u5728\u4F4D\u7F6E\uFF1A");
+    logger_default.log("- MacOS: <\u5B89\u88C5\u8DEF\u5F84>/Contents/MacOS/cli");
+    logger_default.log("- Windows: <\u5B89\u88C5\u8DEF\u5F84>/cli.bat");
+    logger_default.log("- Linux: <\u5B89\u88C5\u8DEF\u5F84>/files/bin/bin/wechat-devtools-cli");
+    const cliPath = (await rl.question("\u8BF7\u8F93\u5165\u5FAE\u4FE1web\u5F00\u53D1\u8005\u5DE5\u5177 CLI \u8DEF\u5F84\uFF1A")).trim();
+    if (!cliPath) {
+      logger_default.error("\u8DEF\u5F84\u4E0D\u80FD\u4E3A\u7A7A\uFF0C\u5DF2\u53D6\u6D88\u672C\u6B21\u914D\u7F6E\u3002");
+      return null;
+    }
+    try {
+      const normalizedPath = await createCustomConfig({ cliPath });
+      logger_default.log(`\u5168\u5C40\u914D\u7F6E\u5B58\u50A8\u4F4D\u7F6E\uFF1A${defaultCustomConfigFilePath}`);
+      if (!await fs2.pathExists(normalizedPath)) {
+        logger_default.warn("\u5728\u5F53\u524D\u8DEF\u5F84\u672A\u627E\u5230\u5FAE\u4FE1web\u5F00\u53D1\u8005\u547D\u4EE4\u884C\u5DE5\u5177\uFF0C\u8BF7\u786E\u8BA4\u8DEF\u5F84\u662F\u5426\u6B63\u786E\u3002");
+      }
+      return normalizedPath;
+    } catch (error) {
+      const reason = error instanceof Error ? error.message : String(error);
+      logger_default.error(`\u4FDD\u5B58\u914D\u7F6E\u5931\u8D25\uFF1A${reason}`);
+      return null;
+    }
+  } finally {
+    rl.close();
+  }
+}
+
+// src/runtime/platform.ts
+import os2 from "os";
+import process2 from "process";
+import fs3 from "fs-extra";
+import path3 from "pathe";
+var SupportedPlatformsMap = {
+  Windows_NT: "Windows_NT",
+  Darwin: "Darwin",
+  Linux: "Linux"
+};
+function isOperatingSystemSupported(osName = os2.type()) {
+  return osName === SupportedPlatformsMap.Windows_NT || osName === SupportedPlatformsMap.Darwin || osName === SupportedPlatformsMap.Linux;
+}
+var operatingSystemName = os2.type();
+function createLinuxCliResolver() {
+  let resolvedPath;
+  let attempted = false;
+  let pending = null;
+  return async () => {
+    if (attempted) {
+      return resolvedPath;
+    }
+    if (!pending) {
+      pending = (async () => {
+        try {
+          const envPath = await getFirstBinaryPath("wechat-devtools-cli");
+          if (envPath) {
+            resolvedPath = envPath;
+          }
+        } catch (error) {
+          const reason = error instanceof Error ? error.message : String(error);
+          logger_default.warn(`\u83B7\u53D6 Linux wechat-devtools-cli \u8DEF\u5F84\u5931\u8D25\uFF1A${reason}`);
+        } finally {
+          attempted = true;
+        }
+        return resolvedPath;
+      })();
+    }
+    return pending;
+  };
+}
+var linuxCliResolver = createLinuxCliResolver();
+var WINDOWS_DEFAULT_CLI = "C:\\Program Files (x86)\\Tencent\\\u5FAE\u4FE1web\u5F00\u53D1\u8005\u5DE5\u5177\\cli.bat";
+var DARWIN_DEFAULT_CLI = "/Applications/wechatwebdevtools.app/Contents/MacOS/cli";
+var cliPathResolvers = {
+  [SupportedPlatformsMap.Windows_NT]: async () => WINDOWS_DEFAULT_CLI,
+  [SupportedPlatformsMap.Darwin]: async () => DARWIN_DEFAULT_CLI,
+  [SupportedPlatformsMap.Linux]: linuxCliResolver
+};
+async function getDefaultCliPath(targetOs = operatingSystemName) {
+  if (!isOperatingSystemSupported(targetOs)) {
+    return void 0;
+  }
+  const resolver = cliPathResolvers[targetOs];
+  const resolvedPath = await resolver();
+  return resolvedPath;
+}
+async function getFirstBinaryPath(command) {
+  const envPath = process2.env.PATH || "";
+  const pathDirs = envPath.split(path3.delimiter);
+  for (const dir of pathDirs) {
+    const fullPath = path3.join(dir, command);
+    try {
+      await fs3.access(fullPath, fs3.constants.X_OK);
+      return fullPath;
+    } catch {
+      continue;
+    }
+  }
+  return void 0;
+}
+
+// src/config/resolver.ts
+import fs4 from "fs-extra";
+async function getConfig() {
+  if (await fs4.pathExists(defaultCustomConfigFilePath)) {
+    try {
+      const config = await fs4.readJSON(defaultCustomConfigFilePath);
+      const cliPath = typeof config.cliPath === "string" ? config.cliPath.trim() : "";
+      if (cliPath) {
+        logger_default.log("> \u5168\u5C40\u914D\u7F6E\u6587\u4EF6\u8DEF\u5F84\uFF1A", defaultCustomConfigFilePath);
+        logger_default.log("> \u81EA\u5B9A\u4E49 CLI \u8DEF\u5F84\uFF1A", cliPath);
+        return {
+          cliPath,
+          source: "custom"
+        };
+      }
+      logger_default.warn("\u81EA\u5B9A\u4E49\u914D\u7F6E\u6587\u4EF6\u7F3A\u5C11\u6709\u6548\u7684 CLI \u8DEF\u5F84\uFF0C\u5C06\u5C1D\u8BD5\u4F7F\u7528\u9ED8\u8BA4\u8DEF\u5F84\u3002");
+    } catch (error) {
+      const reason = error instanceof Error ? error.message : String(error);
+      logger_default.warn(`\u89E3\u6790\u81EA\u5B9A\u4E49\u914D\u7F6E\u5931\u8D25\uFF0C\u5C06\u5C1D\u8BD5\u4F7F\u7528\u9ED8\u8BA4\u8DEF\u5F84\u3002\u539F\u56E0\uFF1A${reason}`);
+    }
+  }
+  const fallbackPath = await getDefaultCliPath();
+  if (fallbackPath) {
+    return {
+      cliPath: fallbackPath,
+      source: "default"
+    };
+  }
+  return {
+    cliPath: "",
+    source: "missing"
+  };
+}
+
+// src/cli/resolver.ts
+import fs5 from "fs-extra";
+async function resolveCliPath() {
+  const config = await getConfig();
+  if (!config.cliPath) {
+    return { cliPath: null, source: config.source };
+  }
+  const exists = await fs5.pathExists(config.cliPath);
+  return {
+    cliPath: exists ? config.cliPath : null,
+    source: config.source
+  };
+}
+
+// src/utils/argv.ts
+import process3 from "process";
+function ensurePathArgument(argv, optionIndex) {
+  const paramIdx = optionIndex + 1;
+  const param = argv[paramIdx];
+  if (param && !param.startsWith("-")) {
+    argv[paramIdx] = resolvePath(param);
+  } else {
+    argv.splice(paramIdx, 0, process3.cwd());
+  }
+  return argv;
+}
+function transformArgv(argv, transforms) {
+  return transforms.reduce((current, transform) => transform(current), [
+    ...argv
+  ]);
+}
+function createAlias(entry) {
+  return (input2) => {
+    const argv = [...input2];
+    let optionIndex = argv.indexOf(entry.find);
+    if (optionIndex > -1) {
+      argv.splice(optionIndex, 1, entry.replacement);
+    } else {
+      optionIndex = argv.indexOf(entry.replacement);
+    }
+    if (optionIndex === -1) {
+      return argv;
+    }
+    return ensurePathArgument(argv, optionIndex);
+  };
+}
+function createPathCompat(option) {
+  return (input2) => {
+    const argv = [...input2];
+    const optionIndex = argv.indexOf(option);
+    if (optionIndex === -1) {
+      return argv;
+    }
+    return ensurePathArgument(argv, optionIndex);
+  };
+}
+
+// src/utils/exec.ts
+import process4 from "process";
+async function execute(cliPath, argv) {
+  const { execa } = await import("execa");
+  const task = execa(cliPath, argv);
+  task?.stdout?.pipe(process4.stdout);
+  await task;
+}
+
+// src/cli/run.ts
+var ARG_TRANSFORMS = [
+  createAlias({ find: "-p", replacement: "--project" }),
+  createPathCompat("--result-output"),
+  createPathCompat("-r"),
+  createPathCompat("--qr-output"),
+  createPathCompat("-o"),
+  createPathCompat("--info-output"),
+  createPathCompat("-i")
+];
+async function parse(argv) {
+  if (!isOperatingSystemSupported(operatingSystemName)) {
+    logger_default.log(`\u5FAE\u4FE1web\u5F00\u53D1\u8005\u5DE5\u5177\u4E0D\u652F\u6301\u5F53\u524D\u5E73\u53F0\uFF1A${operatingSystemName} !`);
+    return;
+  }
+  if (argv[0] === "config") {
+    await promptForCliPath();
+    return;
+  }
+  const { cliPath, source } = await resolveCliPath();
+  if (!cliPath) {
+    const message = source === "custom" ? "\u5728\u5F53\u524D\u81EA\u5B9A\u4E49\u8DEF\u5F84\u4E2D\u672A\u627E\u5230\u5FAE\u4FE1web\u5F00\u53D1\u8005\u547D\u4EE4\u884C\u5DE5\u5177\uFF0C\u8BF7\u91CD\u65B0\u6307\u5B9A\u8DEF\u5F84\u3002" : "\u672A\u68C0\u6D4B\u5230\u5FAE\u4FE1web\u5F00\u53D1\u8005\u547D\u4EE4\u884C\u5DE5\u5177\uFF0C\u8BF7\u6267\u884C `weapp-ide-cli config` \u6307\u5B9A\u8DEF\u5F84\u3002";
+    logger_default.log(message);
+    await promptForCliPath();
+    return;
+  }
+  const formattedArgv = transformArgv(argv, ARG_TRANSFORMS);
+  await execute(cliPath, formattedArgv);
+}
+
+export {
+  resolvePath,
+  defaultCustomConfigDirPath,
+  defaultCustomConfigFilePath,
+  createCustomConfig,
+  logger_default,
+  promptForCliPath,
+  SupportedPlatformsMap,
+  isOperatingSystemSupported,
+  operatingSystemName,
+  getDefaultCliPath,
+  getConfig,
+  resolveCliPath,
+  transformArgv,
+  createAlias,
+  createPathCompat,
+  execute,
+  parse
+};