weapp-ide-cli 5.0.4 → 5.1.1

package/dist/index.d.ts

@@ -1,25 +1,179 @@
-import * as execa from 'execa';
+import { Buffer } from "node:buffer";
+import * as execa from "execa";
+import * as miniprogram_automator_out_MiniProgram0 from "miniprogram-automator/out/MiniProgram";
 
+//#region src/cli/automator.d.ts
+interface AutomatorOptions {
+  projectPath: string;
+  timeout?: number;
+}
+/**
+ * @description Check if error is a DevTools HTTP port error
+ */
+declare function isDevtoolsHttpPortError(error: unknown): boolean;
+/**
+ * @description Check if error is a login required error
+ */
+declare function isAutomatorLoginError(error: unknown): boolean;
+/**
+ * @description Format login error for display
+ */
+declare function formatAutomatorLoginError(error: unknown): string;
+/**
+ * @description Launch automator with default options
+ */
+declare function launchAutomator(options: AutomatorOptions): Promise<miniprogram_automator_out_MiniProgram0.default>;
+//#endregion
+//#region src/cli/automator-argv.d.ts
+interface ParsedAutomatorArgs {
+  projectPath: string;
+  timeout?: number;
+  json: boolean;
+  positionals: string[];
+}
+/**
+ * @description 解析 automator 命令通用参数与位置参数。
+ */
+declare function parseAutomatorArgs(argv: readonly string[]): ParsedAutomatorArgs;
+/**
+ * @description 读取选项值，支持 --option value 与 --option=value。
+ */
+declare function readOptionValue(argv: readonly string[], optionName: string): string | undefined;
+/**
+ * @description 删除参数中的指定选项（同时支持 --opt value 与 --opt=value）。
+ */
+declare function removeOption(argv: readonly string[], optionName: string): string[];
+//#endregion
+//#region src/cli/automator-session.d.ts
+interface AutomatorSessionOptions {
+  projectPath: string;
+  timeout?: number;
+}
+interface MiniProgramElement {
+  tap: () => Promise<void>;
+  input?: (value: string) => Promise<void>;
+}
+interface MiniProgramPage {
+  path?: string;
+  query?: Record<string, unknown>;
+  data: (path?: string) => Promise<unknown>;
+  $: (selector: string) => Promise<MiniProgramElement | null>;
+}
+interface MiniProgramLike {
+  navigateTo: (url: string) => Promise<unknown>;
+  redirectTo: (url: string) => Promise<unknown>;
+  navigateBack: () => Promise<unknown>;
+  reLaunch: (url: string) => Promise<unknown>;
+  switchTab: (url: string) => Promise<unknown>;
+  pageStack: () => Promise<MiniProgramPage[]>;
+  currentPage: () => Promise<MiniProgramPage>;
+  systemInfo: () => Promise<unknown>;
+  pageScrollTo: (scrollTop: number) => Promise<unknown>;
+  stopAudits: () => Promise<unknown>;
+  screenshot: () => Promise<string | Buffer>;
+  remote: (enable?: boolean) => Promise<unknown>;
+  close: () => Promise<void>;
+}
+/**
+ * @description 统一管理 automator 会话生命周期与常见连接错误提示。
+ */
+declare function withMiniProgram<T>(options: AutomatorSessionOptions, runner: (miniProgram: MiniProgramLike) => Promise<T>): Promise<T>;
+//#endregion
+//#region src/cli/command-catalog.d.ts
+declare const WECHAT_CLI_COMMAND_NAMES: readonly ["open", "login", "islogin", "preview", "auto-preview", "upload", "build-npm", "auto", "auto-replay", "reset-fileutils", "close", "quit", "cache", "engine", "open-other", "build-ipa", "build-apk", "cloud"];
+declare const MINIDEV_NAMESPACE_COMMAND_NAMES: readonly ["alipay", "ali", "minidev"];
+declare const CONFIG_COMMAND_NAME: "config";
+declare const WEAPP_IDE_TOP_LEVEL_COMMAND_NAMES: string[];
+/**
+ * @description 判断是否为 weapp-ide-cli 支持的顶层命令。
+ */
+declare function isWeappIdeTopLevelCommand(command: string | undefined): boolean;
+//#endregion
+//#region src/cli/commands.d.ts
+interface AutomatorCommandOptions extends AutomatorSessionOptions {}
+interface NavigateOptions extends AutomatorCommandOptions {
+  url: string;
+}
+interface PageInfoOptions extends AutomatorCommandOptions {
+  json?: boolean;
+}
+interface PageDataOptions extends PageInfoOptions {
+  path?: string;
+}
+interface SelectorOptions extends AutomatorCommandOptions {
+  selector: string;
+}
+interface TapOptions extends SelectorOptions {}
+interface InputOptions extends SelectorOptions {
+  value: string;
+}
+interface ScrollOptions extends AutomatorCommandOptions {
+  scrollTop: number;
+}
+interface AuditOptions extends AutomatorCommandOptions {
+  outputPath?: string;
+}
+interface ScreenshotOptions extends AutomatorCommandOptions {
+  outputPath?: string;
+  page?: string;
+}
+interface ScreenshotResult {
+  base64?: string;
+  path?: string;
+}
+interface RemoteOptions extends AutomatorCommandOptions {
+  enable?: boolean;
+}
+interface PageSnapshot {
+  path: string;
+  query: Record<string, unknown> | undefined;
+}
+declare function navigateTo(options: NavigateOptions): Promise<void>;
+declare function redirectTo(options: NavigateOptions): Promise<void>;
+declare function navigateBack(options: AutomatorCommandOptions): Promise<void>;
+declare function reLaunch(options: NavigateOptions): Promise<void>;
+declare function switchTab(options: NavigateOptions): Promise<void>;
+declare function pageStack(options: PageInfoOptions): Promise<PageSnapshot[]>;
+declare function currentPage(options: PageInfoOptions): Promise<PageSnapshot>;
+declare function systemInfo(options: PageInfoOptions): Promise<unknown>;
+declare function pageData(options: PageDataOptions): Promise<unknown>;
+declare function tap(options: TapOptions): Promise<void>;
+declare function input(options: InputOptions): Promise<void>;
+declare function scrollTo(options: ScrollOptions): Promise<void>;
+declare function audit(options: AuditOptions): Promise<unknown>;
+declare function takeScreenshot(options: ScreenshotOptions): Promise<ScreenshotResult>;
+declare function remote(options: RemoteOptions): Promise<void>;
+//#endregion
+//#region src/cli/config-command.d.ts
+/**
+ * @description 处理 config 子命令。
+ */
+declare function handleConfigCommand(argv: string[]): Promise<void>;
+//#endregion
+//#region src/cli/minidev.d.ts
 /**
  * @description 运行支付宝小程序 CLI（minidev）
  */
 declare function runMinidev(argv: readonly string[]): Promise<void>;
