@zwa73/utils 1.0.86 → 1.0.87

package/compile.bat

@@ -1,2 +1,2 @@
-npm run compile
+call npm run compile
 pause

package/dist/UtilFileTools.d.ts

@@ -1,4 +1,4 @@
-import { JToken } from "./UtilInterfaces";
+import { JObject, JToken } from "./UtilInterfaces";
 /**文件工具 */
 export declare namespace UtilFT {
     /**验证路径 文件或文件夹 是否存在 异步
@@ -84,4 +84,23 @@ export declare namespace UtilFT {
      * @deprecated 请使用 fileSearchRegex 或 fileSearchGlob
      */
     function fileSearch(...patams: any[]): void;
+    /**是一个有效的文件路径
+     * @param filePath - 需要验证的文件路径
+     */
+    function isValidFilePath(filePath: string): boolean;
+    /**构造Schema
+     * @async
+     * @param configPath  - tsconfig路径
+     * @param outDir      - schema文件夹路径 如 ./schema/
+     * @param coverDefine - 将会覆盖 definitions 对应内容的表
+     */
+    function builAllSchema(configPath: string, outDir: string, coverDefine?: JObject): Promise<void>;
+    /**生成匹配的文件的所有type的schema
+     * @async
+     * @param globPattern - glob匹配符
+     * @param outDir      - schema输出路径目录 如 ./schema/
+     * @param ignore      - glob忽略匹配符
+     * @param coverDefine - 将会覆盖 definitions 对应内容的表
+     */
+    function buildMatchSchema(globPattern: string | string[], outDir: string, ignore?: string | string[], coverDefine?: JObject): Promise<void>;
 }

package/dist/UtilFileTools.js

@@ -7,6 +7,7 @@ const UtilLogger_1 = require("./UtilLogger");
 const JSON5 = require("json5");
 const glob_1 = require("glob");
 const UtilFunctions_1 = require("./UtilFunctions");
+const TJS = require("typescript-json-schema");
 /**文件工具 */
 var UtilFT;
 (function (UtilFT) {
@@ -204,4 +205,99 @@ var UtilFT;
         throw "请使用 fileSearchRegex 或 fileSearchGlob";
     }
     UtilFT.fileSearch = fileSearch;
+    /**是一个有效的文件路径
+     * @param filePath - 需要验证的文件路径
+     */
+    function isValidFilePath(filePath) {
+        if (filePath.length > 255)
+            return false;
+        const invalidCharacters = ['<', '>', '"', '|', '?', '*'];
+        for (const invalidCharacter of invalidCharacters) {
+            if (filePath.includes(invalidCharacter))
+                return false;
+        }
+        return true;
+    }
+    UtilFT.isValidFilePath = isValidFilePath;
+    //#region schema
+    /**构造Schema
+     * @async
+     * @param configPath  - tsconfig路径
+     * @param outDir      - schema文件夹路径 如 ./schema/
+     * @param coverDefine - 将会覆盖 definitions 对应内容的表
+     */
+    async function builAllSchema(configPath, outDir, coverDefine = {}) {
+        outDir = path.join(outDir, "schemas.json");
+        const log = await UtilFunctions_1.UtilFunc.exec(`typescript-json-schema ${configPath} * --out ${outDir} --required --strictNullChecks --aliasRefs`);
+        console.log(log);
+        const schema = (await UtilFT.loadJSONFileSync(outDir));
+        //进行预处理并展开
+        await expandSchema(outDir, schema, coverDefine);
+    }
+    UtilFT.builAllSchema = builAllSchema;
+    /**生成匹配的文件的所有type的schema
+     * @async
+     * @param globPattern - glob匹配符
+     * @param outDir      - schema输出路径目录 如 ./schema/
+     * @param ignore      - glob忽略匹配符
+     * @param coverDefine - 将会覆盖 definitions 对应内容的表
+     */
+    async function buildMatchSchema(globPattern, outDir, ignore, coverDefine = {}) {
+        //生成
+        const settings = {
+            required: true,
+            aliasRef: true,
+        };
+        const compilerOptions = {
+            strictNullChecks: true,
+        };
+        const files = UtilFT.fileSearchGlob(globPattern, ignore);
+        const program = TJS.getProgramFromFiles(files, compilerOptions);
+        const schema = TJS.generateSchema(program, "*", settings);
+        outDir = outDir ?? path.join(process.cwd(), 'schema');
+        const schemasPath = path.join(outDir, 'schemas.json');
+        //进行预处理并展开
+        await expandSchema(schemasPath, schema, coverDefine);
+    }
+    UtilFT.buildMatchSchema = buildMatchSchema;
+    /**展开schema以供使用 */
+    async function expandSchema(schemasPath, schema, coverDefine) {
+        //覆盖
+        coverObj(schema["definitions"], coverDefine);
+        //替换SchemaString标识符
+        schema = JSON.parse(JSON.stringify(schema).replace(/\^\.\*SchemaString\$/g, '^.*$'));
+        const plist = [];
+        plist.push(UtilFT.writeJSONFile(schemasPath, schema));
+        const definitions = schema["definitions"];
+        //展开定义
+        for (const typeName in definitions) {
+            const schema = definitions[typeName];
+            //展开所有object与忽略检测的类型
+            if (!(schema.type == "object" || schema.type == "array" || schema.type == undefined))
+                continue;
+            if ((/^.+_[0-9]/).test(typeName) || (/^{./).test(typeName))
+                continue;
+            const basename = path.basename(schemasPath);
+            const tpath = path.join(path.dirname(schemasPath), `${typeName}.schema.json`);
+            if (!isValidFilePath(tpath))
+                continue;
+            plist.push(UtilFT.writeJSONFile(tpath, {
+                "$schema": "http://json-schema.org/draft-07/schema#",
+                "$ref": `${basename}#/definitions/${typeName}`
+            }));
+        }
+        await Promise.all(plist);
+    }
+    /**覆盖object */
+    function coverObj(base, cover) {
+        for (const k in cover) {
+            const v = cover[k];
+            if (typeof v === "object" && !Array.isArray(v) &&
+                typeof base[k] === "object" && !Array.isArray(base[k]))
+                coverObj(base[k], v);
+            else
+                base[k] = v;
+        }
+    }
+    //#endregion
 })(UtilFT || (exports.UtilFT = UtilFT = {}));

