@ruan-cat/utils 3.3.0 → 4.1.0

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

@@ -0,0 +1,26 @@
+import fs from "node:fs";
+import path from "node:path";
+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"));
+}
+
+/**
+ * 将 CHANGELOG.md 文件移动到指定要求的位置内
+ * @description
+ * 该函数相当于实现 `cpx CHANGELOG.md docs` 命令
+ */
+export function copyChangelogMd(/** 目标文件夹 */ target: string) {
+	if (!hasChangelogMd()) {
+		return;
+	}
+
+	const source = path.resolve(process.cwd(), "CHANGELOG.md");
+	const destination = path.resolve(process.cwd(), target, "CHANGELOG.md");
+
+	fs.copyFileSync(source, destination);
+}

package/src/node-esm/scripts/yaml-to-md.ts

@@ -0,0 +1,69 @@
+import { readFileSync, writeFileSync } from "node:fs";
+
+import { consola } from "consola";
+import { isUndefined } from "lodash-es";
+import yaml from "js-yaml";
+
+// import { program } from "commander";
+// import prettier from "prettier";
+// import prettierConfig from "../prettier.config.js";
+// program
+// 	.name("yaml-in-md")
+// 	// 环境变量的地址
+// 	.option("--md <path>", "目标md文件的地址，目前仅考虑单个文件")
+// 	.parse();
+// const options = program.opts();
+// consola.info(" 查看命令行提供的参数 ", options);
+// /** md文件的地址 */
+// const defMdPath: string = options?.md;
+
+export interface WriteYaml2mdParams<T = Record<string, any>> {
+	/** 目标md文件地址 */
+	mdPath: string;
+
+	/** 被插入到md头部的数据 */
+	data: T;
+}
+
+/**
+ * 将YAML数据写入到MD文件内
+ */
+export function writeYaml2md<T>(params: WriteYaml2mdParams<T>) {
+	consola.info(` 当前运行的地址为： ${process.cwd()} `);
+	const { mdPath, data } = params;
+
+	if (isUndefined(mdPath)) {
+		consola.error(" 请提供md文件的地址 ");
+		process.exit(1);
+	}
+
+	// Check if file exists
+	try {
+		readFileSync(mdPath, "utf-8");
+	} catch (error) {
+		consola.error(` 文件 ${mdPath} 不存在 `);
+		process.exit(1);
+	}
+
+	// Read the existing MD file
+	const mdContent = readFileSync(mdPath, "utf-8");
+
+	// Convert data to YAML
+	const yamlContent = yaml.dump(data);
+
+	// Combine YAML with MD content
+	const newContent = `---\n${yamlContent}---\n\n${mdContent}`;
+
+	// 警告 暂不考虑使用本函数内的prettier功能 避免打包体积太大
+	// Format with prettier using project config
+	// const formattedContent = await prettier.format(newContent, {
+	// 	parser: "markdown",
+	// 	...prettierConfig,
+	// });
+
+	// Write back to file
+	// writeFileSync(mdPath, formattedContent, "utf-8");
+	writeFileSync(mdPath, newContent, "utf-8");
+
+	consola.success(` 已将YAML数据写入到 ${mdPath} `);
+}

package/src/vueuse/useAxios/index.ts

@@ -14,6 +14,7 @@ export type KeyHelper<K extends KeyAxiosRequestConfig> = K;
 
 /** @deprecated 在v2版本中，我们不使用该工具来约束删减类型 */
 export type RemoveUrl<T extends KeyAxiosRequestConfig> = Exclude<T, "url">;
+
 /** @deprecated 在v2版本中，我们不使用该工具来约束删减类型 */
 export type RemoveUrlMethod<T extends KeyAxiosRequestConfig> = Exclude<T, "url" | "method">;
 
@@ -72,35 +73,42 @@ declare module "@vueuse/integrations/useAxios" {
 	): StrictUseAxiosReturn<T, K, R, D> & Promise<StrictUseAxiosReturn<T, K, R, D>>;
 }
 
-/** 包装器的参数 @version 1 */
+/** 包装器的参数 @version 2 */
 export interface UseAxiosWrapperParams<
-	/**
-	 * 业务数据类型
-	 * @description
-	 * 必须先填写业务类型
-	 */
-	T = any,
 	/**
 	 * AxiosRequestConfig 默认必填的字段
 	 * @description
-	 * 用于约束其他类型的字段
+	 * key是首先必填的字段 必须要约束axios请求配置的可选项值
 	 *
-	 * 然后才能填写必传的参数类型
-	 *
-	 * 默认为 必填url请求地址的 config 请求配置
+	 * 该key值不再默认要求url是必填项 不做严格约束
 	 */
-	K extends KeyAxiosRequestConfig<D> = "url",
+	K extends KeyAxiosRequestConfig,
 	/**
-	 * UseAxiosOptions 的派生类型
+	 * 业务数据类型
+	 * @description
+	 * axios的返回值类型 二版本不再默认提供any类型
+	 *
+	 * 下游工具必须主动传递类型
 	 */
