@zwa73/dev-utils 1.0.37 → 1.0.38

package/dist/QuickFunc.d.ts

@@ -1,2 +1,2 @@
 import { UtilDT } from "./UtilDevTool";
-export declare const regionMacro: typeof UtilDT.regionMacro;
+export declare const regionMacro: typeof UtilDT.regionMacro, fileMacro: typeof UtilDT.fileMacro, commentMacro: typeof UtilDT.commentMacro;

package/dist/QuickFunc.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.regionMacro = void 0;
+exports.commentMacro = exports.fileMacro = exports.regionMacro = void 0;
 const UtilDevTool_1 = require("./UtilDevTool");
-exports.regionMacro = UtilDevTool_1.UtilDT.regionMacro;
+exports.regionMacro = UtilDevTool_1.UtilDT.regionMacro, exports.fileMacro = UtilDevTool_1.UtilDT.fileMacro, exports.commentMacro = UtilDevTool_1.UtilDT.commentMacro;

package/dist/UtilDevTool.d.ts

@@ -47,16 +47,33 @@ export declare namespace UtilDT {
      */
     export function batchNode(filepath: string | string[], opt?: BatchNodeOpt): Promise<void>;
     /**宏的可选参数 */
-    type MacroOpt = {
+    type MacroOpt = Partial<{
         /**宏展开的目标文件 */
-        targetPath: string;
-    };
+        filePath: string[] | string;
+        /**使用glob匹配而非文件路径 */
+        glob: boolean;
+    }>;
     /**将codeText写入对应region
-     * @param regionId   - 区域id
+     * @param regionId   - 区域id \`//#region ${id}\`
      * @param codeText   - 文本
      * @param opt        - 可选参数
      * @param opt.targetPath - 目标文件 默认为去除".macro"的同名文件
      */
     export function regionMacro(regionId: string, codeText: string | (() => string | Promise<string>), opt?: MacroOpt): Promise<void>;
+    /**将codeText写入对应注释下
+     * @param commentId - 注释id \`// ${id}\`
+     * @param codeText  - 文本
+     * @param opt       - 可选参数
+     * @param opt.filePath - 目标文件 默认为去除".macro"的同名文件
+     * @param opt.glob     - 使用glob匹配而非文件路径
+     */
+    export function commentMacro(commentId: string, codeText: string | (() => string | Promise<string>), opt?: MacroOpt): Promise<void>;
+    /**将codeText写入对应文件 不存在则创建
+     * @param codeText  - 文本
+     * @param opt       - 可选参数
+     * @param opt.filePath - 目标文件 默认为去除".macro"的同名文件
+     * @param opt.glob     - 使用glob匹配而非文件路径
+     */
+    export function fileMacro(codeText: string | (() => string | Promise<string>), opt?: MacroOpt): Promise<void>;
     export {};
 }

package/dist/UtilDevTool.js

@@ -132,8 +132,22 @@ var UtilDT;
         await utils_1.UtilFunc.exec(cmd, { outlvl: 'info', errlvl: 'warn' });
     }
     UtilDT.batchNode = batchNode;