package/dist/UtilInterfaces.d.ts

@@ -134,4 +134,8 @@ export type Matchable<T extends Keyable> = T | Outcome<T, unknown>;
 export type MatchableFlag<T> = T extends infer O | Outcome<infer O, unknown> ? O : never;
 /**从联合 Outcome 中 根据 id 提取对应 Outcome */
 export type ExtractOutcome<T, K extends Keyable> = T extends Outcome<infer O, unknown> ? O extends Exclude<O, K> ? never : T : never;
+/**用于辅助解析智能补全的类型
+ * 输出schema后替换为 ^.*$ 的 string 匹配
+ */
+export type SchemaString = `${string}SchemaString`;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zwa73/utils",
-  "version": "1.0.86",
+  "version": "1.0.87",
   "description": "my utils",
   "main": "index.js",
   "scripts": {
@@ -26,6 +26,7 @@
     "https-proxy-agent": "^5.0.1",
     "json5": "^2.2.3",
     "tiktoken": "^1.0.7",
+    "typescript-json-schema": "^0.63.0",
     "winston": "^3.10.0",
     "winston-daily-rotate-file": "^4.7.1"
   },

package/schema/TestType1.schema.json

@@ -0,0 +1,4 @@
+{
+	"$schema": "http://json-schema.org/draft-07/schema#",
+	"$ref": "schemas.json#/definitions/TestType1"
+}

package/schema/TestType2.schema.json

@@ -0,0 +1,4 @@
+{
+	"$schema": "http://json-schema.org/draft-07/schema#",
+	"$ref": "schemas.json#/definitions/TestType2"
+}

package/schema/schemas.json

@@ -0,0 +1,35 @@
+{
+	"$schema": "http://json-schema.org/draft-07/schema#",
+	"definitions": {
+		"TestType2": {
+			"type": "object",
+			"properties": {
+				"a": {
+					"type": "string"
+				},
+				"b": {
+					"type": "number"
+				}
+			},
+			"required": [
+				"a",
+				"b"
+			]
+		},
+		"TestType1": {
+			"type": "object",
+			"properties": {
+				"a": {
+					"type": "string"
+				},
+				"b": {
+					"type": "number"
+				}
+			},
+			"required": [
+				"a",
+				"b"
+			]
+		}
+	}
+}

package/src/UtilClass.ts