-	UseAxiosOptionsLike extends UseAxiosOptions = UseAxiosOptions,
+	T,
+	/** UseAxiosOptionsBase 的派生类型 */
+	UseAxiosOptionsLike extends UseAxiosOptionsBase = UseAxiosOptionsBase<T>,
 	/**
 	 * AxiosRequestConfig 用的类型
 	 * @description
-	 * 最后才可以传递此类型
+	 * 通常是 axios 的输入值
 	 */
 	D = any,
 > {
+	/**
+	 * 接口的url
+	 * @description
+	 * 接口必须要有url地址，该url迁移到此处专门设置
+	 *
+	 * 不要求在 axios 配置内必传url了。
+	 * @version 2
+	 */
+	url: string;
 	/**
 	 * axios的配置类型
 	 * @description
@@ -125,19 +133,18 @@ export interface UseAxiosWrapperParams<
  * 其本质是对 useAxios 函数的封装，仅仅是包装了参数层
  *
  * 预期设计成一个万能的 通用的请求函数
- * @version 1
+ *
+ * 类型必传key T UseAxiosOptionsLike
+ * @version 2
  */
-export function useAxiosWrapper<T, K extends KeyAxiosRequestConfig, D = any>(params: UseAxiosWrapperParams) {
-	const {
-		config: { url },
-		config,
-		instance,
-		options,
-	} = params;
-	// 跳转到 vueuse 内的函数声明
-	// return useAxios<T, AxiosResponse<T>, D>(url, config, instance, options);
-
-	// 跳转到我们拓展的函数声明
+export function useAxiosWrapper<
+	K extends KeyAxiosRequestConfig,
+	T,
+	UseAxiosOptionsLike extends UseAxiosOptionsBase,
+	D = any,
+>(params: UseAxiosWrapperParams<K, T, UseAxiosOptionsLike, D>) {
+	const { config = {}, instance, options = {} } = params;
+	const url = params.url || "";
 	return useAxios<T, K, AxiosResponse<T>, D>(url, config, instance, options);
 }
 

package/src/vueuse/useAxios/v2.ts

@@ -1,48 +1,46 @@
 /**
- * 这里是第二版本的工具 目前属于测试阶段
- * 等待完善后，会正式地替代原来的设计。
+ * 这里是第一版本的工具
+ * 已经不再使用
  */
+import type { RequiredPick } from "type-plus";
 import type { AxiosResponse, AxiosInstance } from "axios";
-import type { UseAxiosOptionsBase } from "@vueuse/integrations/useAxios";
+import type { UseAxiosOptionsBase, UseAxiosOptions } from "@vueuse/integrations/useAxios";
 import { useAxios } from "@vueuse/integrations/useAxios";
 import type { CreateAxiosRequestConfig, KeyAxiosRequestConfig } from "./index.ts";
 
-/** 包装器的参数 @version 2 */
-export interface UseAxiosWrapperParams2<
+/**
+ * 包装器的参数
+ * @version 1
+ * @deprecated
+ */
+export interface UseAxiosWrapperParamsV1<
 	/**
-	 * AxiosRequestConfig 默认必填的字段
+	 * 业务数据类型
 	 * @description
-	 * key是首先必填的字段 必须要约束axios请求配置的可选项值
-	 *
-	 * 该key值不再默认要求url是必填项 不做严格约束
+	 * 必须先填写业务类型
 	 */
-	K extends KeyAxiosRequestConfig,
+	T = any,
 	/**
-	 * 业务数据类型
+	 * AxiosRequestConfig 默认必填的字段
 	 * @description
-	 * axios的返回值类型 二版本不再默认提供any类型
+	 * 用于约束其他类型的字段
+	 *
+	 * 然后才能填写必传的参数类型
 	 *
-	 * 下游工具必须主动传递类型
+	 * 默认为 必填url请求地址的 config 请求配置
+	 */
+	K extends KeyAxiosRequestConfig<D> = "url",
+	/**
+	 * UseAxiosOptions 的派生类型
 	 */
-	T,
-	/** UseAxiosOptionsBase 的派生类型 */
-	UseAxiosOptionsLike extends UseAxiosOptionsBase = UseAxiosOptionsBase<T>,
+	UseAxiosOptionsLike extends UseAxiosOptions = UseAxiosOptions,
 	/**
 	 * AxiosRequestConfig 用的类型
 	 * @description
-	 * 通常是 axios 的输入值
+	 * 最后才可以传递此类型
 	 */
 	D = any,
 > {
-	/**
-	 * 接口的url
-	 * @description
-	 * 接口必须要有url地址，该url迁移到此处专门设置
-	 *
-	 * 不要求在 axios 配置内必传url了。
-	 * @version 2
-	 */
-	url: string;
 	/**
 	 * axios的配置类型
 	 * @description
@@ -61,26 +59,24 @@ export interface UseAxiosWrapperParams2<
 	options: UseAxiosOptionsLike;
 }
 
-/**
- * 正在尝试重构的2 url不是非必填 多了独立的url参数 */
-
 /**
  * useAxios 的包装函数
  * @description
  * 其本质是对 useAxios 函数的封装，仅仅是包装了参数层
  *
  * 预期设计成一个万能的 通用的请求函数
- *
- * 类型必传key T UseAxiosOptionsLike
- * @version 2
+ * @version 1
  */
-export function useAxiosWrapper2<
-	K extends KeyAxiosRequestConfig,
-	T,
-	UseAxiosOptionsLike extends UseAxiosOptionsBase,
-	D = any,
->(params: UseAxiosWrapperParams2<K, T, UseAxiosOptionsLike, D>) {
-	const { config = {}, instance, options = {} } = params;
-	const url = params.url || "";
+export function useAxiosWrapperV1<T, K extends KeyAxiosRequestConfig, D = any>(params: UseAxiosWrapperParamsV1) {
+	const {
+		config: { url },
+		config,
+		instance,
+		options,
+	} = params;
+	// 跳转到 vueuse 内的函数声明
+	// return useAxios<T, AxiosResponse<T>, D>(url, config, instance, options);
+
+	// 跳转到我们拓展的函数声明
 	return useAxios<T, K, AxiosResponse<T>, D>(url, config, instance, options);
 }