-
+//#endregion
+//#region src/cli/prompt.d.ts
 /**
  * @description 交互式提示并保存 CLI 路径
  */
 declare function promptForCliPath(): Promise<string | null>;
-
+//#endregion
+//#region src/cli/resolver.d.ts
 /**
  * @description 解析 CLI 路径并校验可用性
  */
 declare function resolveCliPath(): Promise<{
-    cliPath: string | null;
-    source: ConfigSource;
+  cliPath: string | null;
+  source: ConfigSource;
 }>;
-
+//#endregion
+//#region src/cli/retry.d.ts
 interface RetryKeypressOptions {
-    timeoutMs?: number;
+  timeoutMs?: number;
 }
 type RetryPromptResult = 'retry' | 'cancel' | 'timeout';
 /**
@@ -38,8 +192,8 @@ declare function formatWechatIdeLoginRequiredError(error: unknown): string;
  * @description 创建登录失效专用错误，并携带退出码语义。
  */
 declare function createWechatIdeLoginRequiredExitError(error: unknown, reason?: string): Error & {
-    code: number;
-    exitCode: number;
+  code: number;
+  exitCode: number;
 };
 /**
  * @description 交互等待用户按键重试，按 r 重试，按 q 或 Ctrl+C 取消。
@@ -49,17 +203,58 @@ declare function waitForRetryKeypress(options?: RetryKeypressOptions): Promise<R
  * @description 生成重试按键提示，并高亮关键热键。
  */
 declare function formatRetryHotkeyPrompt(timeoutMs?: number): string;
