@icebreakers/monorepo 2.2.0 → 3.0.0

package/dist/index.d.mts

@@ -0,0 +1,509 @@
+import * as git_url_parse0 from "git-url-parse";
+import gitUrlParse from "git-url-parse";
+import * as simple_git0 from "simple-git";
+import { ConfigValues, SimpleGit, SimpleGitOptions } from "simple-git";
+import * as consola0 from "consola";
+import crypto from "node:crypto";
+import * as _pnpm_types0 from "@pnpm/types";
+import { PackageJson } from "pkg-types";
+
+//#region src/types/cli.d.ts
+/**
+ * CLI 公用参数，保证各命令对外暴露一致的行为。
+ */
+interface CliOpts {
+  /**
+   * 是否开启交互模式，开启后每一步都会提示用户确认。
+   * @default false
+   */
+  interactive?: boolean;
+  /**
+   * 是否使用 core 版资产，只同步最精简的文件集合。
+   * @default false
+   */
+  core?: boolean;
+  /**
+   * 输出目录（相对 `cwd`），用于放置生成或拷贝出来的文件。
+   * @default ''
+   */
+  outDir?: string;
+  /**
+   * 命令执行的工作目录。
+   * @default process.cwd()
+   */
+  cwd?: string;
+  /**
+   * 是否跳过已有文件的覆写；开启后保留旧文件不做对比。
+   * @default false
+   */
+  skipOverwrite?: boolean;
+}
+//#endregion
+//#region src/commands/create.d.ts
+/**
+ * 内置模板映射表，value 指向仓库中对应模板所在路径。
+ */
+declare const templateMap: {
+  readonly tsup: "packages/tsup-template";
+  readonly tsdown: "packages/tsdown-template";
+  readonly unbuild: "packages/unbuild-template";
+  readonly 'vue-lib': "packages/vue-lib-template";
+  readonly 'hono-server': "apps/server";
+  readonly 'vue-hono': "apps/client";
+  readonly vitepress: "apps/website";
+  readonly cli: "apps/cli";
+};
+type CreateNewProjectType = keyof typeof templateMap;
+interface CreateNewProjectOptions {
+  name?: string;
+  cwd?: string;
+  renameJson?: boolean;
+  type?: CreateNewProjectType | string;
+}
+/**
+ * 若配置中提供 choices 则优先使用，否则退回默认预设。
+ */
+declare function getCreateChoices(choices?: CreateChoiceOption[]): CreateChoiceOption[] | ({
+  readonly name: "unbuild 打包";
+  readonly value: "unbuild";
+} | {
+  readonly name: "tsup 打包";
+  readonly value: "tsup";
+} | {
+  readonly name: "tsdown 打包";
+  readonly value: "tsdown";
+} | {
+  readonly name: "vue 组件";
+  readonly value: "vue-lib";
+} | {
+  readonly name: "vue hono 全栈";
+  readonly value: "vue-hono";
+} | {
+  readonly name: "hono 模板";
+  readonly value: "hono-server";
+} | {
+  readonly name: "vitepress 文档";
+  readonly value: "vitepress";
+} | {
+  readonly name: "cli 模板";
+  readonly value: "cli";
+})[];
+/**
+ * 合并内置与自定义模板映射，允许扩展新的模板类型。
+ */
+declare function getTemplateMap(extra?: Record<string, string>): Record<string, string>;
+/**
+ * 根据提供的参数或配置生成新工程目录，并可自动改写 package.json。
+ */
+declare function createNewProject(options?: CreateNewProjectOptions): Promise<void>;
+//#endregion
+//#region src/types/workspace.d.ts
+/**
+ * 工作区工具可接收的筛选选项。
+ */
+interface GetWorkspacePackagesOptions {
+  /**
+   * 是否在结果中排除 workspace 根包。
+   * @default true
+   */
+  ignoreRootPackage?: boolean;
+  /**
+   * 是否过滤掉标记为 `private` 的包。
+   * @default true
+   */
+  ignorePrivatePackage?: boolean;
+  /**
+   * 自定义 glob，覆盖 `pnpm-workspace.yaml` 的 `packages` 配置。
+   * @default workspace manifest `packages`
+   */
+  patterns?: string[];
+}
+//#endregion
+//#region src/types/config.d.ts
+/**
+ * `monorepo new` 命令的配置项，允许外部覆写模板目录、模板清单等。
+ */
+interface CreateCommandConfig extends Partial<Omit<CreateNewProjectOptions, 'cwd'>> {
+  /**
+   * 自定义模板根目录。
+   * @default 内置模板所在的 `packages/monorepo/templates`
+   */
+  templatesDir?: string;
+  /**
+   * 扩展模板映射表，key 为类型，value 为模板相对路径。
+   * @default 内置 `templateMap`
+   */
+  templateMap?: Record<string, string>;
+  /**
+   * 自定义交互提示的选项列表。
+   * @default 内置 `baseChoices`
+   */
+  choices?: CreateChoiceOption[];
+  /**
+   * 当未选择模板时使用的默认模板。
+   * @default 'unbuild'
+   */
+  defaultTemplate?: CreateNewProjectOptions['type'];
+}
+/**
+ * CLI 交互式选择框的选项结构。
+ */
+interface CreateChoiceOption {
+  /**
+   * 唯一值，将回传给命令逻辑使用。
+   * @default undefined
+   */
+  value: string;
+  /**
+   * 选项展示名称。
+   * @default value
+   */
+  name?: string;
+  /**
+   * 选项描述信息。
+   * @default undefined
+   */
+  description?: string;
+  /**
+   * 短名称，用于命令行紧凑展示。
+   * @default undefined
+   */
+  short?: string;
+  /**
+   * 设置为 true 或字符串即可禁用该选项并显示原因。
+   * @default false
+   */
+  disabled?: boolean | string;
+}
+/**
+ * `monorepo clean` 命令配置，可控制自动选择、排除包等行为。
+ */
+interface CleanCommandConfig {
+  /**
+   * 是否跳过交互直接清理全部。
+   * @default false
+   */
+  autoConfirm?: boolean;
+  /**
+   * 不允许被清理的包名列表。
+   * @default []
+   */
+  ignorePackages?: string[];
+  /**
+   * 是否包含 private 包。
+   * @default false
+   */
+  includePrivate?: boolean;
+  /**
+   * 强制写回的 @icebreakers/monorepo 版本。
+   * @default 当前依赖版本
+   */
+  pinnedVersion?: string;
+}
+/**
+ * `monorepo sync` 命令配置，可覆盖 workspace 过滤规则或同步命令模板。
+ */
+interface SyncCommandConfig extends Partial<GetWorkspacePackagesOptions> {
+  /**
+   * 并发执行同步命令的最大数量。
+   * @default os.cpus().length
+   */
+  concurrency?: number;
+  /**
+   * 自定义执行的同步命令模板，使用 {name} 占位。
+   * @default 'cnpm sync {name}'
+   */
+  command?: string;
+  /**
+   * 仅同步指定的包（按名称过滤）。
+   * @default 同步全部可见包
+   */
+  packages?: string[];
+}
+/**
+ * `monorepo upgrade` 命令配置，覆盖脚本、目标文件等能力。
+ */
+interface UpgradeCommandConfig extends Partial<CliOpts> {
+  /**
+   * 额外需要写入的目标文件列表。
+   * @default []
+   */
+  targets?: string[];
+  /**
+   * 是否与默认目标合并，false 表示完全覆盖。
+   * @default true
+   */
+  mergeTargets?: boolean;
+  /**
+   * 需要写入 package.json 的脚本集合。
+   * @default {}
+   */
+  scripts?: Record<string, string>;
+  /**
+   * 是否跳过生成 changeset markdown。
+   * @default true
+   */
+  skipChangesetMarkdown?: boolean;
+}
+/**
+ * `monorepo init` 命令配置，用于跳过部分初始化步骤。
+ */
+interface InitCommandConfig {
+  /**
+   * 是否跳过 README 生成。
+   * @default false
+   */
+  skipReadme?: boolean;
+  /**
+   * 是否跳过 package.json 写入。
+   * @default false
+   */
+  skipPkgJson?: boolean;
+  /**
+   * 是否跳过 changeset 的更新。
+   * @default false
+   */
+  skipChangeset?: boolean;
+}
+/**
+ * `monorepo mirror` 命令配置，可增加额外的环境变量镜像。
+ */
+interface MirrorCommandConfig {
+  /**
+   * 需要注入的环境变量键值对。
+   * @default {}
+   */
+  env?: Record<string, string>;
+}
+/**
+ * 项目级配置入口，按命令划分可插拔的配置块。
+ */
+interface MonorepoConfig {
+  /**
+   * 按命令分类的可选配置。
+   * @default {}
+   */
+  commands?: {
+    create?: CreateCommandConfig;
+    clean?: CleanCommandConfig;
+    sync?: SyncCommandConfig;
+    upgrade?: UpgradeCommandConfig;
+    init?: InitCommandConfig;
+    mirror?: MirrorCommandConfig;
+  };
+}
+//#endregion
+//#region src/core/git.d.ts
+/**
+ * 对 simple-git 的轻量封装，集中处理配置缓存与常用查询。
+ */
+declare class GitClient {
+  #private;
+  private readonly client;
+  constructor(options?: Partial<SimpleGitOptions>);
+  /**
+   * 读取 Git 的 config 列表，原样返回 simple-git 的结果。
+   */
+  listConfig(): simple_git0.Response<simple_git0.ConfigListSummary>;
+  /**
+   * 初始化配置缓存，避免多次访问 Git 产生的性能损耗。
+   */
+  init(): Promise<ConfigValues>;
+  /**
+   * 获取缓存的配置，若未初始化则自动触发 init。
+   */
+  getConfig(): Promise<ConfigValues>;
+  /**
+   * 解析 remote.origin.url，返回 git-url-parse 的结构，便于获取仓库元信息。
+   */
+  getGitUrl(): Promise<gitUrlParse.GitUrl | undefined>;
+  /**
+   * 组合 owner/name，生成常用的仓库名表达。
+   */
+  getRepoName(): Promise<string | undefined>;
+  /**
+   * 从 Git 配置中提取用户信息，用于填充 package.json author 字段。
+   */
+  getUser(): Promise<{
+    name: string;
+    email: string;
+  }>;
+  /**
+   * 获取当前仓库的顶层目录路径。
+   */
+  getRepoRoot(): Promise<string | undefined>;
+}
+//#endregion
+//#region src/core/workspace.d.ts
+/**
+ * 读取 pnpm workspace 下的所有包，并根据配置过滤与补充字段。
+ */
+declare function getWorkspacePackages(workspaceDir: string, options?: GetWorkspacePackagesOptions): Promise<{
+  pkgJsonPath: string;
+  rootDir: _pnpm_types0.ProjectRootDir;
+  rootDirRealPath: _pnpm_types0.ProjectRootDirRealPath;
+  modulesDir?: string;
+  manifest: _pnpm_types0.ProjectManifest;
+  writeProjectManifest: (manifest: _pnpm_types0.ProjectManifest, force?: boolean | undefined) => Promise<void>;
+}[]>;
+/**
+ * 将工作区绝对路径、包列表与当前 cwd 打包返回，方便调用方一次获取所有信息。
+ */
+declare function getWorkspaceData(cwd: string, options?: GetWorkspacePackagesOptions): Promise<{
+  cwd: string;
+  workspaceDir: string;
+  packages: {
+    pkgJsonPath: string;
+    rootDir: _pnpm_types0.ProjectRootDir;
+    rootDirRealPath: _pnpm_types0.ProjectRootDirRealPath;
+    modulesDir?: string;
+    manifest: _pnpm_types0.ProjectManifest;
+    writeProjectManifest: (manifest: _pnpm_types0.ProjectManifest, force?: boolean | undefined) => Promise<void>;
+  }[];
+}>;
+//#endregion
+//#region src/commands/clean.d.ts
+/**
+ * 交互式清理被选中的包目录，同时重写根 package.json 中的 @icebreakers/monorepo 版本。
+ */
+declare function cleanProjects(cwd: string): Promise<void>;
+//#endregion
+//#region src/commands/init/index.d.ts
+/**
+ * 初始化命令入口，根据配置逐步生成基础文件。
+ */
+declare function init(cwd: string): Promise<void>;
+//#endregion
+//#region src/commands/mirror/binaryMirror.d.ts
+/**
+ * 根据中国大陆镜像源，自动向 VSCode settings.json 注入终端环境变量。
+ */
+declare function setVscodeBinaryMirror(cwd: string): Promise<void>;
+//#endregion
+//#region src/commands/sync.d.ts
+/**
+ * 批量执行 `cnpm sync`（或自定义命令），将所有包同步到 npmmirror。
+ */
+declare function syncNpmMirror(cwd: string, options?: GetWorkspacePackagesOptions): Promise<void>;
+//#endregion
+//#region src/commands/upgrade/index.d.ts
+/**
+ * 将 assets 目录的模版文件同步到工程中，实现一键升级脚手架能力。
+ */
+declare function upgradeMonorepo(opts: CliOpts): Promise<void>;
+//#endregion
+//#region package.d.ts
+declare let name: string;
+declare let version: string;
+//#endregion
+//#region src/constants.d.ts
+/**
+ * @icebreakers/monorepo 包的根目录，所有模板与资产目录都以此为基准。
+ */
+declare const packageDir: string;
+/**
+ * CLI 提供的模板目录，`monorepo new` 会从这里复制目标工程骨架。
+ */
+declare const templatesDir: string;
+/**
+ * 升级命令需要写入的静态文件集合，位于 assets 目录中。
+ */
+declare const assetsDir: string;
+/**
+ * monorepo 根目录，方便需要跳出当前包的逻辑（例如定位工作区文件）。
+ */
+declare const rootDir: string;
+//#endregion
+//#region src/core/config.d.ts
+/**
+ * 提供类型提示的辅助函数，供外部定义配置时使用。
+ */
+declare function defineMonorepoConfig(config: MonorepoConfig): MonorepoConfig;
+/**
+ * 加载指定目录的 monorepo 配置，并利用缓存提升性能。
+ */
+declare function loadMonorepoConfig(cwd: string): Promise<MonorepoConfig>;
+/**
+ * 获取命令对应的合并配置，若未配置则返回空对象，保证调用端逻辑简单。
+ */
+declare function resolveCommandConfig<Name extends keyof NonNullable<MonorepoConfig['commands']>>(name: Name, cwd: string): Promise<NonNullable<MonorepoConfig['commands']>[Name]>;
+//#endregion
+//#region src/core/context.d.ts
+/**
+ * 构建命令执行上下文，封装常用的工作区、Git、配置等信息。
+ */
+declare function createContext(cwd: string): Promise<{
+  cwd: string;
+  git: GitClient;
+  gitUrl: git_url_parse0.GitUrl | undefined;
+  gitUser: {
+    name: string;
+    email: string;
+  };
+  workspaceDir: string;
+  workspaceFilepath: string;
+  packages: {
+    pkgJsonPath: string;
+    rootDir: _pnpm_types0.ProjectRootDir;
+    rootDirRealPath: _pnpm_types0.ProjectRootDirRealPath;
+    modulesDir?: string;
+    manifest: _pnpm_types0.ProjectManifest;
+    writeProjectManifest: (manifest: _pnpm_types0.ProjectManifest, force?: boolean | undefined) => Promise<void>;
+  }[];
+  config: MonorepoConfig;
+}>;
+/**
+ * 统一导出的上下文类型，方便下游函数准确获知可用字段。
+ */
+type Context = Awaited<ReturnType<typeof createContext>>;
+//#endregion
+//#region src/core/logger.d.ts
+/**
+ * 统一的日志实例，便于在命令行中输出带有前缀和颜色的消息。
+ */
+declare const logger: consola0.ConsolaInstance;
+//#endregion
+//#region src/utils/fs.d.ts
+/**
+ * 判断是否为可忽略的文件系统错误。
+ * - ENOENT: 文件已被删除
+ * - EBUSY: Windows 中资源被系统占用
+ */
+declare function isIgnorableFsError(error: unknown): error is NodeJS.ErrnoException;
+//#endregion
+//#region src/utils/gitignore.d.ts
+/**
+ * Map a workspace path (containing `.gitignore`) to its packaged variant.
+ */
+declare function toPublishGitignorePath(input: string): string;
+/**
+ * Map a packaged path (containing `gitignore`) back to the workspace form.
+ */
+declare function toWorkspaceGitignorePath(input: string): string;
+/**
+ * Convenient helper to check whether a filename (with or without dot prefix)
+ * should be treated as a gitignore file.
+ */
+declare function isGitignoreFile(name: string): boolean;
+//#endregion
+//#region src/utils/hash.d.ts
+/**
+ * 生成给定二进制内容的 md5 摘要，用于快速比较文件内容。
+ */
+declare function getFileHash(data: crypto.BinaryLike): string;
+/**
+ * 对比两个文件的 md5，如果不一致则认为内容有变化。
+ */
+declare function isFileChanged(src: crypto.BinaryLike, dest: crypto.BinaryLike): boolean;
+//#endregion
+//#region src/utils/regexp.d.ts
+/**
+ * 逃逸正则表达式中所有特殊字符，避免被当做模式解析。
+ */
+declare function escapeStringRegexp(str: string): string;
+/**
+ * 判断字符串是否命中任意一个正则，用于过滤要同步的资产文件。
+ */
+declare function isMatch(str: string, arr: RegExp[]): boolean;
+//#endregion
+export { type CleanCommandConfig, type CliOpts, type ConfigValues, Context, type CreateChoiceOption, type CreateCommandConfig, type CreateNewProjectOptions, type GetWorkspacePackagesOptions, GitClient, type InitCommandConfig, type MirrorCommandConfig, type MonorepoConfig, type PackageJson, type SimpleGit, type SimpleGitOptions, type SyncCommandConfig, type UpgradeCommandConfig, assetsDir, cleanProjects, createContext, createNewProject, defineMonorepoConfig, escapeStringRegexp, getCreateChoices, getFileHash, getTemplateMap, getWorkspaceData, getWorkspacePackages, init, isFileChanged, isGitignoreFile, isIgnorableFsError, isMatch, loadMonorepoConfig, logger, name, packageDir, resolveCommandConfig, rootDir, setVscodeBinaryMirror, syncNpmMirror, templateMap, templatesDir, toPublishGitignorePath, toWorkspaceGitignorePath, upgradeMonorepo, version };

