node-karin 1.15.4 → 1.16.1

package/dist/file-dGy9of8-.mjs

@@ -0,0 +1,268 @@
+import { karinPathBase } from "./root.mjs";
+import path from "node:path";
+import { promisify } from "node:util";
+import fs from "node:fs";
+import axios from "axios";
+import { pipeline } from "node:stream";
+
+//#region src/utils/fs/file.ts
+/** promisify stream.pipeline */
+const streamPipeline = promisify(pipeline);
+/** 当前运行环境的路径标准协议前缀 */
+const sep = path.sep === "/" ? /^file:\/\// : /^file:[/]{2,3}/;
+/**
+* 下载文件
+* @param fileUrl 下载地址
+* @param savePath 保存路径
+* @param options 请求参数 基本是axios参数，额外拓展了returnBoolean
+*/
+const downloadFile = async (fileUrl, savePath, options = {}) => {
+	try {
+		await fs.promises.mkdir(path.dirname(savePath), { recursive: true });
+		const response = await axios.get(fileUrl, {
+			...options,
+			responseType: "stream"
+		});
+		await streamPipeline(response.data, fs.createWriteStream(savePath));
+		if (options.returnBoolean) return true;
+		return {
+			success: true,
+			data: response.data
+		};
+	} catch (error) {
+		if (options.returnBoolean) return false;
+		return {
+			success: false,
+			data: error
+		};
+	}
+};
+/**
+* 下载保存文件
+* @param fileUrl 下载地址
+* @param savePath 保存路径
+* @param param axios参数
+*/
+const downFile = async (fileUrl, savePath, param = {}) => {
+	return downloadFile(fileUrl, savePath, {
+		...param,
+		returnBoolean: true
+	});
+};
+/**
+* 标准化文件路径 统一使用/分隔符
+* @param file - 路径
+* @param absPath - 返回绝对路径 默认为true
+* @param prefix - 添加file://前缀 默认为false
+* @returns 标准化后的路径
+*/
+const absPath = (file, absPath = true, prefix = false) => {
+	file = file.replace(/\\/g, "/");
+	if (file.startsWith("file://")) file = file.replace(sep, "");
+	file = path.normalize(file);
+	if (absPath) file = path.resolve(file);
+	if (prefix) file = "file://" + file;
+	return file.replace(/\\/g, "/");
+};
+/**
+* 为每个插件创建基本文件夹结构
+* @param name 插件名称
+* @param files 需要创建的文件夹列表
+*/
+const createPluginDir = async (name, files) => {
+	if (!Array.isArray(files)) files = [
+		"config",
+		"data",
+		"resources"
+	];
+	if (files.length === 0) return;
+	/** 如果是组织包，优先使用旧版兼容格式(@org-pkg-name) */
+	const isOrgPkg = name.startsWith("@") && name.includes("/");
+	let pluginPath = isOrgPkg ? path.join(karinPathBase, name.replace("/", "-")) : path.join(karinPathBase, name);
+	/** 如果是组织包且旧版兼容格式(@org-pkg-name)不存在，则使用新版组织包结构(@org/pkg-name) */
+	if (isOrgPkg && !fs.existsSync(pluginPath)) {
+		const [orgName, pkgName] = name.split("/");
+		pluginPath = path.join(karinPathBase, orgName, pkgName);
+	}
+	await Promise.all(files.map((file) => {
+		const filePath = path.join(pluginPath, file);
+		if (!fs.existsSync(filePath)) return fs.promises.mkdir(filePath, { recursive: true });
+		return Promise.resolve();
+	}));
+};
+/**
+* 获取符合后缀的文件列表(仅包含文件名称)
+* @param filePath 文件路径
+* @param suffixs 需要复制的文件后缀 可带点
+* @returns 符合条件的文件列表
+*/
+const getFiles = (filePath, suffixs = []) => {
+	if (!fs.existsSync(filePath)) throw new Error(`路径不存在: ${filePath}`);
+	/** 读取默认配置文件列表，只保留文件，排除文件夹 */
+	let files = fs.readdirSync(filePath, { withFileTypes: true }).filter((file) => file.isFile()).map((file) => file.name);
+	if (suffixs.length) {
+		/** 统一后缀格式为 .suffix */
+		const normalizedSuffixs = suffixs.map((suffix) => suffix.startsWith(".") ? suffix : `.${suffix}`);
+		files = files.filter((file) => {
+			const suffix = path.extname(file);
+			return suffix && normalizedSuffixs.includes(suffix);
+		});
+	}
+	return files;
+};
+/**
+* 复制文件 同步
+* @param files 需要复制的文件列表
+* @param defaulPath 模板配置文件路径
+* @param userPath 用户配置文件路径
+*/
+const copyFilesSync = (files, defaulPath, userPath) => {
+	files.forEach((file) => {
+		const defaulFile = path.join(defaulPath, file);
+		const userFile = path.join(userPath, file);
+		if (!fs.existsSync(userFile)) fs.copyFileSync(defaulFile, userFile);
+	});
+};
+/**
+* 复制文件 异步
+* @param files 需要复制的文件列表
+* @param defaulPath 模板配置文件路径
+* @param userPath 用户配置文件路径
+*/
+const copyFiles = async (files, defaulPath, userPath) => {
+	await Promise.all(files.map(async (file) => {
+		const defaulFile = path.join(defaulPath, file);
+		const userFile = path.join(userPath, file);
+		if (!fs.existsSync(userFile)) await fs.promises.copyFile(defaulFile, userFile);
+	}));
+};
+/**
+* 创建配置文件 同步
+* @description 从模板配置文件复制到目标文件夹
+* @param defaulPath 模板配置文件路径
+* @param userPath 目标文件夹路径
+* @param suffixs 需要复制的文件后缀 可带点
+* @param isThrow 是否抛出异常 默认不抛出
+* @returns 是否复制成功
+* @example
+* ```ts
+* copyConfigSync('defaultPath', 'userPath')
+* copyConfigSync('defaultPath', 'userPath', ['yaml'])
+* copyConfigSync('defaultPath', 'userPath', ['.yaml', 'json'])
+* copyConfigSync('defaultPath', 'userPath', [], true)
+* ```
+*/
+const copyConfigSync = (defaulPath, userPath, suffixs = [], isThrow = false) => {
+	try {
+		const files = getFiles(defaulPath, suffixs);
+		fs.mkdirSync(userPath, { recursive: true });
+		fs.mkdirSync(defaulPath, { recursive: true });
+		copyFilesSync(files, defaulPath, userPath);
+		return true;
+	} catch (error) {
+		if (isThrow) throw error;
+		return false;
+	}
+};
+/**
+* 创建配置文件 异步
+* @description 从模板配置文件复制到用户配置文件
+* @param defaulPath 模板配置文件路径
+* @param userPath 用户配置文件路径
+* @param suffixs 需要复制的文件后缀 可带点
+* @param isThrow 是否抛出异常 默认不抛出
+* @returns 是否复制成功
+* @example
+* ```ts
+* await copyConfig('defaultPath', 'userPath')
+* await copyConfig('defaultPath', 'userPath', ['yaml'])
+* await copyConfig('defaultPath', 'userPath', ['.yaml', 'json'])
+* await copyConfig('defaultPath', 'userPath', [], true)
+* ```
+*/
+const copyConfig = async (defaulPath, userPath, suffixs = [], isThrow = false) => {
+	try {
+		const files = getFiles(defaulPath, suffixs);
+		await Promise.all([fs.promises.mkdir(userPath, { recursive: true }), fs.promises.mkdir(defaulPath, { recursive: true })]);
+		await copyFiles(files, defaulPath, userPath);
+		return true;
+	} catch (error) {
+		if (isThrow) throw error;
+		return false;
+	}
+};
+/**
+* 递归获取目录下的所有文件
+* @param dir 目录路径
+* @param options 选项
+* @returns 符合条件的文件路径列表
+* @example
+* ```ts
+* getAllFilesSync('dir')
+* getAllFilesSync('dir', { suffixs: ['yaml', '.json'] })
+* getAllFilesSync('dir', { exclude: ['.yaml', 'json'] })
+* getAllFilesSync('dir', { returnType: 'abs' })
+* ```
+*/
+const getAllFilesSync = (dir, options = {}) => {
+	const { suffixs = [], exclude = [], returnType = "rel" } = options;
+	const result = [];
+	const readDirRecursive = (currentDir, prefix = "") => {
+		const files = fs.readdirSync(currentDir, { withFileTypes: true });
+		for (const file of files) {
+			const relativePath = path.join(prefix, file.name);
+			const fullPath = path.join(currentDir, file.name);
+			if (file.isDirectory()) readDirRecursive(fullPath, relativePath);
+			else if (file.isFile()) {
+				const suffix = path.extname(file.name);
+				if (suffixs.length > 0) {
+					if (suffixs.map((s) => s.startsWith(".") ? s : `.${s}`).includes(suffix)) result.push(returnType === "abs" ? fullPath : relativePath);
+				} else if (exclude.length > 0) {
+					if (!exclude.map((s) => s.startsWith(".") ? s : `.${s}`).includes(suffix)) result.push(returnType === "abs" ? fullPath : relativePath);
+				} else result.push(returnType === "abs" ? fullPath : relativePath);
+			}
+		}
+	};
+	if (!fs.existsSync(dir)) throw new Error(`路径不存在: ${dir}`);
+	readDirRecursive(dir);
+	return result;
+};
+/**
+* 递归获取目录下的所有文件（异步版本）
+* @param dir 目录路径
+* @param options 选项
+* @returns 符合条件的文件路径列表
+* @example
+* ```ts
+* await getFilesRecursive('dir')
+* await getFilesRecursive('dir', { suffixs: ['yaml', '.json'] })
+* await getFilesRecursive('dir', { exclude: ['.yaml', 'json'] })
+* await getFilesRecursive('dir', { returnType: 'abs' })
+* ```
+*/
+const getAllFiles = async (dir, options = {}) => {
+	const { suffixs = [], exclude = [], returnType = "rel" } = options;
+	const result = [];
+	const readDirRecursive = async (currentDir, prefix = "") => {
+		const files = await fs.promises.readdir(currentDir, { withFileTypes: true });
+		await Promise.all(files.map(async (file) => {
+			const relativePath = path.join(prefix, file.name);
+			const fullPath = path.join(currentDir, file.name);
+			if (file.isDirectory()) await readDirRecursive(fullPath, relativePath);
+			else if (file.isFile()) {
+				const suffix = path.extname(file.name);
+				if (suffixs.length > 0) {
+					if (suffixs.map((s) => s.startsWith(".") ? s : `.${s}`).includes(suffix)) result.push(returnType === "abs" ? fullPath : relativePath);
+				} else if (exclude.length > 0) {
+					if (!exclude.map((s) => s.startsWith(".") ? s : `.${s}`).includes(suffix)) result.push(returnType === "abs" ? fullPath : relativePath);
+				} else result.push(returnType === "abs" ? fullPath : relativePath);
+			}
+		}));
+	};
+	if (!fs.existsSync(dir)) throw new Error(`路径不存在: ${dir}`);
+	await readDirRecursive(dir);
+	return result;
+};
+
+//#endregion
+export { copyFilesSync as a, downloadFile as c, getFiles as d, sep as f, copyFiles as i, getAllFiles as l, copyConfig as n, createPluginDir as o, copyConfigSync as r, downFile as s, absPath as t, getAllFilesSync as u };

package/dist/fsSync-Cf5MWILk.mjs

@@ -0,0 +1,65 @@
+import fs from "node:fs";
+
+//#region src/utils/fs/fsSync.ts
+/**
+* 检查目录是否存在
+* @param file 文件路径
+* @returns 返回布尔值
+*/
+const existsSync$1 = (file) => {
+	return fs.existsSync(file);
+};
+/**
+* 检查是否为目录
+* @param file 文件路径
+* @returns 返回布尔值
+*/
+const isDirSync = (file) => {
+	try {
+		return fs.statSync(file).isDirectory();
+	} catch {
+		return false;
+	}
+};
+/**
+* 检查是否为文件
+* @param file 文件路径
+* @returns 返回布尔值
+*/
+const isFileSync = (file) => {
+	try {
+		return fs.statSync(file).isFile();
+	} catch {
+		return false;
+	}
+};
+/**
+* 递归创建文件夹
+* @param dirname 文件夹路径
+* @returns 返回布尔值 是否创建成功
+*/
+const mkdirSync = (dirname) => {
+	try {
+		fs.mkdirSync(dirname, { recursive: true });
+		return true;
+	} catch {
+		return false;
+	}
+};
+/**
+* 检查目录是否存在 不存在则创建
+* @param file 文件路径
+* @returns 返回布尔值
+*/
+const existToMkdirSync = (file) => {
+	try {
+		if (!fs.existsSync(file)) mkdirSync(file);
+		return true;
+	} catch {
+		return false;
+	}
+};
+const rmSync = fs.rmSync;
+
+//#endregion
+export { mkdirSync as a, isFileSync as i, existsSync$1 as n, rmSync as o, isDirSync as r, existToMkdirSync as t };