@wwkit/shared 1.0.4 → 1.0.6

package/package.json

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

package/src/config-loader.js

@@ -2,9 +2,76 @@ import fs from 'node:fs'
 import path from 'node:path'
 import os from 'node:os'
 import process from 'node:process'
+import { fileURLToPath } from 'node:url'
+import { createRequire } from 'node:module'
 import JSON5 from 'json5'
 
-const ENV_PATTERN = /\{env:(\w+)\}/
+const ENV_PATTERN = /\{env:(\w+)\}/g
+const PKG_PATTERN = /\{pkg:([^}]+)\}/g
+
+const _require = createRequire(import.meta.url)
+const _selfDir = path.dirname(fileURLToPath(import.meta.url))
+
+/**
+ * 向上查找 pnpm 工作区根目录
+ * @param {string} startDir
+ * @returns {string|null}
+ */
+function findWorkspaceRoot(startDir) {
+  let dir = startDir
+  while (dir !== path.dirname(dir)) {
+    if (fs.existsSync(path.join(dir, 'pnpm-workspace.yaml'))) return dir
+    const packagesDir = path.join(dir, 'packages')
+    if (fs.existsSync(packagesDir) && fs.existsSync(path.join(dir, 'package.json'))) {
+      try {
+        const pkg = JSON.parse(fs.readFileSync(path.join(dir, 'package.json'), 'utf8'))
+        if (pkg.private && pkg.workspaces) return dir
+      } catch {}
+    }
+    dir = path.dirname(dir)
+  }
+  return null
+}
+
+/**
+ * 解析 npm 包的安装目录路径
+ * 策略：1) require.resolve（已发布/已安装） 2) 工作区 packages/ 回退
+ * @param {string} pkgName - 包名，如 @wwkit/harness
+ * @returns {string} 目录路径，找不到时返回空串
+ */
+function resolvePkgPath(pkgName) {
+  try {
+    const pkgJsonPath = _require.resolve(`${pkgName}/package.json`)
+    return path.dirname(pkgJsonPath)
+  } catch {}
+  try {
+    const entry = _require.resolve(pkgName)
+    let dir = path.dirname(entry)
+    while (dir !== path.dirname(dir)) {
+      const pkgJson = path.join(dir, 'package.json')
+      if (fs.existsSync(pkgJson)) {
+        try {
+          const pkg = JSON.parse(fs.readFileSync(pkgJson, 'utf8'))
+          if (pkg.name === pkgName) return dir
+        } catch {}
+      }
+      dir = path.dirname(dir)
+    }
+  } catch {}
+  const wsRoot = findWorkspaceRoot(_selfDir)
+  if (wsRoot) {
+    const seg = pkgName.includes('/') ? pkgName.split('/').pop() : pkgName
+    const candidate = path.join(wsRoot, 'packages', seg)
+    const pkgJson = path.join(candidate, 'package.json')
+    if (fs.existsSync(pkgJson)) {
+      try {
+        const pkg = JSON.parse(fs.readFileSync(pkgJson, 'utf8'))
+        if (pkg.name === pkgName) return candidate
+      } catch {}
+    }
+  }
+  return ''
+}
 
 /**
  * 递归合并对象，override 优先，嵌套对象深合并（数组/标量直接覆盖）。
@@ -40,6 +107,24 @@ export function resolveEnvVars(value, env = process.env) {
   return value
 }
 
+/**
+ * 递归解析字符串中的 {pkg:NAME} 占位符，替换为包安装目录（找不到则为空串）。
+ */
+export function resolvePkgVars(value) {
+  if (typeof value === 'string') {
+    return value.replace(PKG_PATTERN, (_, name) => resolvePkgPath(name.trim()))
+  }
+  if (Array.isArray(value)) {
+    return value.map((v) => resolvePkgVars(v))
+  }
+  if (value && typeof value === 'object') {
+    const out = {}
+    for (const [k, v] of Object.entries(value)) out[k] = resolvePkgVars(v)
+    return out
+  }
+  return value
+}
+
 /**
  * 多层配置加载器：内置 config.json5 + 用户 config.json5 + 环境变量注入内容（优先级从低到高）。
  *
@@ -88,7 +173,7 @@ export function createConfigLoader({ builtinConfigPath, userConfigDir, envConten
     if (envContentVar) {
       merged = deepMerge(merged, loadContent(process.env[envContentVar]))
     }
-    return resolveEnvVars(merged)
+    return resolvePkgVars(resolveEnvVars(merged))
   }
 
   function copyBuiltinConfig() {

package/src/index.js

@@ -1 +1,2 @@
-export { createConfigLoader, getXdgConfigDir, deepMerge, resolveEnvVars } from './config-loader.js'
+export { createConfigLoader, getXdgConfigDir, deepMerge, resolveEnvVars, resolvePkgVars } from './config-loader.js'
+export { Shell } from './shell.js'

package/src/release.js

@@ -41,16 +41,16 @@ function resolvePublishRegistry(pkgDir) {
   }
 }
 
-// 发布前检查: git 工作区干净 + npm 已登录。失败抛出 Error。
+// 发布前检查: git 工作区干净（不干净仅告警）+ npm 已登录（未登录抛出 Error）。
 // pkgDir 给定时，针对该包 publishConfig.registry 检查登录（而非 .npmrc 里可能指向镜像的 registry）。
 export function preflight({ dryRun = false, pkgDir = null } = {}) {
   const gitStatus = runQuiet('git status --porcelain')
   if (gitStatus) {
-    console.error('✗ Git 工作区不干净，请先提交或 stash')
-    console.error(gitStatus)
-    throw new Error('git-not-clean')
+    console.warn('⚠ Git 工作区不干净（仅告警，继续发布）')
+    console.warn(gitStatus)
+  } else {
+    console.log('  ✓ Git 工作区干净')
   }
-  console.log('  ✓ Git 工作区干净')
   const registry = pkgDir ? resolvePublishRegistry(pkgDir) : null
   const whoamiCmd = registry ? `npm whoami --registry=${registry}` : 'npm whoami'
   try {
@@ -75,7 +75,7 @@ export function releasePackage({ pkgDir, dryRun = false } = {}) {
   console.log(`━━━ 发布 ${name}@${newVer}（原 ${oldVer}）━━━`)
 
   // 1. bump version (no git tag — scoped tag created manually below)
-  run('pnpm version patch --no-git-tag-version', { cwd: pkgDir, dryRun })
+  run('pnpm version patch --no-git-tag-version --no-git-checks', { cwd: pkgDir, dryRun })
 
   // 2. publish (prepublishOnly hook runs tests automatically)
   run('pnpm publish --no-git-checks', { cwd: pkgDir, dryRun })

package/src/shell.js

@@ -0,0 +1,164 @@
+/**
+ * 跨平台 shell / 系统环境处理
+ *
+ * 封装 Windows / macOS / Linux 的 shell 与系统环境差异，供 @wwkit 各包复用：
+ *   - 平台检测（isWindows / isMac / isLinux）
+ *   - bash 解析（nvm / phpenv 等 bash 工具需要；Windows 下找 Git Bash / WSL）
+ *   - execSync / spawnSync 的 shell 选项选择
+ *   - shell profile 文件路径检测与写入（.zshrc / .bashrc / .profile）
+ *
+ * 用法：
+ *   import { Shell } from '@wwkit/shared'
+ *   const shell = new Shell()
+ *   execSync(cmd, { shell: shell.shellForExec(true) })
+ *   shell.writeProfile('NVM_DIR', 'nvm', ['export NVM_DIR=...'])
+ */
+
+import fs from 'node:fs'
+import os from 'node:os'
+import path from 'node:path'
+import { execSync, spawnSync } from 'node:child_process'
+
+export class Shell {
+  /**
+   * @param {{ platform?: string, env?: Record<string,string> }} [opts]
+   *        platform / env 注入用于测试；默认取 process.platform / process.env
+   */
+  constructor({ platform = process.platform, env = process.env } = {}) {
+    this.platform = platform
+    this.env = env
+  }
+
+  /** 是否为 Windows */
+  get isWindows() {
+    return this.platform === 'win32'
+  }
+
+  /** 是否为 macOS */
+  get isMac() {
+    return this.platform === 'darwin'
+  }
+
+  /** 是否为 Linux */
+  get isLinux() {
+    return this.platform === 'linux'
+  }
+
+  /**
+   * 解析可用的 bash 路径
+   *
+   * Unix: 优先 /bin/bash（原行为），回退 /usr/bin/bash，再回退 PATH 中的 bash
+   * Windows: 在 PATH 中查找 bash（Git Bash / WSL 提供）；找不到则抛错
+   *
+   * @returns {string} bash 可执行文件路径
+   * @throws {Error} 找不到 bash 时抛出（含平台相关提示）
+   */
+  resolveBash() {
+    if (!this.isWindows) {
+      for (const c of ['/bin/bash', '/usr/bin/bash']) {
+        try {
+          fs.accessSync(c, fs.constants.X_OK)
+          return c
+        } catch {}
+      }
+    }
+
+    try {
+      const cmd = this.isWindows ? 'where bash' : 'command -v bash'
+      const out = execSync(cmd, { encoding: 'utf8', stdio: ['pipe', 'pipe', 'pipe'] }).trim()
+      if (out) return out.split(/\r?\n/)[0]
+    } catch {}
+
+    throw new Error(
+      'bash not found: nvm/phpenv require bash. ' +
+      (this.isWindows ? 'Install Git Bash or run inside WSL.' : 'Install bash.')
+    )
+  }
+
+  /**
+   * 返回 execSync / spawnSync 的 shell 选项
+   *
+   * needsBash=true  → 解析并返回 bash 路径（nvm/phpenv 等 bash 工具）
+   * needsBash=false → 返回 true（使用系统默认 shell：Unix /bin/sh，Windows cmd.exe）
+   *
+   * @param {boolean} needsBash - 命令是否需要 bash
+   * @returns {string|boolean}
+   */
+  shellForExec(needsBash) {
+    return needsBash ? this.resolveBash() : true
+  }
+
+  /**
+   * 检测当前 shell 的 profile 文件路径
+   *
+   * Unix: $SHELL 含 zsh → ~/.zshrc；含 bash → ~/.bashrc；否则 ~/.profile
+   * Windows: 无 $SHELL，默认 ~/.bashrc（Git Bash 约定）
+   *
+   * @returns {string}
+   */
+  getProfile() {
+    const shell = this.env.SHELL || ''
+    if (shell.includes('zsh')) {
+      return path.join(os.homedir(), '.zshrc')
+    }
+    if (shell.includes('bash')) {
+      return path.join(os.homedir(), '.bashrc')
+    }
+    if (this.isWindows) {
+      return path.join(os.homedir(), '.bashrc')
+    }
+    return path.join(os.homedir(), '.profile')
+  }
+
+  /**
+   * 将 shell 初始化行写入 profile（按 marker 去重）
+   *
+   * @param {string} marker - 若 profile 已含该标记则跳过
+   * @param {string} comment - 写入块注释
+   * @param {string[]} lines - 要追加的行
+   * @returns {boolean} 是否写入了新行
+   */
+  writeProfile(marker, comment, lines) {
+    const profilePath = this.getProfile()
+    let existing = ''
+    try {
+      existing = fs.readFileSync(profilePath, 'utf8')
+    } catch {}
+    if (existing.includes(marker)) {
+      return false
+    }
+    const append = `\n# ${comment}\n${lines.join('\n')}\n`
+    fs.appendFileSync(profilePath, append, 'utf8')
+    return true
+  }
+
+  /**
+   * 检测系统命令是否可用
+   * Windows: where <cmd>；Unix: which <cmd>
+   *
+   * @param {string} cmd - 命令名
+   * @returns {boolean}
+   */
+  isCommandAvailable(cmd) {
+    const checker = this.isWindows ? 'where' : 'which'
+    try {
+      const result = spawnSync(checker, [cmd], { encoding: 'utf8', stdio: ['pipe', 'pipe', 'pipe'] })
+      return result.status === 0
+    } catch {
+      return false
+    }
+  }
+
+  /**
+   * 按优先级检测可用的网络探测工具
+   * 顺序: ping > curl > wget
+   *
+   * @returns {string|null} 'ping' | 'curl' | 'wget' | null
+   */
+  getNetProbeTool() {
+    for (const cmd of ['ping', 'curl', 'wget']) {
+      if (this.isCommandAvailable(cmd)) return cmd
+    }
+    return null
+  }
+}