@ruan-cat/utils 4.20.0 → 4.21.0

package/dist/node-cjs/index.d.cts

@@ -159,6 +159,16 @@ type Prettify<T> = {
  */
 type ToNumberLike<T extends number> = T | `${T}`;
 
+/**
+ * 从给定目录开始，向上查找 monorepo 根目录。
+ * @description
+ * 通过查找 `pnpm-workspace.yaml` 文件来定位 monorepo 根目录。
+ * 该函数适用于脚本在 monorepo 子包内运行的场景。
+ *
+ * @param startDir 起始查找目录，默认值为 `process.cwd()`
+ * @returns 找到的 monorepo 根目录绝对路径；若未找到则返回 `null`
+ */
+declare function findMonorepoRoot(startDir?: string): string | null;
 /**
  * 判断目标项目是否是 monorepo 格式的项目
  * @description
@@ -172,4 +182,4 @@ type ToNumberLike<T extends number> = T | `${T}`;
  */
 declare function isMonorepoProject(): boolean;
 
-export { type BaseTask, type Condition, type Conditions, type ParallelTasks, type PnpmWorkspace, type Prettify, type PrintListParams, type PromiseTasksConfig, type QueueTasks, type SimpleAsyncTask, type SingleTasks, type SpawnSyncSimpleParams, type Task, type TaskType, type TasksConfig, type ToNumberLike, defPrintCurrentCommand, definePromiseTasks, executePromiseTasks, generateSimpleAsyncTask, generateSpawnSync, initFlag, isConditionsEvery, isConditionsSome, isMonorepoProject, pathChange, printFormat, printList, runPromiseByConcurrency, runPromiseByQueue, taskTypes };
+export { type BaseTask, type Condition, type Conditions, type ParallelTasks, type PnpmWorkspace, type Prettify, type PrintListParams, type PromiseTasksConfig, type QueueTasks, type SimpleAsyncTask, type SingleTasks, type SpawnSyncSimpleParams, type Task, type TaskType, type TasksConfig, type ToNumberLike, defPrintCurrentCommand, definePromiseTasks, executePromiseTasks, findMonorepoRoot, generateSimpleAsyncTask, generateSpawnSync, initFlag, isConditionsEvery, isConditionsSome, isMonorepoProject, pathChange, printFormat, printList, runPromiseByConcurrency, runPromiseByQueue, taskTypes };

package/dist/node-esm/index.d.ts

@@ -30,6 +30,83 @@ declare function clean(
  */
 targets?: string[]): Promise<void>;
 
+interface MoveVercelOutputToRootOptions {
+    /**
+     * 运行目录。
+     * 默认值为 `process.cwd()`。
+     */
+    cwd?: string;
+    /**
+     * monorepo 根目录。
+     * 不传时会从 `cwd` 开始，向上查找 `pnpm-workspace.yaml`。
+     */
+    rootDir?: string;
+    /**
+     * 子包内构建产物目录。
+     * 相对路径基于 `cwd` 解析。
+     *
+     * @default ".vercel/output"
+     */
+    sourceDir?: string;
+    /**
+     * monorepo 根目录内的目标输出目录。
+     * 相对路径基于 monorepo 根目录解析。
+     *
+     * @default ".vercel/output"
+     */
+    targetDir?: string;
+    /**
+     * 是否跳过目标目录清理。
+     *
+     * @default false
+     */
+    skipClean?: boolean;
+    /**
+     * 仅打印解析结果，不实际复制文件。
+     *
+     * @default false
+     */
+    dryRun?: boolean;
+}
+interface ResolvedMoveVercelOutputToRootOptions {
+    cwd: string;
+    monorepoRoot: string;
+    sourceDir: string;
+    targetDir: string;
+    skipClean: boolean;
+    dryRun: boolean;
+}
+interface MoveVercelOutputToRootResult extends ResolvedMoveVercelOutputToRootOptions {
+    copied: boolean;
+}
+/**
+ * 解析脚本所需的全部路径。
+ */
+declare function resolveMoveVercelOutputToRootOptions(options?: MoveVercelOutputToRootOptions): ResolvedMoveVercelOutputToRootOptions;
+/**
+ * 将当前子包内的 `.vercel/output` 移动到 monorepo 根目录。
+ * @description
+ * 该函数服务于 Vercel 在 monorepo 场景下的部署：
+ * 1. 构建仍在子包目录内执行
+ * 2. 产物默认出现在子包的 `.vercel/output`
+ * 3. Vercel 却要求在 monorepo 根目录下读取 `.vercel/output`
+ */
+declare function moveVercelOutputToRoot(options?: MoveVercelOutputToRootOptions): MoveVercelOutputToRootResult;
+/**
+ * 解析命令行参数。
+ */
+declare function parseMoveVercelOutputToRootCliArgs(args: string[]): MoveVercelOutputToRootOptions & {
+    help?: boolean;
+};
+/**
+ * CLI 帮助信息。
+ */
+declare function getMoveVercelOutputToRootHelpText(): string;
+/**
+ * 执行 CLI。
+ */
+declare function runMoveVercelOutputToRootCli(args?: string[]): void;
+
 interface WriteYaml2mdParams<T = Record<string, any>> {
     /** 目标md文件地址 */
     mdPath: string;
@@ -43,6 +120,16 @@ interface WriteYaml2mdParams<T = Record<string, any>> {
  */
 declare function writeYaml2md<T>(params: WriteYaml2mdParams<T>): void;
 
+/**
+ * 从给定目录开始，向上查找 monorepo 根目录。
+ * @description
+ * 通过查找 `pnpm-workspace.yaml` 文件来定位 monorepo 根目录。
+ * 该函数适用于脚本在 monorepo 子包内运行的场景。
+ *
+ * @param startDir 起始查找目录，默认值为 `process.cwd()`
+ * @returns 找到的 monorepo 根目录绝对路径；若未找到则返回 `null`
+ */
+declare function findMonorepoRoot(startDir?: string): string | null;
 /**
  * 判断目标项目是否是 monorepo 格式的项目
  * @description
@@ -56,4 +143,4 @@ declare function writeYaml2md<T>(params: WriteYaml2mdParams<T>): void;
  */
 declare function isMonorepoProject(): boolean;
 
-export { type PackageInfo, type WriteYaml2mdParams, clean, defaultCleanTargets, getRuanCatPkgInfo, isMonorepoProject, writeYaml2md };
+export { type MoveVercelOutputToRootOptions, type MoveVercelOutputToRootResult, type PackageInfo, type ResolvedMoveVercelOutputToRootOptions, type WriteYaml2mdParams, clean, defaultCleanTargets, findMonorepoRoot, getMoveVercelOutputToRootHelpText, getRuanCatPkgInfo, isMonorepoProject, moveVercelOutputToRoot, parseMoveVercelOutputToRootCliArgs, resolveMoveVercelOutputToRootOptions, runMoveVercelOutputToRootCli, writeYaml2md };

package/dist/node-esm/index.js

@@ -1,7 +1,7 @@
 // src/node-esm/ruan-cat-pkg-info.ts
 import { spawnSync } from "child_process";
 async function getRuanCatPkgInfo() {
-  return new Promise((resolve, reject) => {
+  return new Promise((resolve2, reject) => {
     const result = spawnSync("pnpm", ["s", "@ruan-cat/*", "--registry", "https://registry.npmmirror.com/", "--json"], {
       encoding: "utf-8"
     });
@@ -23,7 +23,7 @@ async function getRuanCatPkgInfo() {
         url: `https://npm.im/${pkg.name}`
       })
     );
-    resolve(res);
+    resolve2(res);
   });
 }
 
@@ -33,8 +33,8 @@ import { spawnSync as spawnSync2 } from "child_process";
 // src/simple-promise-tools.ts
 function generateSimpleAsyncTask(func) {
   return function(...args) {
-    return new Promise((resolve, reject) => {
-      resolve(func(...args));
+    return new Promise((resolve2, reject) => {
+      resolve2(func(...args));
     });
   };
 }
@@ -85,7 +85,7 @@ import { isPlainObject, isArray } from "lodash-es";
 import consola2 from "consola";
 
 // src/monorepo/index.ts
-import { join } from "path";
+import { dirname, join, parse, resolve } from "path";
 import * as fs from "fs";
 import { globSync } from "tinyglobby";
 
@@ -2715,8 +2715,22 @@ var jsYaml = {
 
 // src/monorepo/index.ts
 import { isUndefined } from "lodash-es";
-function pathChange(path) {
-  return path.replace(/\\/g, "/");
+function pathChange(path2) {
+  return path2.replace(/\\/g, "/");
+}
+function findMonorepoRoot(startDir = process.cwd()) {
+  let currentDir = resolve(startDir);
+  const fileSystemRoot = parse(currentDir).root;
+  while (true) {
+    const workspaceConfigPath = join(currentDir, "pnpm-workspace.yaml");
+    if (fs.existsSync(workspaceConfigPath)) {
+      return currentDir;
+    }
+    if (currentDir === fileSystemRoot) {
+      return null;
+    }
+    currentDir = dirname(currentDir);
+  }
 }
 function isMonorepoProject() {
   const workspaceConfigPath = join(process.cwd(), "pnpm-workspace.yaml");
@@ -2775,21 +2789,188 @@ async function clean(targets) {
   await doClean();
 }
 
+// src/node-esm/scripts/move-vercel-output-to-root/index.ts
+import * as fs2 from "fs";
+import path from "path";
+import { fileURLToPath } from "url";
+import consola3 from "consola";
+function resolvePathFromBase(baseDir, inputPath) {
+  if (path.isAbsolute(inputPath)) {
+    return path.normalize(inputPath);
+  }
+  return path.resolve(baseDir, inputPath);
+}
+function resolveMonorepoRoot(cwd, rootDir) {
+  if (rootDir) {
+    const resolvedRoot = resolvePathFromBase(cwd, rootDir);
+    const workspaceConfigPath = path.join(resolvedRoot, "pnpm-workspace.yaml");
+    if (!fs2.existsSync(workspaceConfigPath)) {
+      throw new Error(`\u6307\u5B9A\u7684 rootDir \u4E0D\u662F\u6709\u6548\u7684 monorepo \u6839\u76EE\u5F55\uFF1A${resolvedRoot}\u3002\u7F3A\u5C11 pnpm-workspace.yaml\u3002`);
+    }
+    return resolvedRoot;
+  }
+  const detectedRoot = findMonorepoRoot(cwd);
+  if (detectedRoot) {
+    return detectedRoot;
+  }
+  throw new Error(`\u65E0\u6CD5\u4ECE\u5F53\u524D\u76EE\u5F55\u5411\u4E0A\u5B9A\u4F4D monorepo \u6839\u76EE\u5F55\uFF1A${cwd}\u3002\u8BF7\u663E\u5F0F\u4F20\u5165 --root-dir \u53C2\u6570\u3002`);
+}
+function resolveMoveVercelOutputToRootOptions(options = {}) {
+  const cwd = path.resolve(options.cwd ?? process.cwd());
+  const monorepoRoot = resolveMonorepoRoot(cwd, options.rootDir);
+  const sourceDir = resolvePathFromBase(cwd, options.sourceDir ?? ".vercel/output");
+  const targetDir = resolvePathFromBase(monorepoRoot, options.targetDir ?? ".vercel/output");
+  if (sourceDir === targetDir) {
+    throw new Error(`\u6E90\u76EE\u5F55\u548C\u76EE\u6807\u76EE\u5F55\u89E3\u6790\u5230\u4E86\u540C\u4E00\u8DEF\u5F84\uFF1A${sourceDir}\u3002\u8BF7\u8C03\u6574 sourceDir \u6216 targetDir\u3002`);
+  }
+  return {
+    cwd,
+    monorepoRoot,
+    sourceDir,
+    targetDir,
+    skipClean: options.skipClean ?? false,
+    dryRun: options.dryRun ?? false
+  };
+}
+function copyDirectoryContents(sourceDir, targetDir) {
+  fs2.mkdirSync(targetDir, { recursive: true });
+  for (const entryName of fs2.readdirSync(sourceDir)) {
+    const sourceEntry = path.join(sourceDir, entryName);
+    const targetEntry = path.join(targetDir, entryName);
+    fs2.cpSync(sourceEntry, targetEntry, {
+      force: true,
+      recursive: true
+    });
+  }
+}
+function moveVercelOutputToRoot(options = {}) {
+  const resolvedOptions = resolveMoveVercelOutputToRootOptions(options);
+  if (!fs2.existsSync(resolvedOptions.sourceDir)) {
+    throw new Error(`\u6E90\u76EE\u5F55\u4E0D\u5B58\u5728\uFF0C\u65E0\u6CD5\u642C\u8FD0 Vercel \u6784\u5EFA\u4EA7\u7269\uFF1A${resolvedOptions.sourceDir}\u3002\u8BF7\u5148\u5728\u5B50\u5305\u5185\u5B8C\u6210\u6784\u5EFA\u3002`);
+  }
+  if (!fs2.statSync(resolvedOptions.sourceDir).isDirectory()) {
+    throw new Error(`\u6E90\u8DEF\u5F84\u4E0D\u662F\u76EE\u5F55\uFF1A${resolvedOptions.sourceDir}`);
+  }
+  consola3.info("move-vercel-output-to-root \u89E3\u6790\u7ED3\u679C");
+  consola3.log(`- cwd: ${resolvedOptions.cwd}`);
+  consola3.log(`- monorepoRoot: ${resolvedOptions.monorepoRoot}`);
+  consola3.log(`- sourceDir: ${resolvedOptions.sourceDir}`);
+  consola3.log(`- targetDir: ${resolvedOptions.targetDir}`);
+  consola3.log(`- skipClean: ${resolvedOptions.skipClean}`);
+  consola3.log(`- dryRun: ${resolvedOptions.dryRun}`);
+  if (resolvedOptions.dryRun) {
+    consola3.info("dry-run \u6A21\u5F0F\uFF1A\u4EC5\u8F93\u51FA\u8DEF\u5F84\u4FE1\u606F\uFF0C\u4E0D\u6267\u884C\u590D\u5236\u3002");
+    return {
+      ...resolvedOptions,
+      copied: false
+    };
+  }
+  if (!resolvedOptions.skipClean) {
+    fs2.rmSync(resolvedOptions.targetDir, {
+      force: true,
+      recursive: true
+    });
+  }
+  copyDirectoryContents(resolvedOptions.sourceDir, resolvedOptions.targetDir);
+  consola3.success(`\u5DF2\u5C06 ${resolvedOptions.sourceDir} \u642C\u8FD0\u5230 ${resolvedOptions.targetDir}`);
+  return {
+    ...resolvedOptions,
+    copied: true
+  };
+}
+function parseMoveVercelOutputToRootCliArgs(args) {
+  const options = {};
+  const readFlagValue = (flagName, currentIndex) => {
+    const value = args[currentIndex + 1];
+    if (!value || value.startsWith("--")) {
+      throw new Error(`\u53C2\u6570 ${flagName} \u7F3A\u5C11\u5BF9\u5E94\u7684\u503C\u3002`);
+    }
+    return value;
+  };
+  for (let index = 0; index < args.length; index += 1) {
+    const currentArg = args[index];
+    switch (currentArg) {
+      case "--root-dir":
+        options.rootDir = readFlagValue(currentArg, index);
+        index += 1;
+        break;
+      case "--source-dir":
+        options.sourceDir = readFlagValue(currentArg, index);
+        index += 1;
+        break;
+      case "--target-dir":
+        options.targetDir = readFlagValue(currentArg, index);
+        index += 1;
+        break;
+      case "--skip-clean":
+        options.skipClean = true;
+        break;
+      case "--dry-run":
+        options.dryRun = true;
+        break;
+      case "--help":
+      case "-h":
+        options.help = true;
+        break;
+      default:
+        throw new Error(`\u4E0D\u652F\u6301\u7684\u53C2\u6570\uFF1A${currentArg}`);
+    }
+  }
+  return options;
+}
+function getMoveVercelOutputToRootHelpText() {
+  return [
+    "tsx @ruan-cat/utils/move-vercel-output-to-root [options]",
+    "",
+    "\u9009\u9879\uFF1A",
+    "  --root-dir <path>    \u663E\u5F0F\u6307\u5B9A monorepo \u6839\u76EE\u5F55",
+    "  --source-dir <path>  \u6307\u5B9A\u5B50\u5305\u5185\u6784\u5EFA\u4EA7\u7269\u76EE\u5F55\uFF0C\u9ED8\u8BA4 .vercel/output",
+    "  --target-dir <path>  \u6307\u5B9A\u6839\u76EE\u5F55\u5185\u76EE\u6807\u76EE\u5F55\uFF0C\u9ED8\u8BA4 .vercel/output",
+    "  --skip-clean         \u8DF3\u8FC7\u76EE\u6807\u76EE\u5F55\u6E05\u7406",
+    "  --dry-run            \u4EC5\u6253\u5370\u8DEF\u5F84\u89E3\u6790\u7ED3\u679C\uFF0C\u4E0D\u6267\u884C\u590D\u5236",
+    "  -h, --help           \u67E5\u770B\u5E2E\u52A9\u4FE1\u606F"
+  ].join("\n");
+}
+function runMoveVercelOutputToRootCli(args = process.argv.slice(2)) {
+  const cliOptions = parseMoveVercelOutputToRootCliArgs(args);
+  if (cliOptions.help) {
+    console.log(getMoveVercelOutputToRootHelpText());
+    return;
+  }
+  moveVercelOutputToRoot(cliOptions);
+}
+function isRunningAsCli() {
+  const currentFilePath = fileURLToPath(import.meta.url);
+  const entryPath = process.argv[1];
+  if (!entryPath) {
+    return false;
+  }
+  return path.resolve(entryPath) === currentFilePath;
+}
+if (isRunningAsCli()) {
+  try {
+    runMoveVercelOutputToRootCli();
+  } catch (error) {
+    consola3.error(error instanceof Error ? error.message : String(error));
+    process.exitCode = 1;
+  }
+}
+
 // src/node-esm/yaml-to-md.ts
 import { readFileSync as readFileSync2, writeFileSync } from "fs";
-import { consola as consola3 } from "consola";
+import { consola as consola4 } from "consola";
 import { isUndefined as isUndefined2 } from "lodash-es";
 function writeYaml2md(params) {
-  consola3.info(` \u5F53\u524D\u8FD0\u884C\u7684\u5730\u5740\u4E3A\uFF1A ${process.cwd()} `);
+  consola4.info(` \u5F53\u524D\u8FD0\u884C\u7684\u5730\u5740\u4E3A\uFF1A ${process.cwd()} `);
   const { mdPath, data } = params;
   if (isUndefined2(mdPath)) {
-    consola3.error(" \u8BF7\u63D0\u4F9Bmd\u6587\u4EF6\u7684\u5730\u5740 ");
+    consola4.error(" \u8BF7\u63D0\u4F9Bmd\u6587\u4EF6\u7684\u5730\u5740 ");
     process.exit(1);
   }
   try {
     readFileSync2(mdPath, "utf-8");
   } catch (error) {
-    consola3.error(` \u6587\u4EF6 ${mdPath} \u4E0D\u5B58\u5728 `);
+    consola4.error(` \u6587\u4EF6 ${mdPath} \u4E0D\u5B58\u5728 `);
     process.exit(1);
   }
   const mdContent = readFileSync2(mdPath, "utf-8");
@@ -2799,13 +2980,19 @@ ${yamlContent}---
 
 ${mdContent}`;
   writeFileSync(mdPath, newContent, "utf-8");
-  consola3.success(` \u5DF2\u5C06YAML\u6570\u636E\u5199\u5165\u5230 ${mdPath} `);
+  consola4.success(` \u5DF2\u5C06YAML\u6570\u636E\u5199\u5165\u5230 ${mdPath} `);
 }
 export {
   clean,
   defaultCleanTargets,
+  findMonorepoRoot,
+  getMoveVercelOutputToRootHelpText,
   getRuanCatPkgInfo,
   isMonorepoProject,
+  moveVercelOutputToRoot,
+  parseMoveVercelOutputToRootCliArgs,
+  resolveMoveVercelOutputToRootOptions,
+  runMoveVercelOutputToRootCli,
   writeYaml2md
 };
 /*! Bundled license information: