@bettergi/utils 0.1.2 → 0.1.3

package/README.md

@@ -150,6 +150,16 @@ log.info(`GET 请求响应体内容${body1}`);
 log.info(`POST 请求响应体内容${body2}`);
 ```
 
+### 文件操作
+
+```ts
+// 列出指定文件夹内所有文件路径
+const files = listFiles("assets");
+
+// 读取文件文本行（非空白、去除首尾空白、去重）
+const lines = readLinesSync("assets/data.txt", { notBlank: true, trim: true, distinct: true });
+```
+
 ### 日期时间
 
 ```ts
@@ -158,3 +168,14 @@ const d1 = getNextDay4AM();
 // 获取下一个（含当日）周一凌晨4点的时间
 const d2 = getNextMonday4AM();
 ```
+
+### 杂项
+
+```ts
+// 生成UUID（不带连字符）
+const uuid = generateUUID(false);
+
+// 数组洗牌
+const arr = [1, 2, 3, 4, 5];
+const shuffled = shuffleArray(arr);
+```

package/dist/file.d.ts

@@ -0,0 +1,29 @@
+/**
+ * 读取指定文件夹内所有文件的路径
+ * @param folderPath 文件夹路径（相对于脚本根目录）
+ * @param recursive 是否递归子文件夹（默认：false）
+ * @returns 文件路径数组
+ */
+export declare const listFiles: (folderPath: string, recursive?: boolean) => string[];
+export type ReadLinesOptions = {
+    /** 是否过滤仅含空白的行 */
+    notBlank?: boolean;
+    /** 是否过滤空行 */
+    notEmpty?: boolean;
+    /** 是否去除每行首尾空白 */
+    trim?: boolean;
+    /** 是否去重 */
+    distinct?: boolean;
+};
+/**
+ * 同步读取文件文本行
+ * @param path 文件路径（相对于脚本根目录）
+ * @param options 读取选项
+ */
+export declare const readLinesSync: (path: string, options: ReadLinesOptions) => string[];
+/**
+ * 读取文件文本行
+ * @param path 文件路径（相对于脚本根目录）
+ * @param options 读取选项
+ */
+export declare const readLines: (path: string, options: ReadLinesOptions) => Promise<string[]>;

package/dist/file.js

@@ -0,0 +1,43 @@
+/**
+ * 读取指定文件夹内所有文件的路径
+ * @param folderPath 文件夹路径（相对于脚本根目录）
+ * @param recursive 是否递归子文件夹（默认：false）
+ * @returns 文件路径数组
+ */
+export const listFiles = (folderPath, recursive) => {
+    return [...file.readPathSync(folderPath)].flatMap(path => recursive && file.isFolder(path) ? listFiles(path, recursive) : file.isFolder(path) ? [] : path);
+};
+/**
+ * 同步读取文件文本行
+ * @param path 文件路径（相对于脚本根目录）
+ * @param options 读取选项
+ */
+export const readLinesSync = (path, options) => {
+    const { notBlank = false, notEmpty = false, trim = false, distinct = false } = options || {};
+    return file
+        .readTextSync(path)
+        .replaceAll("\r\n", "\n")
+        .split("\n")
+        .filter(line => (!notBlank || line.trim().length > 0) && (!notEmpty || line.length > 0))
+        .map(line => (trim ? line.trim() : line))
+        .reduce((acc, line) => {
+        return distinct ? (acc.includes(line) ? acc : [...acc, line]) : [...acc, line];
+    }, []);
+};
+/**
+ * 读取文件文本行
+ * @param path 文件路径（相对于脚本根目录）
+ * @param options 读取选项
+ */
+export const readLines = async (path, options) => {
+    const { notBlank = false, notEmpty = false, trim = false, distinct = false } = options || {};
+    const text = await file.readText(path);
+    return text
+        .replaceAll("\r\n", "\n")
+        .split("\n")
+        .filter(line => (!notBlank || line.trim().length > 0) && (!notEmpty || line.length > 0))
+        .map(line => (trim ? line.trim() : line))
+        .reduce((acc, line) => {
+        return distinct ? (acc.includes(line) ? acc : [...acc, line]) : [...acc, line];
+    }, []);
+};

package/dist/index.d.ts

@@ -1,9 +1,13 @@
 /** 断言 */
 export * from "./asserts";
+/** 文件操作 */
+export * from "./file";
 /** 游戏操作 */
 export * from "./game";
 /** HTTP 请求 */
 export * from "./http";
+/** 杂项 */
+export * from "./misc";
 /** 鼠标操作 */
 export * from "./mouse";
 /** 图像识别 */

package/dist/index.js

@@ -1,9 +1,13 @@
 /** 断言 */
 export * from "./asserts";
+/** 文件操作 */
+export * from "./file";
 /** 游戏操作 */
 export * from "./game";
 /** HTTP 请求 */
 export * from "./http";
+/** 杂项 */
+export * from "./misc";
 /** 鼠标操作 */
 export * from "./mouse";
 /** 图像识别 */

package/dist/misc.d.ts

@@ -0,0 +1,11 @@
+/**
+ * 生成UUID
+ * @param withDashes 是否包含连字符
+ */
+export declare const generateUUID: (withDashes?: boolean) => string;
+/**
+ * Fisher-Yates 洗牌算法
+ * @param array 待洗牌数组
+ * @returns 洗牌后的新数组
+ */
+export declare const shuffleArray: <T>(array: T[]) => T[];

package/dist/misc.js

@@ -0,0 +1,26 @@
+/**
+ * 生成UUID
+ * @param withDashes 是否包含连字符
+ */
+export const generateUUID = (withDashes = true) => {
+    return "xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx"
+        .replace(/[xy]/g, c => {
+        const r = (Math.random() * 16) | 0;
+        return (c === "x" ? r : (r & 0x3) | 0x8).toString(16);
+    })
+        .replace(/-/g, withDashes ? "-" : "");
+};
+/**
+ * Fisher-Yates 洗牌算法
+ * @param array 待洗牌数组
+ * @returns 洗牌后的新数组
+ */
+export const shuffleArray = (array) => {
+    const shuffled = [...array];
+    let i = shuffled.length;
+    while (i) {
+        const j = Math.floor(Math.random() * i--);
+        [shuffled[i], shuffled[j]] = [shuffled[j], shuffled[i]];
+    }
+    return shuffled;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bettergi/utils",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "description": "开发 BetterGI 脚本常用工具集",
   "type": "module",
   "author": "Bread Grocery<https://github.com/breadgrocery>",