@ruan-cat/utils 4.1.0 → 4.2.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ruan-cat/utils",
-  "version": "4.1.0",
-  "description": "阮喵喵工具集合。一个纯typescript库，也提供纯js文件。",
+  "version": "4.2.0",
+  "description": "阮喵喵工具集合。默认提供js文件，也直接提供ts文件。",
   "type": "module",
   "main": "./src/index.ts",
   "types": "./src/index.ts",
@@ -16,17 +16,17 @@
   },
   "exports": {
     ".": {
-      "types": "./src/index.ts",
-      "import": "./src/index.ts",
+      "types": "./dsit/index.d.ts",
+      "import": "./dist/index.js",
       "require": "./dist/index.cjs"
     },
     "./node-cjs": {
-      "types": "./src/node-cjs/index.ts",
-      "import": "./src/node-cjs/index.ts",
+      "types": "./dist/node-cjs/index.d.cts",
+      "import": "./dist/node-cjs/index.d.cts",
       "require": "./dist/node-cjs/index.cjs"
     },
     "./node-esm": {
-      "types": "./src/node-esm/index.ts",
+      "types": "./dist/node-esm/index.d.ts",
       "import": "./dist/node-esm/index.js"
     },
     "./unplugin-vue-router": "./src/unplugin-vue-router/index.ts",
@@ -55,6 +55,7 @@
     "!src/tests",
     "!src/**/tests",
     "!src/**/*.md",
+    "!src/typedoc-md/**/*",
     "tsconfig.json"
   ],
   "dependencies": {
@@ -73,12 +74,13 @@
     "qs": "^6.14.0",
     "tsup": "^8.4.0",
     "type-plus": "^7.6.2",
-    "typedoc": "^0.27.9",
-    "typedoc-plugin-frontmatter": "^1.2.1",
-    "typedoc-plugin-markdown": "^4.4.2",
+    "typedoc": "^0.28.0",
+    "typedoc-plugin-frontmatter": "^1.3.0",
+    "typedoc-plugin-markdown": "^4.5.0",
     "typescript": "^5.8.2",
     "unplugin-vue-router": "^0.11.2",
-    "vite-plugin-autogeneration-import-file": "^3.0.0"
+    "vite-plugin-autogeneration-import-file": "^3.0.0",
+    "vitepress": "^1.6.3"
   },
   "peerDependencies": {
     "typescript": "5.7.3",
@@ -106,21 +108,17 @@
     }
   },
   "scripts": {
-    "clean-docs": "rimraf -g \"docs/**/!(.vuepress)\"",
-    "copy-src": "cpx \"src/**/*\" docs",
-    "copy-readme": "cpx README.md docs",
-    "typedoc": "typedoc --options typedoc.config.mjs",
-    "docs:dev-main": "vuepress-vite dev docs --clean-cache --open",
+    "build": "tsup",
     "docs:dev": "turbo docs:dev",
-    "build:docs-main": "vuepress-vite build docs",
     "build:docs": "turbo do-build-docs",
+    "typedoc": "typedoc --options typedoc.config.mjs",
+    "docs:dev-main": "vitepress dev src --port 8080",
+    "build:docs-main": "vitepress build src",
     "clean:type": "rimraf dist",
     "generate:type-1": "vue-tsc -p tsconfig.json --composite false --declaration true --emitDeclarationOnly true",
     "generate:type-2": "tsc -p tsconfig.json --composite false --declaration true --emitDeclarationOnly true",
     "generate:type-3": "vue-tsc -p tsconfig.types.json",
     "get-type": "pnpm clean:type && pnpm generate:type-3",
-    "build:-try-1": "pnpm clean:type && vue-tsc -p tsconfig.build.json",
-    "build:tsup": "tsup",
-    "build": "pnpm run build:tsup"
+    "build:-try-1": "pnpm clean:type && vue-tsc -p tsconfig.build.json"
   }
 }

package/src/.vitepress/config.mts

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

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

@@ -0,0 +1,2 @@
+import theme from "@ruan-cat/vitepress-preset-config/theme";
+export default theme;

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