-
+//#endregion
+//#region src/cli/run.d.ts
 /**
- * @description CLI 入口解析与分发
+ * @description CLI 入口解析与分发。
  */
 declare function parse(argv: string[]): Promise<void>;
-
+//#endregion
+//#region src/cli/run-automator.d.ts
+declare const AUTOMATOR_COMMAND_NAMES: string[];
+/**
+ * @description 判断是否属于 automator 子命令。
+ */
+declare function isAutomatorCommand(command: string | undefined): boolean;
+/**
+ * @description 分发 automator 子命令。
+ */
+declare function runAutomatorCommand(command: string, argv: string[]): Promise<void>;
+/**
+ * @description 获取 automator 命令帮助文本。
+ */
+declare function getAutomatorCommandHelp(command: string): string | undefined;
+//#endregion
+//#region src/cli/run-login.d.ts
+type LoginRetryMode = 'never' | 'once' | 'always';
+/**
+ * @description 运行微信开发者工具 CLI，并在登录失效时允许按键重试。
+ */
+declare function runWechatCliWithRetry(cliPath: string, argv: string[]): Promise<void>;
+//#endregion
+//#region src/cli/screenshot.d.ts
+/**
+ * @description Print help for screenshot command
+ */
+declare function printScreenshotHelp(): void;
+/**
+ * @description Parse command line arguments for screenshot command
+ */
+declare function parseScreenshotArgs(argv: string[]): ScreenshotOptions;
+//#endregion
+//#region src/cli/wechat-command-schema.d.ts
+/**
+ * @description 在调用官方微信 CLI 前做轻量参数校验。
+ */
+declare function validateWechatCliCommandArgs(argv: readonly string[]): void;
+//#endregion
+//#region src/types.d.ts
 /**
  * @description 基础配置
  */
 interface BaseConfig {
-    cliPath: string;
+  cliPath: string;
+  locale?: 'zh' | 'en';
 }
 /**
  * @description 配置来源
@@ -69,21 +264,43 @@ type ConfigSource = 'custom' | 'default' | 'missing';
  * @description 解析后的配置
  */
 interface ResolvedConfig extends BaseConfig {
-    source: ConfigSource;
+  source: ConfigSource;
 }
 /**
  * @description CLI 参数别名配置
  */
 interface AliasEntry {
-    find: string;
-    replacement: string;
+  find: string;
+  replacement: string;
+}
+//#endregion
+//#region src/config/custom.d.ts
+interface CustomConfigFile {
+  cliPath?: string;
+  locale?: 'zh' | 'en';
 }
-
 /**
  * @description 写入自定义 CLI 路径配置
  */
 declare function createCustomConfig(params: BaseConfig): Promise<string>;
-
+/**
+ * @description 写入语言配置（zh / en）。
+ */
+declare function createLocaleConfig(locale: 'zh' | 'en'): Promise<"zh" | "en">;
+/**
+ * @description 删除指定配置项。
+ */
+declare function removeCustomConfigKey(key: keyof CustomConfigFile): Promise<void>;
+/**
+ * @description 覆盖写入配置内容（会替换原内容）。
+ */
+declare function overwriteCustomConfig(config: CustomConfigFile): Promise<void>;
+/**
+ * @description 读取原始自定义配置。
+ */
+declare function readCustomConfig(): Promise<CustomConfigFile>;
+//#endregion
+//#region src/config/paths.d.ts
 /**
  * @description 默认自定义配置目录
  */
