@zwa73/utils 1.0.40 → 1.0.42

package/dist/UtilFileTools.d.ts

@@ -76,7 +76,7 @@ export declare namespace UtilFT {
     /**搜索路径符合正则表达式的文件
      * @param folder - 文件夹路径
      * @param traitRegex - 正则表达式
-     * @returns {Record<string, string>} 文件名与路径的映射
+     * @returns {Record<string, string>} 文件名与路径的映射 Record<fileName,filePath>
      */
     function fileSearch(folder: string, traitRegex: string): Record<string, string>;
 }

package/dist/UtilFileTools.js

@@ -5,6 +5,7 @@ const fs = require("fs");
 const path = require("path");
 const UtilInterfaces_1 = require("./UtilInterfaces");
 const UtilLogger_1 = require("./UtilLogger");
+const JSON5 = require("json5");
 /**文件工具 */
 var UtilFT;
 (function (UtilFT) {
@@ -121,7 +122,7 @@ var UtilFT;
                 return def;
             return {};
         }
-        return JSON.parse(str);
+        return JSON5.parse(str);
     }
     UtilFT.loadJSONFileSync = loadJSONFileSync;
     async function loadJSONFile(filePath, def) {
@@ -137,7 +138,7 @@ var UtilFT;
                 return def;
             return {};
         }
