@ruan-cat/utils 4.15.0 → 4.17.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ruan-cat/utils",
-  "version": "4.15.0",
+  "version": "4.17.0",
   "description": "阮喵喵工具集合。默认提供js文件，也直接提供ts文件。",
   "type": "module",
   "main": "./src/index.ts",
@@ -52,25 +52,29 @@
   },
   "files": [
     "!**/.vercel/**",
+    "!**/.vitepress/**",
     "src",
-    "dist/*",
-    "!src/tests",
-    "!src/**/tests",
+    "dist/**",
+    "tsconfig.json",
+    "README.md",
+    "!src/**/docs/**",
+    "!src/**/tests/**",
+    "!*.test.*",
     "!src/**/*.md",
-    "!src/typedoc-md/**/*",
-    "tsconfig.json"
+    "!src/typedoc-md/**/*"
   ],
   "dependencies": {
     "@vueuse/integrations": "^13.9.0",
-    "axios": "^1.12.2",
+    "axios": "^1.13.2",
     "consola": "^3.4.2",
+    "glob": "^11.0.3",
     "lodash-es": "^4.17.21"
   },
   "devDependencies": {
-    "@antfu/utils": "^9.2.1",
+    "@antfu/utils": "^9.3.0",
     "@types/js-yaml": "^4.0.9",
     "@types/lodash-es": "^4.17.12",
-    "@types/node": "^22.18.6",
+    "@types/node": "^22.19.0",
     "@types/qs": "^6.14.0",
     "automd": "^0.4.2",
     "commander": "^13.1.0",
@@ -78,12 +82,12 @@
     "qs": "^6.14.0",
     "tsup": "^8.5.0",
     "type-plus": "^7.6.2",
-    "typedoc": "^0.28.13",
+    "typedoc": "^0.28.14",
     "typedoc-plugin-frontmatter": "^1.3.0",
     "typedoc-plugin-markdown": "^4.9.0",
-    "typescript": "^5.9.2",
-    "unplugin-auto-import": "^20.1.0",
-    "unplugin-vue-router": "^0.15.0",
+    "typescript": "^5.9.3",
+    "unplugin-auto-import": "^20.2.0",
+    "unplugin-vue-router": "^0.16.1",
     "vite-plugin-autogeneration-import-file": "^3.0.0",
     "vitepress": "^1.6.4"
   },

package/src/.vuepress/config.ts

@@ -2,17 +2,7 @@
 // import { defineRuanCatVuepressConfig } from "@ruan-cat/vuepress-preset-config";
 import { defineRuanCatVuepressConfig } from "../../../vuepress-preset-config";
 