@@ -1,3 +1,8 @@
+import { UtilFT } from "./UtilFileTools";
+import { UtilFunc } from "./UtilFunctions";
+import { JObject } from "./UtilInterfaces";
+import * as path from "path";
+import * as TJS from "typescript-json-schema";
 type struct = number | string;
 
 /**遍历函数

package/src/UtilFileTools.ts

@@ -1,10 +1,11 @@
 import * as fs from "fs";
 import * as path from "path";
-import { JToken } from "@src/UtilInterfaces";
+import { JObject, JToken } from "@src/UtilInterfaces";
 import { SLogger } from "@src/UtilLogger";
 import * as JSON5 from 'json5';
 import { globSync } from "glob";
 import { UtilFunc } from "./UtilFunctions";
+import * as TJS from "typescript-json-schema";
 
 /**文件工具 */
 export namespace UtilFT{
@@ -230,4 +231,98 @@ export function fileSearchGlob(globPattern:string|string[],ignore?:string|string
 export function fileSearch(...patams:any[]){
     throw "请使用 fileSearchRegex 或 fileSearchGlob"
 }
+/**是一个有效的文件路径
+ * @param filePath - 需要验证的文件路径
+ */
+export function isValidFilePath(filePath:string){
+    if(filePath.length>255) return false;
+    const invalidCharacters = ['<', '>', '"', '|', '?', '*'];
+    for (const invalidCharacter of invalidCharacters) {
+        if (filePath.includes(invalidCharacter))
+            return false;
+    }
+    return true;
+}
+
+//#region schema
+/**构造Schema  
+ * @async
+ * @param configPath  - tsconfig路径
+ * @param outDir      - schema文件夹路径 如 ./schema/
+ * @param coverDefine - 将会覆盖 definitions 对应内容的表
+ */
+export async function builAllSchema(configPath:string,outDir:string,coverDefine:JObject={}){
+    outDir = path.join(outDir,"schemas.json");
+    const log = await UtilFunc.exec(`typescript-json-schema ${configPath} * --out ${outDir} --required --strictNullChecks --aliasRefs`);
+    console.log(log);
+    const schema = (await UtilFT.loadJSONFileSync(outDir)) as any;
+    //进行预处理并展开
+    await expandSchema(outDir,schema,coverDefine);
+}
+/**生成匹配的文件的所有type的schema
+ * @async
+ * @param globPattern - glob匹配符
+ * @param outDir      - schema输出路径目录 如 ./schema/
+ * @param ignore      - glob忽略匹配符
+ * @param coverDefine - 将会覆盖 definitions 对应内容的表
+ */
+export async function buildMatchSchema(globPattern:string|string[],outDir:string,ignore?:string|string[],coverDefine:JObject={}){
+    //生成
+    const settings: TJS.PartialArgs = {
+        required: true,
+        aliasRef:true,
+    };
+    const compilerOptions: TJS.CompilerOptions = {
+        strictNullChecks: true,
+    };
+    const files = UtilFT.fileSearchGlob(globPattern,ignore);
+    const program = TJS.getProgramFromFiles(
+        files,
+        compilerOptions,
+    );
+    const schema = TJS.generateSchema(program, "*", settings) as any;
+    outDir = outDir??path.join(process.cwd(),'schema');
+    const schemasPath = path.join(outDir,'schemas.json');
+    //进行预处理并展开
+    await expandSchema(schemasPath,schema,coverDefine);
+}
+/**展开schema以供使用 */
+async function expandSchema(schemasPath:string,schema:any,coverDefine:JObject){
+    //覆盖
+    coverObj(schema["definitions"],coverDefine);
+    //替换SchemaString标识符
+    schema = JSON.parse(JSON.stringify(schema).replace(/\^\.\*SchemaString\$/g,'^.*$'));
+    const plist:Promise<void>[] = [];
+    plist.push(UtilFT.writeJSONFile(schemasPath,schema));
+
+    const definitions = schema["definitions"] as Record<string,JObject>;
+    //展开定义
+    for(const typeName in definitions){
+        const schema = definitions[typeName];
+        //展开所有object与忽略检测的类型
+        if(!(schema.type == "object" || schema.type == "array" || schema.type == undefined)) continue;
+        if((/^.+_[0-9]/).test(typeName) || (/^{./).test(typeName)) continue;
+
+        const basename = path.basename(schemasPath);
+        const tpath = path.join(path.dirname(schemasPath),`${typeName}.schema.json`);
+        if(!isValidFilePath(tpath)) continue;
+        plist.push(UtilFT.writeJSONFile(tpath,{
+            "$schema": "http://json-schema.org/draft-07/schema#",
+            "$ref": `${basename}#/definitions/${typeName}`
+        }));
+    }
+    await Promise.all(plist);
+}
+/**覆盖object */
+function coverObj(base:JObject,cover:JObject){
+    for(const k in cover){
+        const v = cover[k];
+        if( typeof v === "object" && !Array.isArray(v) &&
+            typeof base[k] === "object" && !Array.isArray(base[k]) )
+            coverObj(base[k] as JObject,v as JObject);
+        else
+            base[k] = v;
+    }
+}
+//#endregion
 }

package/src/UtilInterfaces.ts

@@ -205,3 +205,8 @@ export type ExtractOutcome<T,K extends Keyable> =
             : T
         : never;
 
+/**用于辅助解析智能补全的类型  
+ * 输出schema后替换为 ^.*$ 的 string 匹配  
+ */
+export type SchemaString = `${string}SchemaString`;
+