@wwkit/shared 1.0.32 → 1.0.34

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wwkit/shared",
-  "version": "1.0.32",
+  "version": "1.0.34",
   "author": "bluesliu <langcai163@163.com>",
   "description": "Shared utilities for @wwkit packages — config loader, platform detection",
   "type": "module",

package/src/client-ops.js

@@ -0,0 +1,225 @@
+/**
+ * 跨平台客户端操作：打开浏览器 / 查找可执行文件 / 提权预检
+ *
+ * 封装 Windows / macOS / Linux 的客户端侧系统差异，供 @wwkit 各包复用：
+ *   - openBrowser    跨平台打开浏览器打开 URL（mac open / win cmd start / linux xdg-open）
+ *   - whichPath      跨平台查找可执行文件路径（win32 用 where，其余用 which）
+ *   - isWindowsAdmin Windows 管理员预检（net session；非 Windows 视为无需该权限）
+ *
+ * 设计原则：纯通用，不依赖任何包的配置/路径/状态目录；门控（如测试不弹浏览器）
+ * 由调用方自行判断，不进本模块。
+ */
+
+import { spawn, spawnSync } from 'node:child_process'
+import fs from 'node:fs'
+import net from 'node:net'
+import os from 'node:os'
+import path from 'node:path'
+
+/**
+ * 跨平台打开浏览器打开 URL。
+ * 打开失败静默返回 false（如无默认浏览器），不抛异常。
+ * @param {string} url
+ * @returns {boolean} 是否成功发起打开
+ */
+export function openBrowser(url) {
+  try {
+    const opts = { detached: true, stdio: 'ignore', windowsHide: true } // windowsHide：避免启动浏览器时 cmd 闪窗
+    let child
+    if (process.platform === 'win32') {
+      child = spawn('cmd', ['/c', 'start', '', url], opts)
+    } else if (process.platform === 'darwin') {
+      child = spawn('open', [url], opts)
+    } else {
+      child = spawn('xdg-open', [url], opts)
+    }
+    child.on('error', () => {}) // 打开失败静默（如无默认浏览器）
+    child.unref()
+    return true
+  } catch {
+    return false
+  }
+}
+
+// which 结果缓存：环境级探测（where/which 查 PATH）在轮询期反复调用，
+// 每 3s 一次 spawnSync 既浪费也不必要；TTL 60s 内直接复用。
+const _whichCache = new Map()
+const _WHICH_TTL_MS = 60_000
+
+/**
+ * 跨平台查找可执行文件路径（win32 用 where，其余用 which）；找不到返回 null。
+ * 结果缓存 60s，避免轮询期反复 spawn。
+ * @param {string} cmd
+ * @returns {string|null}
+ */
+export function whichPath(cmd) {
+  const now = Date.now()
+  const hit = _whichCache.get(cmd)
+  if (hit && now - hit.ts < _WHICH_TTL_MS) {
+    return hit.value
+  }
+  const tool = process.platform === 'win32' ? 'where' : 'which'
+  // windowsHide：Windows 下 where/which 是控制台程序，无此配置每次调用都会弹一个黑窗
+  const result = spawnSync(tool, [cmd], { encoding: 'utf-8', windowsHide: true })
+  const first = result.status === 0 ? String(result.stdout || '').trim().split('\n')[0] : null
+  _whichCache.set(cmd, { ts: now, value: first || null })
+  return first || null
+}
+
+/**
+ * Windows 管理员预检：net session 仅提权 shell 可成功；非 Windows 视为无需该权限。
+ * @returns {boolean}
+ */
+export function isWindowsAdmin() {
+  if (process.platform !== 'win32') return true
+  try {
+    spawnSync('net', ['session'], { stdio: 'pipe', windowsHide: true })
+    return true
+  } catch {
+    return false
+  }
+}
+
+/**
+ * 后台分离进程（detached + unref，父进程退出不受影响）；返回 child。
+ * @param {string} command
+ * @param {string[]} args
+ * @param {object} [opts]
+ * @returns {import('node:child_process').ChildProcess}
+ */
+export function spawnDetached(command, args, opts = {}) {
+  const proc = spawn(command, args, {
+    detached: true,
+    stdio: 'ignore',
+    windowsHide: false,
+    ...opts,
+  })
+  proc.unref()
+  return proc
+}
+
+/**
+ * pgrep 查找匹配进程 pid（win32 无 pgrep，返回 []）。
+ * 容错：spawnSync 在参数非法时同步抛错、在 EAGAIN/maxBuffer 溢出时返回 {error,status:null}，
+ * 一律按「无匹配」兜底，不抛异常。
+ * @param {string} pattern
+ * @returns {number[]}
+ */
+export function findPgrepPids(pattern) {
+  if (process.platform === 'win32') return []
+  let result
+  try {
+    result = spawnSync('pgrep', ['-f', pattern])
+  } catch {
+    return []
+  }
+  if (!result || result.status !== 0) return []
+  const pids = []
+  for (const line of String(result.stdout).trim().split('\n')) {
+    const pid = parseInt(line.trim(), 10)
+    if (Number.isFinite(pid)) pids.push(pid)
+  }
+  return pids
+}
+
+/**
+ * TCP 可达探测（连接成功 = true）。
+ * @param {string} host
+ * @param {number|string} port
+ * @param {number} [timeout=3000]
+ * @returns {Promise<boolean>}
+ */
+export function probeTcp(host, port, timeout = 3000) {
+  return new Promise((resolve) => {
+    const sock = net.connect({ host, port: Number(port), timeout })
+    sock.on('connect', () => { sock.destroy(); resolve(true) })
+    sock.on('error', () => resolve(false))
+    sock.on('timeout', () => { sock.destroy(); resolve(false) })
+  })
+}
+
+/**
+ * 本地端口是否已被监听。
+ * @param {number|string} port
+ * @param {string} [host='127.0.0.1']
+ * @returns {Promise<boolean>}
+ */
+export function isPortBusy(port, host = '127.0.0.1') {
+  return new Promise((resolve) => {
+    const s = net.createServer()
+    s.once('error', () => resolve(true))
+    s.once('listening', () => s.close(() => resolve(false)))
+    s.listen(Number(port), host)
+  })
+}
+
+/**
+ * 跨平台查找 Chrome 可执行文件路径；找不到返回 null。
+ * macOS 多候选（App/Canary/Chromium/Edge/Homebrew）；Linux 用 whichPath；
+ * Windows 用户级安装 → 注册表 App Paths → Program Files 两目录。
+ * @returns {string|null}
+ */
+export function getChromePath() {
+  if (process.platform === 'darwin') {
+    const candidates = [
+      '/Applications/Google Chrome.app/Contents/MacOS/Google Chrome',
+      '/Applications/Google Chrome Beta.app/Contents/MacOS/Google Chrome Beta',
+      '/Applications/Google Chrome Canary.app/Contents/MacOS/Google Chrome Canary',
+      '/Applications/Chromium.app/Contents/MacOS/Chromium',
+      '/Applications/Microsoft Edge.app/Contents/MacOS/Microsoft Edge',
+      path.join(os.homedir(), 'Applications', 'Google Chrome.app', 'Contents', 'MacOS', 'Google Chrome'),
+      whichPath('chromium'),
+      whichPath('google-chrome'),
+    ].filter(Boolean)
+    for (const c of candidates) {
+      if (fs.existsSync(c)) return c
+    }
+    return null
+  }
+  if (process.platform === 'linux') {
+    return whichPath('google-chrome') ?? whichPath('google-chrome-stable')
+  }
+  if (process.platform === 'win32') {
+    const candidates = [
+      process.env.LOCALAPPDATA ? path.join(process.env.LOCALAPPDATA, 'Google', 'Chrome', 'Application', 'chrome.exe') : null,
+      regAppPath('chrome.exe'),
+      process.env.PROGRAMFILES ? path.join(process.env.PROGRAMFILES, 'Google', 'Chrome', 'Application', 'chrome.exe') : null,
+      process.env['PROGRAMFILES(X86)'] ? path.join(process.env['PROGRAMFILES(X86)'], 'Google', 'Chrome', 'Application', 'chrome.exe') : null,
+    ]
+    for (const c of candidates) {
+      if (c && fs.existsSync(c)) return c
+    }
+    return null
+  }
+  return null
+}
+
+/** 从注册表 App Paths 读取可执行文件路径（Windows 内置 reg.exe，无额外依赖）；找不到返回 null */
+function regAppPath(name) {
+  if (process.platform !== 'win32') return null
+  try {
+    const r = spawnSync('reg', [
+      'query',
+      `HKCU\\Software\\Microsoft\\Windows\\CurrentVersion\\App Paths\\${name}`,
+      '/ve',
+    ], { encoding: 'utf-8', windowsHide: true })
+    if (r.status !== 0) {
+      const r2 = spawnSync('reg', [
+        'query',
+        `HKLM\\SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\App Paths\\${name}`,
+        '/ve',
+      ], { encoding: 'utf-8', windowsHide: true })
+      if (r2.status !== 0) return null
+      return parseRegDefault(r2.stdout)
+    }
+    return parseRegDefault(r.stdout)
+  } catch {
+    return null
+  }
+}
+
+function parseRegDefault(out) {
+  // reg query /ve 输出形如: "    (默认)    REG_SZ    C:\path\chrome.exe"
+  const m = String(out ?? '').match(/REG_SZ\s+(\S.*)$/m)
+  return m ? m[1].trim() : null
+}

package/src/index.js

@@ -1,5 +1,6 @@
 export { createConfigLoader, getXdgConfigDir, deepMerge, resolveEnvVars, resolvePkgVars } from './config-loader.js'
 export { Shell } from './shell.js'
+export { openBrowser, whichPath, isWindowsAdmin, spawnDetached, findPgrepPids, probeTcp, isPortBusy, getChromePath } from './client-ops.js'
 export { parseProxy, openTunnel, fetchText, downloadToFile } from './http.js'
 export { parseFlags, DEFAULT_BOOLEAN_FLAGS } from './args.js'
 export { default as JSON5 } from 'json5'