-        return JSON.parse(str);
+        return JSON5.parse(str);
     }
     UtilFT.loadJSONFile = loadJSONFile;
     /**写入JSON文件
@@ -167,7 +168,7 @@ var UtilFT;
     /**搜索路径符合正则表达式的文件
      * @param folder - 文件夹路径
      * @param traitRegex - 正则表达式
-     * @returns {Record<string, string>} 文件名与路径的映射
+     * @returns {Record<string, string>} 文件名与路径的映射 Record<fileName,filePath>
      */
     function fileSearch(folder, traitRegex) {
         let outMap = {};

package/dist/UtilInterfaces.d.ts

@@ -1,23 +1,25 @@
+/**可以序列化为JSON文件的对象 */
 export type JToken = JObject | JArray | JValue | IJData;
-export type JValue = number | string | boolean | null;
+/**在stringify输出时 undefine 会被转为 null */
+export type JValue = number | string | boolean | null | undefined;
+/**在stringify输出时 值为 undefine 的成员会被转为 null */
 export type JArray = Array<JToken>;
-/**可以序列化为JSON文件的Object*/
+/**在stringify输出时 值为 undefine 的键会被忽略 */
 export type JObject = {
     [key: string]: JToken;
 };
-/**可以保存为JToken的类
- */
+/**可以保存为JToken的类 */
 export interface IJData {
     /**保存为JToken
      */
     toJSON(): JToken;
 }
 /**将JToken转换为字符串
- * @param {JToken} token - 待转换的Token
+ * @param {JToken|IJData} token - 待转换的Token
  * @param {string|number|null} space - 插入的空格 数字为空格数量 默认为制表符\t
  * @returns 转换完成的字符串
  */
-export declare function stringifyJToken(token: JToken, space?: string | number | null | undefined): string;
+export declare function stringifyJToken(token: JToken | IJData, space?: string | number | null | undefined): string;
 /**转为可写的 */
 export type Writeable<T> = {
     -readonly [P in keyof T]: T[P];
@@ -28,3 +30,28 @@ export type Inverted<T extends Record<keyof T, string | number | symbol>> = {
 };
 /**N长度 T类型的元组  */
 export type FixedLengthTuple<T, N extends number, R extends unknown[] = []> = R['length'] extends N ? R : FixedLengthTuple<T, N, [T, ...R]>;
+/**不影响智能补全的任意字符串
+ * (string&Object)
+ * (string&String)
+ */
+export type AnyString = (string & {});
+/**创建一个新的类型，这个新的类型包含了基础类型 B 的所有属性，
+ * 以及一个名为 K[N] 类型为 T 的新属性。
+ * 所有 K 中非 K[N] 的其他属性都是可选的并且不能被赋值（因为它们的类型是 never）。
+ */
+type ExclusiveSub<B, T, K extends string[], N extends number> = B & {
+    [P in K[N]]: T;
+} & {
+    [P in Exclude<K[number], K[N]>]?: never;
+};
+/**递归地创建一个元组类型, 所有成员类型都有一个 K[number] 键 并且与其他成员互斥
+ * 这个元组类型的每个元素都是通过 ExclusiveSub 类型创建的。
+ */
+type ExclusiveRecursive<B, T, K extends string[], R extends unknown[] = []> = R['length'] extends K['length'] ? R : ExclusiveRecursive<B, T, K, [ExclusiveSub<B, T, K, R['length']>, ...R]>;
+/**互斥表
+ * 从 ExclusiveRecursive 类型创建的元组中创建一个或类型, 可以是任意一个元组元素类型
+ */
+export type ExclusiveRecord<B, T, K extends string[], TMP = ExclusiveRecursive<B, T, K>> = TMP[keyof TMP];
+/**符合JObject约束的互斥表 */
+export type ExclusiveJObject<B extends JObject, T extends JToken, K extends string[], TMP extends JArray = ExclusiveRecursive<B, T, K>> = TMP[number];
+export {};

package/dist/UtilInterfaces.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.stringifyJToken = void 0;
 /**将JToken转换为字符串
- * @param {JToken} token - 待转换的Token
+ * @param {JToken|IJData} token - 待转换的Token
  * @param {string|number|null} space - 插入的空格 数字为空格数量 默认为制表符\t
  * @returns 转换完成的字符串
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zwa73/utils",
-  "version": "1.0.40",
+  "version": "1.0.42",
   "description": "my utils",
   "main": "index.js",
   "scripts": {
@@ -19,6 +19,7 @@
     "html-entities": "^2.3.3",
     "http-proxy-agent": "^5.0.0",
     "https-proxy-agent": "^5.0.1",
+    "json5": "^2.2.3",
     "tiktoken": "^1.0.7",
     "winston": "^3.10.0",
     "winston-daily-rotate-file": "^4.7.1"

package/src/UtilFileTools.ts

@@ -2,6 +2,7 @@ import * as fs from "fs";
 import * as path from "path";
 import { JObject, JToken, stringifyJToken } from "./UtilInterfaces";
 import { SLogger } from "./UtilLogger";
+import * as JSON5 from 'json5';
 
 /**文件工具 */
 export namespace UtilFT{
@@ -134,7 +135,7 @@ export function loadJSONFileSync<T extends JToken>(filePath: string,def?: T): T
             return def;
         return {} as T;
     }
-    return JSON.parse(str);
+    return JSON5.parse(str);
 }
 
 /**加载json文件 异步
@@ -167,7 +168,7 @@ export async function loadJSONFile<T extends JToken>(filePath: string,def?: T):
             return def;
         return {} as T;
     }
-    return JSON.parse(str);
+    return JSON5.parse(str);
 }
 
 /**写入JSON文件
@@ -200,7 +201,7 @@ export async function writeJSONFile(
 /**搜索路径符合正则表达式的文件
  * @param folder - 文件夹路径
  * @param traitRegex - 正则表达式
- * @returns {Record<string, string>} 文件名与路径的映射
+ * @returns {Record<string, string>} 文件名与路径的映射 Record<fileName,filePath>
  */
 export function fileSearch(folder: string, traitRegex: string) {
     let outMap: Record<string, string> = {};

package/src/UtilInterfaces.ts

@@ -1,24 +1,27 @@
 
+
+/**可以序列化为JSON文件的对象 */
 export type JToken = JObject|JArray|JValue|IJData;
-export type JValue = number|string|boolean|null;
+/**在stringify输出时 undefine 会被转为 null */
+export type JValue = number|string|boolean|null|undefined;
+/**在stringify输出时 值为 undefine 的成员会被转为 null */
 export type JArray = Array<JToken>;
-/**可以序列化为JSON文件的Object*/
+/**在stringify输出时 值为 undefine 的键会被忽略 */
 export type JObject = {
     [key:string]:JToken;
 }
-/**可以保存为JToken的类
- */
+/**可以保存为JToken的类 */
 export interface IJData{
 	/**保存为JToken
 	 */
 	toJSON():JToken;
 }
 /**将JToken转换为字符串
- * @param {JToken} token - 待转换的Token
+ * @param {JToken|IJData} token - 待转换的Token
  * @param {string|number|null} space - 插入的空格 数字为空格数量 默认为制表符\t
  * @returns 转换完成的字符串
  */
-export function stringifyJToken(token:JToken,space:string|number|null|undefined="\t"){
+export function stringifyJToken(token:JToken|IJData,space:string|number|null|undefined="\t"){
 	if(space==null)
 		space=undefined;
 	return JSON.stringify(token,null,space);
@@ -36,3 +39,34 @@ export type Inverted<T extends Record<keyof T, string | number | symbol>> = {
 export type FixedLengthTuple<T, N extends number, R extends unknown[] = []> =
     R['length'] extends N ? R : FixedLengthTuple<T, N, [T, ...R]>;
 
+
+/**不影响智能补全的任意字符串
+ * (string&Object)
+ * (string&String)
+ */
+export type AnyString = (string&{});
+
+
+
+/**创建一个新的类型，这个新的类型包含了基础类型 B 的所有属性，
+ * 以及一个名为 K[N] 类型为 T 的新属性。
+ * 所有 K 中非 K[N] 的其他属性都是可选的并且不能被赋值（因为它们的类型是 never）。
+ */
+type ExclusiveSub<B, T, K extends string[], N extends number> =
+    B & { [P in K[N]]: T } & { [P in Exclude<K[number], K[N]>]?: never };
+
+/**递归地创建一个元组类型, 所有成员类型都有一个 K[number] 键 并且与其他成员互斥
+ * 这个元组类型的每个元素都是通过 ExclusiveSub 类型创建的。
+ */
+type ExclusiveRecursive<B, T, K extends string[], R extends unknown[] = []> =
+    R['length'] extends K['length'] ? R
+    : ExclusiveRecursive<B, T, K, [ExclusiveSub<B, T, K, R['length']>, ...R]>;
+
+/**互斥表
+ * 从 ExclusiveRecursive 类型创建的元组中创建一个或类型, 可以是任意一个元组元素类型
+ */
+export type ExclusiveRecord<B, T, K extends string[], TMP = ExclusiveRecursive<B, T, K>> = TMP[keyof TMP];
+
+/**符合JObject约束的互斥表 */
+export type ExclusiveJObject<B extends JObject,T extends JToken,K extends string[],
+    TMP extends JArray = ExclusiveRecursive<B,T,K>> = TMP[number];