@@ -0,0 +1,130 @@
+/**
+ * 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;
+}

package/src/.vuepress/client.ts

@@ -0,0 +1,4 @@
+// 测试 普通样式
+import "@ruan-cat/vuepress-preset-config/src/styles/common/index.scss";
+// 测试 爱丽丝样式
+// import "@ruan-cat/vuepress-preset-config/src/styles/drill-style/index.scss";

package/src/.vuepress/config.ts

@@ -0,0 +1,19 @@
+// 特殊写法 避免出现循环依赖
+// 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,
+		},
+	},
+});
+
+export default defineRuanCatVuepressConfig({
+	title: "阮喵喵工具包",
+});

package/src/define-promise-tasks.ts

@@ -1,4 +1,4 @@
-import { type SimpleAsyncTask } from "./simple-promise-tools.ts";
+import { type SimpleAsyncTask } from "./simple-promise-tools";
 
 export const taskTypes = <const>["single", "parallel", "queue"];
 

package/src/index.ts

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

package/src/node-cjs/index.ts

@@ -1 +1 @@
-export * from "./tools.ts";
+export * from "./tools";

package/src/node-cjs/tools.ts

@@ -5,7 +5,7 @@
 import { normalize } from "node:path";
 import { spawnSync, type SpawnOptions } from "node:child_process";
 
-import { generateSimpleAsyncTask } from "@ruan-cat/utils/src/simple-promise-tools.ts";
+import { generateSimpleAsyncTask } from "../simple-promise-tools";
 import consola from "consola";
 // import { normalizePath } from "vite";
 

package/src/node-esm/index.ts

@@ -1,6 +1,6 @@
-export * from "./ruan-cat-pkg-info.ts";
+export * from "./ruan-cat-pkg-info";
 
-export * from "./scripts/clean.ts";
-export * from "./scripts/copy-changelog.ts";
-export * from "./scripts/yaml-to-md.ts";
-export * from "./scripts/add-changelog-to-doc.ts";
+export * from "./scripts/clean";
+export * from "./scripts/copy-changelog";
+export * from "./scripts/yaml-to-md";
+export * from "./scripts/add-changelog-to-doc";

package/src/node-esm/scripts/add-changelog-to-doc.ts

@@ -1,7 +1,7 @@
 import path from "node:path";
 
-import { copyChangelogMd, hasChangelogMd } from "./copy-changelog.ts";
-import { writeYaml2md } from "./yaml-to-md.ts";
+import { copyChangelogMd, hasChangelogMd } from "./copy-changelog";
+import { writeYaml2md } from "./yaml-to-md";
 
 export interface AddChangelog2docOptions<T = Record<string, any>> {
 	/** 目标文件夹 */

package/src/node-esm/scripts/clean.ts

@@ -1,4 +1,4 @@
-import { generateSpawnSync } from "../../node-cjs/index.ts";
+import { generateSpawnSync } from "../../node-cjs/index";
 
 type GlobString = `**/{${string}}`;
 

package/src/node-esm/scripts/copy-changelog.ts

@@ -4,9 +4,12 @@ import consola from "consola";
 
 /** 检查当前运行的根目录 是否存在 CHANGELOG.md 文件 */
 export function hasChangelogMd() {
-	consola.log("当前项目根目录为：", process.cwd());
-	consola.warn("当前项目根目录不存在 CHANGELOG.md 文件");
-	return fs.existsSync(path.resolve(process.cwd(), "CHANGELOG.md"));
+	const res = fs.existsSync(path.resolve(process.cwd(), "CHANGELOG.md"));
+	if (!res) {
+		consola.log("当前项目根目录为：", process.cwd());
+		consola.warn("当前项目根目录不存在 CHANGELOG.md 文件");
+	}
+	return res;
 }
 
 /**

package/src/vueuse/index.ts

@@ -1 +1 @@
-export * from "./useAxios/index.ts";
+export * from "./useAxios/index";

package/src/vueuse/useAxios/index.ts

@@ -148,4 +148,4 @@ export function useAxiosWrapper<
 	return useAxios<T, K, AxiosResponse<T>, D>(url, config, instance, options);
 }
 
-export * from "./v2.ts";
+export * from "./v1.js";

package/src/vueuse/useAxios/{v2.ts → v1.ts}

@@ -6,7 +6,7 @@ import type { RequiredPick } from "type-plus";
 import type { AxiosResponse, AxiosInstance } from "axios";
 import type { UseAxiosOptionsBase, UseAxiosOptions } from "@vueuse/integrations/useAxios";
 import { useAxios } from "@vueuse/integrations/useAxios";
-import type { CreateAxiosRequestConfig, KeyAxiosRequestConfig } from "./index.ts";
+import type { CreateAxiosRequestConfig, KeyAxiosRequestConfig } from "./index.js";
 
 /**
  * 包装器的参数

package/tsconfig.json

@@ -6,21 +6,18 @@
 		// 项目基础目录
 		"baseUrl": ".",
 		"declaration": true,
-		"allowImportingTsExtensions": true,
-		"emitDeclarationOnly": true,
+		// "allowImportingTsExtensions": true,
+		// "noEmit": true,
 		// tsc 编译产物输出目录
 		"outDir": "dist",
 		"checkJs": true,
 		// 项目包含了js
-		"allowJs": true,
-		"module": "nodenext",
+		// "allowJs": true,
+		"module": "ESNext",
 		"target": "ESNext",
 		// 模块解析策略
-		"moduleResolution": "NodeNext",
-		// 是否生成辅助 debug 的 .map.js 文件。 
-		"sourceMap": false,
-		// 产物不消除注释
-		"removeComments": false,
+		"moduleResolution": "bundler",
+		"allowJs": true,
 		// 严格模式类型检查，建议开启
 		"strict": true,
 		// 允许引入 .json 模块
@@ -34,10 +31,15 @@
 			"typedoc-plugin-markdown",
 			"node"
 		],
+		"paths": {
+			"@ruan-cat/utils/*": [
+				"./src/*"
+			]
+		},
 	},
 	"include": [
 		"./src/**/*.ts",
