@zwa73/dev-utils 1.0.3

package/dist/Schema.js

@@ -0,0 +1 @@
+"use strict";

package/dist/UtilSchemaTool.d.ts

@@ -0,0 +1,18 @@
+import { JObject } from '@zwa73/utils';
+export declare namespace UtilST {
+    /**构造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/UtilSchemaTool.js

@@ -0,0 +1,88 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UtilST = void 0;
+const TJS = require("typescript-json-schema");
+const path = require("path");
+const utils_1 = require("@zwa73/utils");
+var UtilST;
+(function (UtilST) {
+    /**构造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 utils_1.UtilFunc.exec(`typescript-json-schema ${configPath} * --out ${outDir} --required --strictNullChecks --aliasRefs`);
+        console.log(log);
+        const schema = (await utils_1.UtilFT.loadJSONFileSync(outDir));
+        //进行预处理并展开
+        await expandSchema(outDir, schema, coverDefine);
+    }
+    UtilST.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 = utils_1.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);
+    }
+    UtilST.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(utils_1.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 (!utils_1.UtilFT.isValidFilePath(tpath))
+                continue;
+            plist.push(utils_1.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;
+        }
+    }
+})(UtilST || (exports.UtilST = UtilST = {}));

package/dist/index.d.ts

@@ -0,0 +1 @@
+export * from './UtilSchemaTool';

package/dist/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./UtilSchemaTool"), exports);

package/index.d.ts

@@ -0,0 +1 @@
+export * from './dist';

package/index.js

@@ -0,0 +1 @@
+module.exports = require("./dist");

package/jest.config.js

@@ -0,0 +1,16 @@
+
+
+
+
+module.exports = {
+    roots: ['./jest'],
+    transform: {
+        '^.+\\.tsx?$': 'ts-jest',
+    },
+    moduleNameMapper: {
+        '^@src/(.*)$': '<rootDir>/dist/$1',
+        '^@/(.*)$': '<rootDir>/$1',
+        '^@$': '<rootDir>/index'
+    },
+    moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'json', 'node'],
+};

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "@zwa73/dev-utils",
+  "version": "1.0.3",
+  "description": "编译与调试工具",
+  "main": "index.js",
+  "scripts": {
+    "test": "call npm run compile && jest",
+    "release": "call npm run compile && call node release.js && call npm publish --access public",
+    "compile": "call tsc -p tsconfig.compile.json && call tsc-alias -p tsconfig.compile.json",
+    "watch": "start tsc-alias -w -p tsconfig.compile.json && start tsc -w -p tsconfig.compile.json"
+  },
+  "keywords": [
+    "schema"
+  ],
+  "author": "zwa73",
+  "license": "ISC",
+  "dependencies": {
+    "@types/jest": "^29.5.12",
+    "@types/node": "^20.11.19",
+    "@zwa73/utils": "^1.0.89",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.1.2",
+    "typescript-json-schema": "^0.63.0"
+  },
+  "devDependencies": {
+    "tsc-alias": "^1.8.8",
+    "typescript": "^5.3.3"
+  }
+}

package/release.bat

@@ -0,0 +1,2 @@
+call npm run release
+pause

package/release.js

@@ -0,0 +1,16 @@
+const fs = require('fs');
+const path = require('path');
+
+// 读取并更新包配置文件中的版本号
+function updateVersion() {
+  const packagePath = path.join(__dirname, 'package.json');
+  const packageData = JSON.parse(fs.readFileSync(packagePath));
+  const version = packageData.version.split('.');
+  version[2] = parseInt(version[2]) + 1;
+  packageData.version = version.join('.');
+  fs.writeFileSync(packagePath, JSON.stringify(packageData, null, 2));
+  return packageData.version;
+}
+
+
+updateVersion();

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/UtilSchemaTool.ts

@@ -0,0 +1,85 @@
+import * as TJS from 'typescript-json-schema';
+import * as path from 'path';
+import { JObject, UtilFT, UtilFunc } from '@zwa73/utils';
+
+export namespace UtilST{
+/**构造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(!UtilFT.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;
+    }
+}
+}

package/src/index.ts

@@ -0,0 +1 @@
+export * from './UtilSchemaTool';

package/tsconfig.compile.json

@@ -0,0 +1,4 @@
+{
+    "extends": "./tsconfig.json",
+    "include": ["./src/**/*.ts", "./src/**/*.js"]
+}

package/tsconfig.json

@@ -0,0 +1,20 @@
+{
+  "compilerOptions": {
+	"allowJs": true,
+    "strict": true,
+    "target": "ES2022",
+    "module": "commonjs",
+    "outDir": "./dist",
+    "declaration": true,
+    "baseUrl": ".",
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true,
+    "paths": {
+      "@src/*": ["./src/*"],
+      "@/*"   : ["./*"],
+      "@"     : ["./src/index"]
+    }
+  },
+  "include": ["./src/**/*.ts", "./src/**/*.js","./jest/**/*.ts"],
+  "exclude": ["./node_modules/**/*"]
+}