package/dist/index.mjs

@@ -0,0 +1,3 @@
+import { A as getWorkspaceData, C as templatesDir, D as defineMonorepoConfig, E as cleanProjects, M as GitClient, O as loadMonorepoConfig, S as rootDir, T as version, _ as toWorkspaceGitignorePath, a as createContext, b as assetsDir, c as getCreateChoices, d as escapeStringRegexp, f as isMatch, g as toPublishGitignorePath, h as isGitignoreFile, i as init, j as getWorkspacePackages, k as resolveCommandConfig, l as getTemplateMap, m as isFileChanged, n as syncNpmMirror, o as createNewProject, p as getFileHash, r as setVscodeBinaryMirror, t as upgradeMonorepo, u as templateMap, v as isIgnorableFsError, w as name, x as packageDir, y as logger } from "./upgrade-DKyLL_5k.mjs";
+
+export { GitClient, assetsDir, cleanProjects, createContext, createNewProject, defineMonorepoConfig, escapeStringRegexp, getCreateChoices, getFileHash, getTemplateMap, getWorkspaceData, getWorkspacePackages, init, isFileChanged, isGitignoreFile, isIgnorableFsError, isMatch, loadMonorepoConfig, logger, name, packageDir, resolveCommandConfig, rootDir, setVscodeBinaryMirror, syncNpmMirror, templateMap, templatesDir, toPublishGitignorePath, toWorkspaceGitignorePath, upgradeMonorepo, version };