-		"./src/**/*.js",
+		// "./src/**/*.js",
 		// "./tests/**/*.ts",
 		// "./tests/**/*.js",
 	],

package/src/unplugin-vue-router/README.md

@@ -1,23 +0,0 @@
----
-dir:
-  collapsible: false
-  link: true
----
-
-# unplugin-vue-router
-
-## 安装依赖
-
-你需要独立安装 unplugin-vue-router 。
-
-```bash
-pnpm i -D unplugin-vue-router
-```
-
-## 使用
-
-```ts
-import { getRouteName } from "@ruan-cat/utils/unplugin-vue-router";
-```
-
-<!-- 触发部署 -->

package/src/vite-plugin-autogeneration-import-file/README.md

@@ -1,37 +0,0 @@
----
-dir:
-  collapsible: false
-  link: true
----
-
-# 自动类型生成插件的二次封装
-
-[vite-plugin-autogeneration-import-file](https://github.com/yuntian001/vite-plugin-autogeneration-import-file)，这个 vite 插件可以实现自动类型导入。在实际使用过程中，需要配置很多东西，故此处对该插件的使用做一些二次封装，并讲解该如何使用。
-
-## 安装依赖
-
-毕竟属于对该插件的二次封装，请自行安装依赖：
-
-```bash
-pnpm i -D vite-plugin-autogeneration-import-file
-```
-
-## 在 vite 配置内使用
-
-使用示例如下：
-
-::: details
-
-@[code](./tests/vite.config.ts)
-
-:::
-
-## 使用的模板
-
-类型文件使用的模板如下：
-
-::: details
-
-@[code](./template/components.template.ts)
-
-:::

package/src/vueuse/README.md

@@ -1,9 +0,0 @@
----
-dir:
-  order: 20
-  link: true
----
-
-# vueuse
-
-这里对 vueuse 的函数做二次封装。

package/src/vueuse/useAxios/README.md

@@ -1,67 +0,0 @@
----
-order: 10
-dir:
-  collapsible: false
-  link: true
-  order: 10
----
-
-# useAxios 的包装函数
-
-useAxiosWrapper，该函数旨在于实现 useAxios 的封装。
-
-## 安装依赖
-
-```bash
-pnpm i -P @vueuse/integrations axios
-```
-
-## 准备接口返回数据的类型
-
-接口请求返回类型，通常是一个泛型，请根据你的业务场景准备好类似于下面的类型：
-
-::: details
-
-@[code](./tests/types/ApifoxModel.ts)
-
-:::
-
-## 准备简单的 axios 请求实例
-
-这里的本质是为了准备一个拦截器内没有解包 data 的 axios 实例，因为 useAxios 默认帮我们完成 axios 的 data 解包了。
-
-比如以下的简单实例：
-
-::: details
-
-@[code](./tests/createAxiosInstance.ts)
-
-:::
-
-## 基于项目二次封装 useAxiosWrapper 函数
-
-::: details
-
-@[code](./tests/projectRequest.ts)
-
-:::
-
-## 定义接口
-
-如下：
-
-::: details
-
-@[code](./tests/homeCategoryHead.ts)
-
-:::
-
-## 使用接口
-
-如下：
-
-::: details
-
-@[code](./tests/homeCategoryHead.test.ts)
-
-:::