@zwa73/utils 1.0.103 → 1.0.105

package/dist/UtilFileTools.d.ts

@@ -1,4 +1,28 @@
 import { JToken } from "./UtilInterfaces";
+/**创建文件选项 */
+type CreatePathOpt = Partial<{
+    /**创建一个目录 默认 false
+     * 默认仅在以path.sep结尾时创建文件夹
+     */
+    dir: boolean;
+}>;
+/**验证文件选项 */
+type EnsurePathExistsOpt = Partial<{
+    /**验证一个目录 默认 false
+     * 默认仅在以path.sep结尾时创建文件夹
+     */
+    dir: boolean;
+}>;
+/**glob搜索选项 */
+type FileSearchGlobOpt = Partial<{
+    /**忽略的文件 默认 undefined */
+    ingore: string | string[];
+}>;
+/**regex搜索选项 */
+type FileSearchRegexOpt = Partial<{
+    /**搜索子目录 默认 true */
+    relative: boolean;
+}>;
 /**文件工具 */
 export declare namespace UtilFT {
     /**验证路径 文件或文件夹 是否存在 异步
@@ -15,28 +39,33 @@ export declare namespace UtilFT {
     /**路径不存在时创建路径 以path.sep结尾时创建文件夹 异步
      * @async
      * @param filePath - 待创建的路径
-     * @param isDir    - 强制创建一个文件夹
+     * @param opt      - 可选参数
+     * @param opt.dir  - 创建一个目录
      * @returns 是否成功创建
      */
-    function createPath(filePath: string, isDir?: boolean): Promise<boolean>;
+    function createPath(filePath: string, opt?: CreatePathOpt): Promise<boolean>;
     /**路径不存在时创建路径 以path.sep结尾时创建文件夹 同步
      * @param filePath - 待创建的路径
-     * @param isDir   - 强制验证一个文件夹
+     * @param opt      - 可选参数
+     * @param opt.dir  - 创建一个目录
      * @returns 是否成功创建
      */
-    function createPathSync(filePath: string, isDir?: boolean): boolean;
+    function createPathSync(filePath: string, opt?: CreatePathOpt): boolean;
     /**确保路径存在 不存在时创建 异步
      * @async
      * @param filePath - 待验证的路径
-     * @param isDir    - 强制验证一个文件夹
+     * @param opt      - 可选参数
+     * @param opt.dir  - 强制验证一个文件夹
      * @returns 是否成功执行 创建或已存在
      */
-    function ensurePathExists(filePath: string, isDir?: boolean): Promise<boolean>;
+    function ensurePathExists(filePath: string, opt?: EnsurePathExistsOpt): Promise<boolean>;
     /**确保路径存在 不存在时创建 同步
      * @param filePath - 待验证的路径
+     * @param opt      - 可选参数
+     * @param opt.dir  - 强制验证一个文件夹
      * @returns 是否成功执行 创建或已存在
      */
-    function ensurePathExistsSync(filePath: string, isDir?: boolean): boolean;
+    function ensurePathExistsSync(filePath: string, opt?: EnsurePathExistsOpt): boolean;
     /**加载json文件 同步
      * @param filePath - 文件路径
      * @returns 加载完成的对象或空{}
@@ -69,17 +98,21 @@ export declare namespace UtilFT {
      */
     function writeJSONFile(filePath: string, token: JToken): Promise<void>;
     /**搜索路径符合正则表达式的文件
-     * @param folder - 文件夹路径
-     * @param traitRegex - 正则表达式
+     * @param folder        - 文件夹路径
+     * @param traitRegex    - 正则表达式
+     * @param opt           - 可选参数
+     * @param opt.relative  - 搜索子目录
      * @returns 文件名路径数组
      */
-    function fileSearchRegex(folder: string, traitRegex: string): string[];
+    function fileSearchRegex(folder: string, traitRegex: string, opt?: FileSearchRegexOpt): string[];
     /**搜索符合Glob匹配的文件
+     * @param folder      - 文件夹路径
      * @param globPattern - glob匹配
-     * @param ignore - 忽略的文件
+     * @param opt         - 可选参数
+     * @param opt.ignore  - 忽略的文件
      * @returns 文件绝对路径数组
      */
-    function fileSearchGlob(globPattern: string | string[], ignore?: string | string[]): string[];
+    function fileSearchGlob(folder: string, globPattern: string | string[], opt?: FileSearchGlobOpt): string[];
     /**
      * @deprecated 请使用 fileSearchRegex 或 fileSearchGlob
      */
@@ -89,3 +122,4 @@ export declare namespace UtilFT {
      */
     function isValidFilePath(filePath: string): boolean;
 }
+export {};

package/dist/UtilFileTools.js

@@ -66,11 +66,12 @@ var UtilFT;
     /**路径不存在时创建路径 以path.sep结尾时创建文件夹 异步
      * @async
      * @param filePath - 待创建的路径
-     * @param isDir    - 强制创建一个文件夹
+     * @param opt      - 可选参数
+     * @param opt.dir  - 创建一个目录
      * @returns 是否成功创建
      */
-    async function createPath(filePath, isDir) {
-        if (isDir == true)
+    async function createPath(filePath, opt) {
+        if (opt?.dir == true)
             filePath = path.join(filePath, path.sep);
         try {
             if (filePath.endsWith(path.sep)) {
@@ -90,11 +91,12 @@ var UtilFT;
     UtilFT.createPath = createPath;
     /**路径不存在时创建路径 以path.sep结尾时创建文件夹 同步
      * @param filePath - 待创建的路径
-     * @param isDir   - 强制验证一个文件夹
+     * @param opt      - 可选参数
+     * @param opt.dir  - 创建一个目录
      * @returns 是否成功创建
      */
-    function createPathSync(filePath, isDir) {
-        if (isDir == true)
+    function createPathSync(filePath, opt) {
+        if (opt?.dir == true)
             filePath = path.join(filePath, path.sep);
         try {
             if (filePath.endsWith(path.sep)) {
@@ -114,23 +116,26 @@ var UtilFT;
     /**确保路径存在 不存在时创建 异步
      * @async
      * @param filePath - 待验证的路径
-     * @param isDir    - 强制验证一个文件夹
+     * @param opt      - 可选参数
+     * @param opt.dir  - 强制验证一个文件夹
      * @returns 是否成功执行 创建或已存在
      */
-    async function ensurePathExists(filePath, isDir) {
+    async function ensurePathExists(filePath, opt) {
         if (await pathExists(filePath))
             return true;
-        return await createPath(filePath, isDir);
+        return await createPath(filePath, opt);
     }
     UtilFT.ensurePathExists = ensurePathExists;
     /**确保路径存在 不存在时创建 同步
      * @param filePath - 待验证的路径
+     * @param opt      - 可选参数
+     * @param opt.dir  - 强制验证一个文件夹
      * @returns 是否成功执行 创建或已存在
      */
-    function ensurePathExistsSync(filePath, isDir) {
+    function ensurePathExistsSync(filePath, opt) {
         if (pathExistsSync(filePath))
             return true;
-        return createPathSync(filePath, isDir);
+        return createPathSync(filePath, opt);
     }
     UtilFT.ensurePathExistsSync = ensurePathExistsSync;
     function loadJSONFileSync(filePath, def) {
@@ -189,20 +194,23 @@ var UtilFT;
     }
     UtilFT.writeJSONFile = writeJSONFile;
     /**搜索路径符合正则表达式的文件
-     * @param folder - 文件夹路径
-     * @param traitRegex - 正则表达式
+     * @param folder        - 文件夹路径
+     * @param traitRegex    - 正则表达式
+     * @param opt           - 可选参数
+     * @param opt.relative  - 搜索子目录
      * @returns 文件名路径数组
      */
-    function fileSearchRegex(folder, traitRegex) {
-        let outArray = [];
-        let subFiles = fs.readdirSync(folder);
-        let regex = new RegExp(traitRegex);
-        for (let subFile of subFiles) {
-            let subFilePath = path.join(folder, subFile);
-            let stat = fs.lstatSync(subFilePath);
+    function fileSearchRegex(folder, traitRegex, opt) {
+        const relative = opt?.relative ?? true;
+        const outArray = [];
+        const subFiles = fs.readdirSync(folder, { withFileTypes: true });
+        const regex = new RegExp(traitRegex);
+        for (const subFile of subFiles) {
+            const subFilePath = path.join(folder, subFile.name);
             //判断是否是文件夹，递归调用
-            if (stat.isDirectory()) {
-                outArray.push(...fileSearchRegex(path.join(subFilePath, path.sep), traitRegex));
+            if (subFile.isDirectory()) {
+                if (relative)
+                    outArray.push(...fileSearchRegex(path.join(subFilePath, path.sep), traitRegex));
                 continue;
             }
             if (regex.test(subFilePath))
@@ -212,15 +220,17 @@ var UtilFT;
     }
     UtilFT.fileSearchRegex = fileSearchRegex;
     /**搜索符合Glob匹配的文件
+     * @param folder      - 文件夹路径
      * @param globPattern - glob匹配
-     * @param ignore - 忽略的文件
+     * @param opt         - 可选参数
+     * @param opt.ignore  - 忽略的文件
      * @returns 文件绝对路径数组
      */
-    function fileSearchGlob(globPattern, ignore) {
+    function fileSearchGlob(folder, globPattern, opt) {
         const fixedPath = typeof globPattern === "string"
-            ? path.posix.normalize(globPattern)
-            : globPattern.map((p) => path.posix.normalize(p));
-        return (0, glob_1.globSync)(fixedPath, { ignore, absolute: true });
+            ? path.join(folder, path.posix.normalize(globPattern))
+            : globPattern.map((p) => path.join(folder, path.posix.normalize(p)));
+        return (0, glob_1.globSync)(fixedPath, { ignore: opt?.ingore, absolute: true });
     }
     UtilFT.fileSearchGlob = fileSearchGlob;
     /**

package/package.json

@@ -1,10 +1,10 @@
 {
 	"name": "@zwa73/utils",
-	"version": "1.0.103",
+	"version": "1.0.105",
 	"description": "my utils",
 	"main": "index.js",
 	"scripts": {
-		"test": "call npm run compile && jest",
+		"test": "jest",
 		"postinstall": "start node ./scripts/postinstall.js",
 		"release": "powershell scripts/release",
 		"compile": "powershell scripts/compile",

package/scripts/compile.ps1

@@ -1,5 +1,5 @@
-Write-Output 开始删除原dist
-Remove-Item -Recurse -Force dist
-Write-Output 开始编译
-tsc -p tsconfig.compile.json
+Write-Output 开始删除原dist
+Remove-Item -Recurse -Force dist
+Write-Output 开始编译
+tsc -p tsconfig.compile.json
 tsc-alias -p tsconfig.compile.json

package/scripts/postinstall.js

@@ -1,53 +1,69 @@
-const currentVersion = require('../package.json').version;
-const path = require('path');
-const { UtilFT } = require("../index");
-const readline = require('readline');
-
-// 将版本号转换为可以比较的数字
-function versionToNumber(version) {
-    if(version==undefined) return 0;
-    return version.split('.').map(Number).reduce((acc, val) => acc * 1000 + val);
-}
-
-//显示提示
-function showUpgradeMessages(prevVersion, currentVersion, infoTable) {
-    let prevVersionNumber = versionToNumber(prevVersion);
-    let currentVersionNumber = versionToNumber(currentVersion);
-    // 遍历infoTable中的所有版本
-    for (let version in infoTable) {
-        let versionNumber = versionToNumber(version);
-        // 如果用户的上一个版本低于这个版本，而当前版本高于或等于这个版本
-        if (versionNumber > prevVersionNumber && versionNumber <= currentVersionNumber) {
-            // 显示这个版本的提示信息
-            console.log(infoTable[version]);
-        }
-    }
-}
-
-//提示表
-const infoTable = {
-    "1.0.47":"UtilFT.fileSearch 函数与返回值发生变动, 请使用fileSearchRegex 或 fileSearchGlob"
-}
-
-async function main(){
-    const dataPath = path.join(__dirname,"..","..","version.json");
-    UtilFT.ensurePathExists(dataPath);
-    const dataTable = UtilFT.loadJSONFileSync(dataPath,{});
-    dataTable.utils = dataTable.utils??{};
-    const prevVersion = dataTable.utils.version;
-    dataTable.utils.version = currentVersion;
-
-    console.log(`${currentVersion} 版本已安装`);
-    // 使用这个函数来显示升级信息
-    showUpgradeMessages(prevVersion, currentVersion, infoTable);
-
-    await UtilFT.writeJSONFile(dataPath, dataTable);
-
-    const rl = readline.createInterface({
-        input: process.stdin,
-        output: process.stdout
-    });
-
-    rl.question('按任意键继续...', () => rl.close());
-}
-main()
+const path = require('path');
+const { UtilFT, SLogger } = require("../index");
+const readline = require('readline');
+
+const PACKAGE_PATH = path.join(__dirname,'..','package.json');
+const VERSION_PATH = path.join(__dirname,"..","..","version.json");
+//提示表
+const INFO_TABLE = {
+    "1.0.47":"UtilFT.fileSearch 函数与返回值发生变动, 请使用fileSearchRegex 或 fileSearchGlob",
+    "1.0.104":
+        "UtilFT.fleSearchGlob 更改参数 floder作为第一个参数 ingore 移入 可选参数对象 \n" +
+        "UtilFT.fleSearchRegex 添加了一个可选参数 \n" +
+        "UtilFT.createPath 更改参数 dir 移入 可选参数对象 \n" +
+        "UtilFT.createPathSync 更改参数 dir 移入 可选参数对象 \n" +
+        "UtilFT.ensurePathExists 更改参数 dir 移入 可选参数对象 \n" +
+        "UtilFT.ensurePathExistsSync 更改参数 dir 移入 可选参数对象 \n"
+}
+
+// 将版本号转换为可以比较的数字
+function versionToNumber(version) {
+    if(version==undefined) return 0;
+    return version.split('.').map(Number).reduce((acc, val) => acc * 1000 + val);
+}
+
+//显示提示
+function showUpgradeMessages(prevVersion, currentVersion) {
+    const prevVersionNumber = versionToNumber(prevVersion);
+    const currentVersionNumber = versionToNumber(currentVersion);
+    let hasOut = false;
+    // 遍历infoTable中的所有版本
+    for (const version in INFO_TABLE) {
+        const versionNumber = versionToNumber(version);
+        // 如果用户的上一个版本低于这个版本，而当前版本高于或等于这个版本
+        if (versionNumber > prevVersionNumber && versionNumber <= currentVersionNumber) {
+            // 显示这个版本的提示信息
+            SLogger.info(INFO_TABLE[version]);
+            hasOut=true;
+        }
+    }
+    return hasOut;
+}
+
+
+
+async function main(){
+    const packageTable = await UtilFT.loadJSONFile(PACKAGE_PATH);
+    const currentVersion = packageTable.version;
+    await UtilFT.ensurePathExists(versionTable);
+    const versionTable = Object.assign({},
+        await UtilFT.loadJSONFile(VERSION_PATH,{}),
+        {utils:{version:currentVersion}});
+    const prevVersion = versionTable.utils.version;
+
+    SLogger.info(`${currentVersion} 版本已安装`);
+    // 使用这个函数来显示升级信息
+    const hasOut = showUpgradeMessages(prevVersion, currentVersion);
+
+    versionTable.utils.version = currentVersion;
+    await UtilFT.writeJSONFile(dataPath, versionTable);
+
+    if(!hasOut) return;
+    const rl = readline.createInterface({
+        input: process.stdin,
+        output: process.stdout
+    });
+    setTimeout(()=>rl.close(),10000);
+    rl.question('按任意键继续...', () => rl.close());
+}
+main()

package/scripts/release.ps1

@@ -1,4 +1,4 @@
-Write-Output 开始编译
-npm run compile
-Write-Output 开始发布
+Write-Output 开始编译
+npm run compile
+Write-Output 开始发布
 npx zcli release

package/scripts/watch.ps1

@@ -1,10 +1,10 @@
-# 定义一个函数来运行脚本
-function New-Script {
-    param($command)
-    # 在后台运行命令
-    Start-Process -NoNewWindow -FilePath "powershell" -ArgumentList "-Command", $command
-}
-
-# 开始运行脚本
-New-Script "tsc -w -p tsconfig.compile.json"
+# 定义一个函数来运行脚本
+function New-Script {
+    param($command)
+    # 在后台运行命令
+    Start-Process -NoNewWindow -FilePath "powershell" -ArgumentList "-Command", $command
+}
+
+# 开始运行脚本
+New-Script "tsc -w -p tsconfig.compile.json"
 New-Script "tsc-alias -w -p tsconfig.compile.json"

package/src/UtilFileTools.ts

@@ -6,6 +6,33 @@ import * as JSON5 from 'json5';
 import { globSync } from "glob";
 import { UtilFunc } from "./UtilFunctions";
 
+/**创建文件选项 */
+type CreatePathOpt = Partial<{
+    /**创建一个目录 默认 false  
+     * 默认仅在以path.sep结尾时创建文件夹  
+     */
+    dir:boolean
+}>
+/**验证文件选项 */
+type EnsurePathExistsOpt = Partial<{
+    /**验证一个目录 默认 false  
+     * 默认仅在以path.sep结尾时创建文件夹  
+     */
+    dir:boolean
+}>
+
+/**glob搜索选项 */
+type FileSearchGlobOpt = Partial<{
+    /**忽略的文件 默认 undefined */
+    ingore:string|string[];
+}>
+
+/**regex搜索选项 */
+type FileSearchRegexOpt = Partial<{
+    /**搜索子目录 默认 true */
+    relative:boolean;
+}>
+
 /**文件工具 */
 export namespace UtilFT{
 
@@ -40,11 +67,12 @@ export function pathExistsSync(filePath: string):boolean{
 /**路径不存在时创建路径 以path.sep结尾时创建文件夹 异步
  * @async
  * @param filePath - 待创建的路径
- * @param isDir    - 强制创建一个文件夹
+ * @param opt      - 可选参数
+ * @param opt.dir  - 创建一个目录
  * @returns 是否成功创建
  */
-export async function createPath(filePath: string, isDir?:boolean):Promise<boolean>{
-    if(isDir==true)
+export async function createPath(filePath: string, opt?:CreatePathOpt):Promise<boolean>{
+    if(opt?.dir==true)
         filePath = path.join(filePath,path.sep);
 
     try{
@@ -65,11 +93,12 @@ export async function createPath(filePath: string, isDir?:boolean):Promise<boole
 
 /**路径不存在时创建路径 以path.sep结尾时创建文件夹 同步
  * @param filePath - 待创建的路径
- * @param isDir   - 强制验证一个文件夹
+ * @param opt      - 可选参数
+ * @param opt.dir  - 创建一个目录
  * @returns 是否成功创建
  */
-export function createPathSync(filePath: string, isDir?:boolean):boolean{
-    if(isDir==true)
+export function createPathSync(filePath: string, opt?:CreatePathOpt):boolean{
+    if(opt?.dir==true)
         filePath = path.join(filePath,path.sep);
 
     try{
@@ -90,23 +119,26 @@ export function createPathSync(filePath: string, isDir?:boolean):boolean{
 /**确保路径存在 不存在时创建 异步
  * @async
  * @param filePath - 待验证的路径
- * @param isDir    - 强制验证一个文件夹
+ * @param opt      - 可选参数
+ * @param opt.dir  - 强制验证一个文件夹
  * @returns 是否成功执行 创建或已存在
  */
-export async function ensurePathExists(filePath: string, isDir?:boolean):Promise<boolean>{
+export async function ensurePathExists(filePath: string, opt?:EnsurePathExistsOpt):Promise<boolean>{
     if(await pathExists(filePath))
         return true;
-    return await createPath(filePath,isDir);
+    return await createPath(filePath,opt);
 }
 
 /**确保路径存在 不存在时创建 同步
  * @param filePath - 待验证的路径
+ * @param opt      - 可选参数
+ * @param opt.dir  - 强制验证一个文件夹
  * @returns 是否成功执行 创建或已存在
  */
-export function ensurePathExistsSync(filePath: string, isDir?:boolean):boolean{
+export function ensurePathExistsSync(filePath: string, opt?:EnsurePathExistsOpt):boolean{
     if(pathExistsSync(filePath))
         return true;
-    return createPathSync(filePath,isDir);
+    return createPathSync(filePath,opt);
 }
 
 /**加载json文件 同步
@@ -196,20 +228,22 @@ export async function writeJSONFile(
 }
 
 /**搜索路径符合正则表达式的文件
- * @param folder - 文件夹路径
- * @param traitRegex - 正则表达式
+ * @param folder        - 文件夹路径
+ * @param traitRegex    - 正则表达式
+ * @param opt           - 可选参数
+ * @param opt.relative  - 搜索子目录
  * @returns 文件名路径数组
  */
-export function fileSearchRegex(folder: string, traitRegex: string) {
-    let outArray: string[] = [];
-    let subFiles = fs.readdirSync(folder);
-    let regex = new RegExp(traitRegex);
-    for (let subFile of subFiles) {
-        let subFilePath = path.join(folder, subFile);
-        let stat = fs.lstatSync(subFilePath);
+export function fileSearchRegex(folder: string, traitRegex: string, opt?:FileSearchRegexOpt) {
+    const relative = opt?.relative ?? true;
+    const outArray: string[] = [];
+    const subFiles = fs.readdirSync(folder,{withFileTypes:true});
+    const regex = new RegExp(traitRegex);
+    for (const subFile of subFiles) {
+        const subFilePath = path.join(folder, subFile.name);
         //判断是否是文件夹，递归调用
-        if (stat.isDirectory()) {
-            outArray.push(...fileSearchRegex(path.join(subFilePath, path.sep), traitRegex));
+        if (subFile.isDirectory()) {
+            if(relative) outArray.push(...fileSearchRegex(path.join(subFilePath, path.sep), traitRegex));
             continue;
         }
         if (regex.test(subFilePath)) outArray.push(subFilePath);
@@ -217,15 +251,17 @@ export function fileSearchRegex(folder: string, traitRegex: string) {
     return outArray;
 }
 /**搜索符合Glob匹配的文件
+ * @param folder      - 文件夹路径
  * @param globPattern - glob匹配
- * @param ignore - 忽略的文件
+ * @param opt         - 可选参数
+ * @param opt.ignore  - 忽略的文件
  * @returns 文件绝对路径数组
  */
-export function fileSearchGlob(globPattern:string|string[],ignore?:string|string[]){
+export function fileSearchGlob(folder: string, globPattern:string|string[],opt?:FileSearchGlobOpt){
     const fixedPath = typeof globPattern === "string"
-        ? path.posix.normalize(globPattern)
-        : globPattern.map((p)=>path.posix.normalize(p));
-    return globSync(fixedPath,{ignore,absolute:true});
+        ? path.join(folder,path.posix.normalize(globPattern))
+        : globPattern.map((p)=>path.join(folder,path.posix.normalize(p)));
+    return globSync(fixedPath,{ignore:opt?.ingore,absolute:true});
 }
 /**
  * @deprecated 请使用 fileSearchRegex 或 fileSearchGlob