@@ -92,20 +309,26 @@ declare const defaultCustomConfigDirPath: string;
  * @description 默认自定义配置文件路径
  */
 declare const defaultCustomConfigFilePath: string;
-
+//#endregion
+//#region src/config/resolver.d.ts
 /**
  * @description 读取并解析 CLI 配置（自定义优先）
  */
 declare function getConfig(): Promise<ResolvedConfig>;
-
+/**
+ * @description 获取用户配置的语言偏好。
+ */
+declare function getConfiguredLocale(): Promise<"zh" | "en" | undefined>;
+//#endregion
+//#region src/runtime/platform.d.ts
 /**
  * @description 官方微信开发者工具只支持 Windows、macOS，Linux 只有社区版
  * https://github.com/msojocs/wechat-web-devtools-linux
  */
 declare const SupportedPlatformsMap: {
-    readonly Windows_NT: "Windows_NT";
-    readonly Darwin: "Darwin";
-    readonly Linux: "Linux";
+  readonly Windows_NT: "Windows_NT";
+  readonly Darwin: "Darwin";
+  readonly Linux: "Linux";
 };
 /**
  * @description 支持的系统类型
@@ -123,7 +346,8 @@ declare const operatingSystemName: string;
  * @description 获取默认 CLI 路径（按系统）
  */
 declare function getDefaultCliPath(targetOs?: string): Promise<string | undefined>;
-
+//#endregion
+//#region src/utils/argv.d.ts
 /**
  * @description argv 处理函数
  */
@@ -140,19 +364,21 @@ declare function createAlias(entry: AliasEntry): ArgvTransform;
  * @description 创建路径参数兼容转换器（补全或规范化路径）
  */
 declare function createPathCompat(option: string): ArgvTransform;
-
+//#endregion
+//#region src/utils/exec.d.ts
 interface ExecuteOptions {
-    pipeStdout?: boolean;
-    pipeStderr?: boolean;
+  pipeStdout?: boolean;
+  pipeStderr?: boolean;
 }
 /**
  * @description 执行 CLI 命令并透传输出
  */
 declare function execute(cliPath: string, argv: string[], options?: ExecuteOptions): Promise<execa.Result<{}>>;
-
+//#endregion
+//#region src/utils/path.d.ts
 /**
  * @description 解析为绝对路径（基于当前工作目录）
  */
 declare function resolvePath(filePath: string): string;
-
-export { type ArgvTransform, type BaseConfig, type ConfigSource, type ResolvedConfig, type RetryKeypressOptions, type RetryPromptResult, type SupportedPlatform, SupportedPlatformsMap, createAlias, createCustomConfig, createPathCompat, createWechatIdeLoginRequiredExitError, defaultCustomConfigDirPath, defaultCustomConfigFilePath, execute, extractExecutionErrorText, formatRetryHotkeyPrompt, formatWechatIdeLoginRequiredError, getConfig, getDefaultCliPath, isOperatingSystemSupported, isWechatIdeLoginRequiredError, operatingSystemName, parse, promptForCliPath, resolveCliPath, resolvePath, runMinidev, transformArgv, waitForRetryKeypress };
+//#endregion
+export { AUTOMATOR_COMMAND_NAMES, ArgvTransform, AuditOptions, AutomatorCommandOptions, AutomatorOptions, AutomatorSessionOptions, type BaseConfig, CONFIG_COMMAND_NAME, type ConfigSource, InputOptions, LoginRetryMode, MINIDEV_NAMESPACE_COMMAND_NAMES, MiniProgramElement, MiniProgramLike, MiniProgramPage, NavigateOptions, PageDataOptions, PageInfoOptions, ParsedAutomatorArgs, RemoteOptions, type ResolvedConfig, RetryKeypressOptions, RetryPromptResult, type ScreenshotOptions, type ScreenshotResult, ScrollOptions, SelectorOptions, SupportedPlatform, SupportedPlatformsMap, TapOptions, WEAPP_IDE_TOP_LEVEL_COMMAND_NAMES, WECHAT_CLI_COMMAND_NAMES, audit, createAlias, createCustomConfig, createLocaleConfig, createPathCompat, createWechatIdeLoginRequiredExitError, currentPage, defaultCustomConfigDirPath, defaultCustomConfigFilePath, execute, extractExecutionErrorText, formatAutomatorLoginError, formatRetryHotkeyPrompt, formatWechatIdeLoginRequiredError, getAutomatorCommandHelp, getConfig, getConfiguredLocale, getDefaultCliPath, handleConfigCommand, input, isAutomatorCommand, isAutomatorLoginError, isDevtoolsHttpPortError, isOperatingSystemSupported, isWeappIdeTopLevelCommand, isWechatIdeLoginRequiredError, launchAutomator, navigateBack, navigateTo, operatingSystemName, overwriteCustomConfig, pageData, pageStack, parse, parseAutomatorArgs, parseScreenshotArgs, printScreenshotHelp, promptForCliPath, reLaunch, readCustomConfig, readOptionValue, redirectTo, remote, removeCustomConfigKey, removeOption, resolveCliPath, resolvePath, runAutomatorCommand, runMinidev, runWechatCliWithRetry, scrollTo, switchTab, systemInfo, takeScreenshot, tap, transformArgv, validateWechatCliCommandArgs, waitForRetryKeypress, withMiniProgram };