+    //#region macro工具
+    const parseMacroPaths = (basePath, opt) => {
+        return opt?.filePath
+            ? opt.glob
+                ? utils_1.UtilFT.fileSearchGlob(process.cwd(), opt.filePath)
+                : typeof opt?.filePath === "string" ? [opt?.filePath] : opt?.filePath
+            : [basePath.replace(/(.+)\.macro\.(js|ts|cjs|mjs)$/, "$1.$2")];
+    };
+    const readFile = async (basePath) => (await fs.promises.readFile(basePath, 'utf-8')).replaceAll("\r\n", "\n");
+    const parseCodeText = async (codeText, opt) => {
+        const strText = typeof codeText === "function" ? await codeText(opt) : codeText;
+        return strText.split('\n').map((line) => `${opt.inent}${line}`).join('\n');
+    };
+    //#endregion
     /**将codeText写入对应region
-     * @param regionId   - 区域id
+     * @param regionId   - 区域id \`//#region ${id}\`
      * @param codeText   - 文本
      * @param opt        - 可选参数
      * @param opt.targetPath - 目标文件 默认为去除".macro"的同名文件
@@ -141,34 +155,104 @@ var UtilDT;
     async function regionMacro(regionId, codeText, opt) {
         const loc = utils_1.UtilFunc.getFuncLoc(2);
         if (!loc) {
-            utils_1.SLogger.error(`UtilDT.macro 未能找到函数位置`);
+            utils_1.SLogger.error(`UtilDT.regionMacro 未能找到函数位置`);
             return;
         }
-        ;
-        const baseFilePath = opt?.targetPath
-            ? path.resolve(process.cwd(), opt.targetPath)
-            : loc.filePath.replace(/(.+)\.macro\.(js|ts|cjs|mjs)$/, "$1.$2");
-        const queuefunc = async () => {
-            if (!(await utils_1.UtilFT.pathExists(baseFilePath))) {
-                utils_1.SLogger.error(`UtilDT.macro ${baseFilePath} 不存在`);
-                return;
-            }
-            ;
-            const text = (await fs.promises.readFile(baseFilePath, 'utf-8')).replaceAll("\r\n", "\n");
-            const getregex = () => new RegExp(`([^\\S\\n]*)(//#region ${regionId}(?!\\S).*\\n)` +
-                /([\s\S]*?)/.source +
-                /([^\S\n]*\/\/#endregion(?!\S).*)/.source, "g");
-            if (!(getregex().test(text))) {
-                utils_1.SLogger.error(`UtilDT.macro 无法找到区域 ${regionId}`);
-                return;
-            }
-            const match = getregex().exec(text);
-            const strText = typeof codeText === "function" ? await codeText() : codeText;
-            const mapText = strText.split('\n').map((line) => `${match[1]}${line}`).join('\n');
-            const ntext = text.replace(getregex(), `$1$2${mapText}\n$4`);
-            await fs.promises.writeFile(baseFilePath, ntext, 'utf-8');
-        };
-        await utils_1.UtilFunc.queueProc(path.posix.normalize(baseFilePath.replaceAll("\\", "/")), queuefunc);
+        const plist = [];
+        const filePaths = parseMacroPaths(loc.filePath, opt);
+        for (const filePath of filePaths) {
+            const queuefunc = async () => {
+                if (!(await utils_1.UtilFT.pathExists(filePath))) {
+                    utils_1.SLogger.error(`UtilDT.regionMacro ${filePath} 不存在`);
+                    return;
+                }
+                const text = await readFile(filePath);
+                const getregex = () => new RegExp(`([^\\S\\n]*)(//#region ${regionId}(?!\\S).*\\n)` +
+                    /([\s\S]*?)/.source +
+                    /([^\S\n]*\/\/#endregion(?!\S).*)/.source, "g");
+                if (!getregex().test(text)) {
+                    if (!opt?.glob)
+                        utils_1.SLogger.error(`UtilDT.regionMacro 无法找到区域 ${regionId}`);
+                    return;
+                }
+                const match = getregex().exec(text);
+                const parseCode = await parseCodeText(codeText, { text: (0, utils_1.dedent)(match[3]), inent: match[1], filePath });
+                const ntext = text.replace(getregex(), `$1$2${parseCode}\n$4`);
+                await fs.promises.writeFile(filePath, ntext, 'utf-8');
+            };
+            plist.push(utils_1.UtilFunc.queueProc(path.posix.normalize(filePath.replaceAll("\\", "/")), queuefunc));
+        }
+        await Promise.all(plist);
     }
     UtilDT.regionMacro = regionMacro;
+    /**将codeText写入对应注释下
+     * @param commentId - 注释id \`// ${id}\`
+     * @param codeText  - 文本
+     * @param opt       - 可选参数
+     * @param opt.filePath - 目标文件 默认为去除".macro"的同名文件
+     * @param opt.glob     - 使用glob匹配而非文件路径
+     */
+    async function commentMacro(commentId, codeText, opt) {
+        const loc = utils_1.UtilFunc.getFuncLoc(2);
+        if (!loc) {
+            utils_1.SLogger.error(`UtilDT.commentMacro 未能找到函数位置`);
+            return;
+        }
+        const plist = [];
+        const filePaths = parseMacroPaths(loc.filePath, opt);
+        for (const filePath of filePaths) {
+            const queuefunc = async () => {
+                if (!(await utils_1.UtilFT.pathExists(filePath))) {
+                    utils_1.SLogger.error(`UtilDT.commentMacro ${filePath} 不存在`);
+                    return;
+                }
+                const text = await readFile(filePath);
+                const getregex = () => new RegExp(`([^\\S\\n]*)(// ${commentId}(?!\\S).*)` +
+                    /(\n|)/.source +
+                    /([^\n]*)/.source, "g");
+                if (!getregex().test(text)) {
+                    if (!opt?.glob)
+                        utils_1.SLogger.error(`UtilDT.commentMacro 无法找到注释 ${commentId}`);
+                    return;
+                }
+                const match = getregex().exec(text);
+                const parseCode = await parseCodeText(codeText, { text: match[3], inent: match[1], filePath });
+                if (parseCode.includes('\n')) {
+                    utils_1.SLogger.error(`UtilDT.commentMacro 无法使用多行文本, 考虑使用regionMacro ${codeText}`);
+                    return;
+                }
+                const ntext = text.replace(getregex(), `$1$2\n${parseCode}`);
+                await fs.promises.writeFile(filePath, ntext, 'utf-8');
+            };
+            plist.push(utils_1.UtilFunc.queueProc(path.posix.normalize(filePath.replaceAll("\\", "/")), queuefunc));
+        }
+        await Promise.all(plist);
+    }
+    UtilDT.commentMacro = commentMacro;
+    /**将codeText写入对应文件 不存在则创建
+     * @param codeText  - 文本
+     * @param opt       - 可选参数
+     * @param opt.filePath - 目标文件 默认为去除".macro"的同名文件
+     * @param opt.glob     - 使用glob匹配而非文件路径
+     */
+    async function fileMacro(codeText, opt) {
+        const loc = utils_1.UtilFunc.getFuncLoc(2);
+        if (!loc) {
+            utils_1.SLogger.error(`UtilDT.fileMacro 未能找到函数位置`);
+            return;
+        }
+        const plist = [];
+        const filePaths = parseMacroPaths(loc.filePath, opt);
+        for (const filePath of filePaths) {
+            const queuefunc = async () => {
+                await utils_1.UtilFT.ensurePathExists(filePath);
+                const text = await readFile(filePath);
+                const parseCode = await parseCodeText(codeText, { text, inent: '', filePath });
+                await fs.promises.writeFile(filePath, parseCode, 'utf-8');
+            };
+            plist.push(utils_1.UtilFunc.queueProc(path.posix.normalize(filePath.replaceAll("\\", "/")), queuefunc));
+        }
+        await Promise.all(plist);
+    }
+    UtilDT.fileMacro = fileMacro;
 })(UtilDT || (exports.UtilDT = UtilDT = {}));

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@zwa73/dev-utils",
-	"version": "1.0.37",
+	"version": "1.0.38",
 	"description": "编译与调试工具",
 	"main": "index.js",
 	"scripts": {
@@ -16,13 +16,14 @@
 	"author": "zwa73",
 	"license": "ISC",
 	"dependencies": {
-		"@zwa73/utils": "^1.0.114",
+		"@zwa73/utils": "^1.0.117",
 		"commander": "^11.1.0",
 		"ts-node": "^10.9.2",
 		"tsconfig-paths": "^4.2.0",
 		"typescript-json-schema": "^0.63.0"
 	},
 	"devDependencies": {
+		"@types/fluent-ffmpeg": "^2.1.24",
 		"@types/jest": "^29.5.12",
 		"@types/node": "^20.11.19",
 		"jest": "^29.7.0",

package/src/QuickFunc.ts

@@ -1,5 +1,7 @@
 import { UtilDT } from "./UtilDevTool";
 
 export const {
-    regionMacro
+    regionMacro ,
+    fileMacro   ,
+    commentMacro,
 } = UtilDT;

package/src/UtilDevTool.ts

@@ -1,7 +1,7 @@
 import * as path from 'path';
 import * as TJS from 'typescript-json-schema';
 import * as fs from 'fs';
-import { JObject, SLogger, UtilFT, UtilFunc, getFuncLoc } from '@zwa73/utils';
+import { JObject, SLogger, UtilFT, UtilFunc, dedent } from '@zwa73/utils';
 
 export namespace UtilDT{
 
@@ -132,13 +132,38 @@ export async function batchNode(filepath:string|string[],opt?:BatchNodeOpt) {
 }
 
 /**宏的可选参数 */
-type MacroOpt = {
+type MacroOpt = Partial<{
     /**宏展开的目标文件 */
-    targetPath:string;
+    filePath:string[]|string;
+    /**使用glob匹配而非文件路径 */
+    glob:boolean;
+}>
+/**codeText的参数 */
+type CdeeTextOpt = {
+    /**展开宏的目标文件 */
+    filePath:string;
+    /**展开宏区域的原文本 */
+    text:string;
+    /**缩进 会自动应用 */
+    inent:string;
 }
-
+//#region macro工具
+const parseMacroPaths = (basePath:string,opt?:MacroOpt)=>{
+    return opt?.filePath
+        ? opt.glob
+            ? UtilFT.fileSearchGlob(process.cwd(),opt.filePath)
+            : typeof opt?.filePath==="string" ? [opt?.filePath] : opt?.filePath
+        : [basePath.replace(/(.+)\.macro\.(js|ts|cjs|mjs)$/,"$1.$2")];
+}
+const readFile = async (basePath:string)=>
+    (await fs.promises.readFile(basePath,'utf-8')).replaceAll("\r\n","\n");
+const parseCodeText = async (codeText:string|((opt:CdeeTextOpt)=>string|Promise<string>),opt:CdeeTextOpt)=>{
+    const strText = typeof codeText === "function" ? await codeText(opt) : codeText;
+    return strText.split('\n').map((line)=>`${opt.inent}${line}`).join('\n');
+}
+//#endregion
 /**将codeText写入对应region  
- * @param regionId   - 区域id
+ * @param regionId   - 区域id \`//#region ${id}\`
  * @param codeText   - 文本
  * @param opt        - 可选参数
  * @param opt.targetPath - 目标文件 默认为去除".macro"的同名文件
@@ -146,33 +171,103 @@ type MacroOpt = {
 export async function regionMacro(regionId:string,codeText:string|(()=>string|Promise<string>),opt?:MacroOpt){
     const loc = UtilFunc.getFuncLoc(2);
     if(!loc){
-        SLogger.error(`UtilDT.macro 未能找到函数位置`);
+        SLogger.error(`UtilDT.regionMacro 未能找到函数位置`);
         return
-    };
-    const baseFilePath = opt?.targetPath
-        ? path.resolve(process.cwd(),opt.targetPath)
-        : loc.filePath.replace(/(.+)\.macro\.(js|ts|cjs|mjs)$/,"$1.$2");
-    const queuefunc = async ()=>{
-        if(!(await UtilFT.pathExists(baseFilePath))) {
-            SLogger.error(`UtilDT.macro ${baseFilePath} 不存在`);
-            return
-        };
-        const text = (await fs.promises.readFile(baseFilePath,'utf-8')).replaceAll("\r\n","\n");
-        const getregex = ()=>new RegExp(
-            `([^\\S\\n]*)(//#region ${regionId}(?!\\S).*\\n)`+
-            /([\s\S]*?)/.source+
-            /([^\S\n]*\/\/#endregion(?!\S).*)/.source
-            ,"g");
-        if (!(getregex().test(text))) {
-            SLogger.error(`UtilDT.macro 无法找到区域 ${regionId}`);
-            return;
+    }
+    const plist:Promise<void>[] = [];
+    const filePaths = parseMacroPaths(loc.filePath,opt);
+    for(const filePath of filePaths){
+        const queuefunc = async ()=>{
+            if(!(await UtilFT.pathExists(filePath))) {
+                SLogger.error(`UtilDT.regionMacro ${filePath} 不存在`);
+                return
+            }
+            const text = await readFile(filePath);
+            const getregex = ()=>new RegExp(
+                `([^\\S\\n]*)(//#region ${regionId}(?!\\S).*\\n)`+
+                /([\s\S]*?)/.source+
+                /([^\S\n]*\/\/#endregion(?!\S).*)/.source
+                ,"g");
+            if (!getregex().test(text)) {
+                if(!opt?.glob) SLogger.error(`UtilDT.regionMacro 无法找到区域 ${regionId}`);
+                return;
+            }
+            const match = getregex().exec(text)!;
+            const parseCode = await parseCodeText(codeText,{text:dedent(match[3]),inent:match[1],filePath});
+            const ntext = text.replace(getregex(), `$1$2${parseCode}\n$4`);
+            await fs.promises.writeFile(filePath, ntext, 'utf-8');
+        }
+        plist.push(UtilFunc.queueProc(path.posix.normalize(filePath.replaceAll("\\","/")),queuefunc))
+    }
+    await Promise.all(plist);
+}
+/**将codeText写入对应注释下  
+ * @param commentId - 注释id \`// ${id}\`
+ * @param codeText  - 文本
+ * @param opt       - 可选参数
+ * @param opt.filePath - 目标文件 默认为去除".macro"的同名文件
+ * @param opt.glob     - 使用glob匹配而非文件路径
+ */
+export async function commentMacro(commentId:string,codeText:string|(()=>string|Promise<string>),opt?:MacroOpt){
+    const loc = UtilFunc.getFuncLoc(2);
+    if(!loc){
+        SLogger.error(`UtilDT.commentMacro 未能找到函数位置`);
+        return
+    }
+    const plist:Promise<void>[] = [];
+    const filePaths = parseMacroPaths(loc.filePath,opt);
+    for(const filePath of filePaths){
+        const queuefunc = async ()=>{
+            if(!(await UtilFT.pathExists(filePath))) {
+                SLogger.error(`UtilDT.commentMacro ${filePath} 不存在`);
+                return
+            }
+            const text = await readFile(filePath);
+            const getregex = ()=>new RegExp(
+                `([^\\S\\n]*)(// ${commentId}(?!\\S).*)`+
+                /(\n|)/.source +
+                /([^\n]*)/.source
+                ,"g");
+            if (!getregex().test(text)) {
+                if(!opt?.glob) SLogger.error(`UtilDT.commentMacro 无法找到注释 ${commentId}`);
+                return;
+            }
+            const match = getregex().exec(text)!;
+            const parseCode = await parseCodeText(codeText,{text:match[3],inent:match[1],filePath});
+            if(parseCode.includes('\n')){
+                SLogger.error(`UtilDT.commentMacro 无法使用多行文本, 考虑使用regionMacro ${codeText}`);
+                return;
+            }
+            const ntext = text.replace(getregex(), `$1$2\n${parseCode}`);
+            await fs.promises.writeFile(filePath, ntext, 'utf-8');
+        }
+        plist.push(UtilFunc.queueProc(path.posix.normalize(filePath.replaceAll("\\","/")),queuefunc))
+    }
+    await Promise.all(plist);
+}
+/**将codeText写入对应文件 不存在则创建  
+ * @param codeText  - 文本
+ * @param opt       - 可选参数
+ * @param opt.filePath - 目标文件 默认为去除".macro"的同名文件
+ * @param opt.glob     - 使用glob匹配而非文件路径
+ */
+export async function fileMacro(codeText:string|(()=>string|Promise<string>),opt?:MacroOpt){
+    const loc = UtilFunc.getFuncLoc(2);
+    if(!loc){
+        SLogger.error(`UtilDT.fileMacro 未能找到函数位置`);
+        return
+    }
+    const plist:Promise<void>[] = [];
+    const filePaths = parseMacroPaths(loc.filePath,opt);
+    for(const filePath of filePaths){
+        const queuefunc = async ()=>{
+            await UtilFT.ensurePathExists(filePath);
+            const text = await readFile(filePath);
+            const parseCode = await parseCodeText(codeText,{text,inent:'',filePath});
+            await fs.promises.writeFile(filePath, parseCode, 'utf-8');
         }
-        const match = getregex().exec(text)!;
-        const strText = typeof codeText === "function" ? await codeText() : codeText;
-        const mapText = strText.split('\n').map((line)=>`${match[1]}${line}`).join('\n');
-        const ntext = text.replace(getregex(), `$1$2${mapText}\n$4`);
-        await fs.promises.writeFile(baseFilePath, ntext, 'utf-8');
+        plist.push(UtilFunc.queueProc(path.posix.normalize(filePath.replaceAll("\\","/")),queuefunc))
     }
-    await UtilFunc.queueProc(path.posix.normalize(baseFilePath.replaceAll("\\","/")),queuefunc);
+    await Promise.all(plist);
 }
 }

package/data/tsconfig.compile.json

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

package/data/tsconfig.json

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

package/tsconfig.compile.json

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

package/tsconfig.json

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