-import { addChangelog2doc } from "@ruan-cat/utils/node-esm";
-
-addChangelog2doc({
-	target: "./src",
-	data: {
-		order: 940,
-		dir: {
-			order: 940,
-		},
-	},
-});
+// 注意：这里没有使用 addChangelog2doc ， 反正 vuepress 我后续也不用了
 
 export default defineRuanCatVuepressConfig({
 	title: "阮喵喵工具包",

package/src/index.ts

@@ -2,6 +2,7 @@ export * from "./conditions";
 export * from "./print";
 export * from "./define-promise-tasks";
 export * from "./simple-promise-tools";
+export * from "./monorepo";
 
 export * from "./types/pnpm-workspace.yaml.shim";
 export * from "./types/Prettify";

package/src/monorepo.ts

@@ -0,0 +1,70 @@
+import { join } from "node:path";
+import * as fs from "node:fs";
+import { sync } from "glob";
+import { load } from "js-yaml";
+import { isUndefined } from "lodash-es";
+import type { PnpmWorkspace } from "./types/pnpm-workspace.yaml.shim";
+
+/**
+ * 路径转换工具
+ * @private 暂时不考虑复用
+ */
+function pathChange(path: string) {
+	return path.replace(/\\/g, "/");
+	// FIXME: 无法有效地实现解析路径 测试用例不通过
+	// return normalize(path);
+	// FIXME: tsup打包时，无法处理好vite的依赖 会导致打包失败 不知道怎么单独使用并打包该函数
+	// return normalizePath(path);
+}
+
+/**
+ * 判断目标项目是否是 monorepo 格式的项目
+ * @description
+ * 判别逻辑：
+ * 1. 目标项目同时存在 `pnpm-workspace.yaml` 文件
+ * 2. `pnpm-workspace.yaml` 提供了有效的 packages 匹配配置
+ * 3. 至少能匹配到一个 package.json 文件
+ *
+ * @returns {boolean} 是否是 monorepo 项目
+ * @throws {Error} 当 pnpm-workspace.yaml 格式错误时抛出错误
+ */
+export function isMonorepoProject(): boolean {
+	// 1. 检查 pnpm-workspace.yaml 是否存在
+	const workspaceConfigPath = join(process.cwd(), "pnpm-workspace.yaml");
+	if (!fs.existsSync(workspaceConfigPath)) {
+		return false;
+	}
+
+	// 2. 解析 YAML 文件
+	let workspaceConfig: PnpmWorkspace;
+	try {
+		const workspaceFile = fs.readFileSync(workspaceConfigPath, "utf8");
+		workspaceConfig = <PnpmWorkspace>load(workspaceFile);
+	} catch (error) {
+		throw new Error(
+			`解析 pnpm-workspace.yaml 文件失败，请检查文件格式是否正确。错误信息：${error instanceof Error ? error.message : String(error)}`,
+		);
+	}
+
+	// 3. 检查 packages 配置是否存在且不为空数组
+	const pkgPatterns = workspaceConfig.packages;
+	if (isUndefined(pkgPatterns) || pkgPatterns.length === 0) {
+		return false;
+	}
+
+	// 4. 检查是否至少能匹配到一个 package.json
+	for (const pkgPattern of pkgPatterns) {
+		const matchedPath = pathChange(join(process.cwd(), pkgPattern, "package.json"));
+		const matchedPaths = sync(matchedPath, {
+			ignore: "**/node_modules/**",
+		});
+
+		// 只要有一个模式能匹配到文件，就认为是有效的 monorepo
+		if (matchedPaths.length > 0) {
+			return true;
+		}
+	}
+
+	// 没有匹配到任何 package.json
+	return false;
+}

package/src/.vitepress/config.mts

@@ -1,38 +0,0 @@
-// 工具包文档项目 直接导入生成文档配置 避免出现循环依赖
-import { setUserConfig, setGenerateSidebar, addChangelog2doc, copyReadmeMd } from "../../../vitepress-preset-config";
-
-import { description } from "../../package.json";
-
-copyReadmeMd("./src");
-
-addChangelog2doc({
-	target: "./src",
-	data: {
-		order: 2000,
-		dir: {
-			order: 2000,
-		},
-	},
-});
-
-const userConfig = setUserConfig({
-	title: "阮喵喵工具包",
-	description,
-	themeConfig: {
-		editLink: {
-			pattern: "https://github.com/ruan-cat/monorepo/blob/dev/packages/utils/src/:path",
-		},
-		socialLinks: [
-			{
-				icon: "github",
-				link: "https://github.com/ruan-cat/monorepo/tree/main/packages/utils",
-			},
-		],
-	},
-});
-
-// @ts-ignore
-userConfig.themeConfig.sidebar = setGenerateSidebar({
-	documentRootPath: "src",
-});
-export default userConfig;

package/src/.vitepress/theme/index.ts

@@ -1,6 +0,0 @@
-import { defineRuancatPresetTheme } from "@ruan-cat/vitepress-preset-config/theme";
-
-// 增加用户自定义样式
-import "./style.css";
-
-export default defineRuancatPresetTheme();

package/src/.vitepress/theme/style.css

@@ -1,130 +0,0 @@
-/**
- * Customize default theme styling by overriding CSS variables:
- * https://github.com/vuejs/vitepress/blob/main/src/client/theme-default/styles/vars.css
- */
-
-/**
- * Colors
- *
- * Each colors have exact same color scale system with 3 levels of solid
- * colors with different brightness, and 1 soft color.
- * 
- * - `XXX-1`: The most solid color used mainly for colored text. It must
- *   satisfy the contrast ratio against when used on top of `XXX-soft`.
- *
- * - `XXX-2`: The color used mainly for hover state of the button.
- *
- * - `XXX-3`: The color for solid background, such as bg color of the button.
- *   It must satisfy the contrast ratio with pure white (#ffffff) text on
- *   top of it.
- *
- * - `XXX-soft`: The color used for subtle background such as custom container
- *   or badges. It must satisfy the contrast ratio when putting `XXX-1` colors
- *   on top of it.
- *
- *   The soft color must be semi transparent alpha channel. This is crucial
- *   because it allows adding multiple "soft" colors on top of each other
- *   to create a accent, such as when having inline code block inside
- *   custom containers.
- *
- * - `default`: The color used purely for subtle indication without any
- *   special meanings attched to it such as bg color for menu hover state.
- *
- * - `brand`: Used for primary brand colors, such as link text, button with
- *   brand theme, etc.
- *
- * - `tip`: Used to indicate useful information. The default theme uses the
- *   brand color for this by default.
- *
- * - `warning`: Used to indicate warning to the users. Used in custom
- *   container, badges, etc.
- *
- * - `danger`: Used to show error, or dangerous message to the users. Used
- *   in custom container, badges, etc.
- * -------------------------------------------------------------------------- */
-
-:root {
-	--vp-c-default-1: var(--vp-c-gray-1);
-	--vp-c-default-2: var(--vp-c-gray-2);
-	--vp-c-default-3: var(--vp-c-gray-3);
-	--vp-c-default-soft: var(--vp-c-gray-soft);
-
-	--vp-c-brand-1: var(--vp-c-indigo-1);
-	--vp-c-brand-2: var(--vp-c-indigo-2);
-	--vp-c-brand-3: var(--vp-c-indigo-3);
-	--vp-c-brand-soft: var(--vp-c-indigo-soft);
-
-	--vp-c-tip-1: var(--vp-c-brand-1);
-	--vp-c-tip-2: var(--vp-c-brand-2);
-	--vp-c-tip-3: var(--vp-c-brand-3);
-	--vp-c-tip-soft: var(--vp-c-brand-soft);
-
-	--vp-c-warning-1: var(--vp-c-yellow-1);
-	--vp-c-warning-2: var(--vp-c-yellow-2);
-	--vp-c-warning-3: var(--vp-c-yellow-3);
-	--vp-c-warning-soft: var(--vp-c-yellow-soft);
-
-	--vp-c-danger-1: var(--vp-c-red-1);
-	--vp-c-danger-2: var(--vp-c-red-2);
-	--vp-c-danger-3: var(--vp-c-red-3);
-	--vp-c-danger-soft: var(--vp-c-red-soft);
-}
-
-/**
- * Component: Button
- * -------------------------------------------------------------------------- */
-
-:root {
-	--vp-button-brand-border: transparent;
-	--vp-button-brand-text: var(--vp-c-white);
-	--vp-button-brand-bg: var(--vp-c-brand-3);
-	--vp-button-brand-hover-border: transparent;
-	--vp-button-brand-hover-text: var(--vp-c-white);
-	--vp-button-brand-hover-bg: var(--vp-c-brand-2);
-	--vp-button-brand-active-border: transparent;
-	--vp-button-brand-active-text: var(--vp-c-white);
-	--vp-button-brand-active-bg: var(--vp-c-brand-1);
-}
-
-/**
- * Component: Home
- * -------------------------------------------------------------------------- */
-
-:root {
-	--vp-home-hero-name-color: transparent;
-	--vp-home-hero-name-background: -webkit-linear-gradient(120deg, #bd34fe 30%, #41d1ff);
-
-	--vp-home-hero-image-background-image: linear-gradient(-45deg, #bd34fe 50%, #47caff 50%);
-	--vp-home-hero-image-filter: blur(44px);
-}
-
-@media (min-width: 640px) {
-	:root {
-		--vp-home-hero-image-filter: blur(56px);
-	}
-}
-
-@media (min-width: 960px) {
-	:root {
-		--vp-home-hero-image-filter: blur(68px);
-	}
-}
-
-/**
- * Component: Custom Block
- * -------------------------------------------------------------------------- */
-
-:root {
-	--vp-custom-block-tip-border: transparent;
-	--vp-custom-block-tip-text: var(--vp-c-text-1);
-	--vp-custom-block-tip-bg: var(--vp-c-brand-soft);
-	--vp-custom-block-tip-code-bg: var(--vp-c-brand-soft);
-}
-
-/**
- * Component: Algolia
- * -------------------------------------------------------------------------- */
-
-.DocSearch {
-	--docsearch-primary-color: var(--vp-c-brand-1) !important;
-}