package/dist/index.js

@@ -1,50 +1,3 @@
-import {
-  SupportedPlatformsMap,
-  createAlias,
-  createCustomConfig,
-  createPathCompat,
-  createWechatIdeLoginRequiredExitError,
-  defaultCustomConfigDirPath,
-  defaultCustomConfigFilePath,
-  execute,
-  extractExecutionErrorText,
-  formatRetryHotkeyPrompt,
-  formatWechatIdeLoginRequiredError,
-  getConfig,
-  getDefaultCliPath,
-  isOperatingSystemSupported,
-  isWechatIdeLoginRequiredError,
-  operatingSystemName,
-  parse,
-  promptForCliPath,
-  resolveCliPath,
-  resolvePath,
-  runMinidev,
-  transformArgv,
-  waitForRetryKeypress
-} from "./chunk-QTQD5BFV.js";
-export {
-  SupportedPlatformsMap,
-  createAlias,
-  createCustomConfig,
-  createPathCompat,
-  createWechatIdeLoginRequiredExitError,
-  defaultCustomConfigDirPath,
-  defaultCustomConfigFilePath,
-  execute,
-  extractExecutionErrorText,
-  formatRetryHotkeyPrompt,
-  formatWechatIdeLoginRequiredError,
-  getConfig,
-  getDefaultCliPath,
-  isOperatingSystemSupported,
-  isWechatIdeLoginRequiredError,
-  operatingSystemName,
-  parse,
-  promptForCliPath,
-  resolveCliPath,
-  resolvePath,
-  runMinidev,
-  transformArgv,
-  waitForRetryKeypress
-};
+import { C as formatAutomatorLoginError, E as launchAutomator, T as isDevtoolsHttpPortError, _ as withMiniProgram, a as navigateBack, c as pageStack, d as remote, f as scrollTo, g as tap, h as takeScreenshot, i as input, l as reLaunch, m as systemInfo, o as navigateTo, p as switchTab, r as currentPage, s as pageData, t as audit, u as redirectTo, w as isAutomatorLoginError } from "./commands-9F3ycbXU.js";
+import { A as defaultCustomConfigFilePath, B as runAutomatorCommand, C as promptForCliPath, D as readCustomConfig, E as overwriteCustomConfig, F as WECHAT_CLI_COMMAND_NAMES, G as removeOption, H as printScreenshotHelp, I as isWeappIdeTopLevelCommand, L as AUTOMATOR_COMMAND_NAMES, M as CONFIG_COMMAND_NAME, N as MINIDEV_NAMESPACE_COMMAND_NAMES, O as removeCustomConfigKey, P as WEAPP_IDE_TOP_LEVEL_COMMAND_NAMES, R as getAutomatorCommandHelp, S as operatingSystemName, T as createLocaleConfig, U as parseAutomatorArgs, V as parseScreenshotArgs, W as readOptionValue, _ as getConfig, a as extractExecutionErrorText, b as getDefaultCliPath, c as isWechatIdeLoginRequiredError, d as execute, f as createAlias, g as resolveCliPath, h as handleConfigCommand, i as createWechatIdeLoginRequiredExitError, j as resolvePath, k as defaultCustomConfigDirPath, l as waitForRetryKeypress, m as transformArgv, n as validateWechatCliCommandArgs, o as formatRetryHotkeyPrompt, p as createPathCompat, r as runWechatCliWithRetry, s as formatWechatIdeLoginRequiredError, t as parse, u as runMinidev, v as getConfiguredLocale, w as createCustomConfig, x as isOperatingSystemSupported, y as SupportedPlatformsMap, z as isAutomatorCommand } from "./cli-Dv5EAvYh.js";
+export { AUTOMATOR_COMMAND_NAMES, CONFIG_COMMAND_NAME, MINIDEV_NAMESPACE_COMMAND_NAMES, SupportedPlatformsMap, WEAPP_IDE_TOP_LEVEL_COMMAND_NAMES, WECHAT_CLI_COMMAND_NAMES, audit, createAlias, createCustomConfig, createLocaleConfig, createPathCompat, createWechatIdeLoginRequiredExitError, currentPage, defaultCustomConfigDirPath, defaultCustomConfigFilePath, execute, extractExecutionErrorText, formatAutomatorLoginError, formatRetryHotkeyPrompt, formatWechatIdeLoginRequiredError, getAutomatorCommandHelp, getConfig, getConfiguredLocale, getDefaultCliPath, handleConfigCommand, input, isAutomatorCommand, isAutomatorLoginError, isDevtoolsHttpPortError, isOperatingSystemSupported, isWeappIdeTopLevelCommand, isWechatIdeLoginRequiredError, launchAutomator, navigateBack, navigateTo, operatingSystemName, overwriteCustomConfig, pageData, pageStack, parse, parseAutomatorArgs, parseScreenshotArgs, printScreenshotHelp, promptForCliPath, reLaunch, readCustomConfig, readOptionValue, redirectTo, remote, removeCustomConfigKey, removeOption, resolveCliPath, resolvePath, runAutomatorCommand, runMinidev, runWechatCliWithRetry, scrollTo, switchTab, systemInfo, takeScreenshot, tap, transformArgv, validateWechatCliCommandArgs, waitForRetryKeypress, withMiniProgram };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "weapp-ide-cli",
   "type": "module",
-  "version": "5.0.4",
+  "version": "5.1.1",
   "description": "让微信开发者工具，用起来更加方便！",
   "author": "ice breaker <1324318532@qq.com>",
   "license": "MIT",
@@ -63,16 +63,18 @@
   },
   "dependencies": {
     "execa": "9.6.1",
-    "fs-extra": "^11.3.3",
+    "fs-extra": "^11.3.4",
+    "miniprogram-automator": "^0.12.1",
     "pathe": "^2.0.3",
-    "@weapp-core/logger": "^3.1.0"
+    "@weapp-core/logger": "^3.1.1"
   },
   "scripts": {
-    "dev": "tsup --watch --sourcemap",
-    "build": "tsup",
+    "dev": "tsdown -w --sourcemap",
+    "build": "tsdown",
     "release": "node scripts/release.js",
     "test:dev": "vitest",
     "test": "vitest run",
+    "typecheck": "tsc --noEmit",
     "weapp": "tsx src/cli.ts",
     "debug": "tsx src/cli.ts config",
     "raw": "node bin/weapp.js",