@zwa73/utils 1.0.202 → 1.0.203

package/src/UtilFileTools.ts

@@ -1,410 +0,0 @@
-import * as fs from "fs";
-import path from 'pathe';
-import * as os from "os";
-import { JObject, JToken } from "@/src/UtilInterfaces";
-import { SLogger } from "@/src/UtilLogger";
-import * as JSON5 from 'json5';
-import { globSync, glob } 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;
-}>
-
-/**json文件加载选项 */
-type LoadJsonFileOpt<T> = Partial<{
-    /**默认值 默认{} */
-    default:T;
-    /**以json5模式加载 略慢 默认false */
-    json5:boolean;
-    /**不自动修改扩展名为json */
-    forceExt:boolean;
-}>
-
-/**json文件写入选项 */
-type WriteJsonFileOpt = Partial<{
-    /**使用紧凑风格 将会用/\uF121\uF122\uF123.+\uF121\uF122\uF123/作为特殊标记, 原始文本内若出现相同格式将会产生错误 */
-    compress:boolean;
-    /**紧凑风格 压缩阈值 默认100 */
-    compressThreshold:number;
-    /**不自动修改扩展名为json */
-    forceExt:boolean;
-}>
-
-
-/**文件工具 */
-export namespace UtilFT{
-
-/**验证路径 文件或文件夹 是否存在 异步
- * @async
- * @param filePath - 待验证的路径
- * @returns 是否存在
- */
-export async function pathExists(filePath: string):Promise<boolean>{
-    try {
-        await fs.promises.access(filePath);
-        return true;
-    } catch (e) {
-        return false;
-    }
-}
-
-/**验证路径 文件或文件夹 是否存在 同步
- * @param filePath - 待验证的路径
- * @returns - 是否存在
- */
-export function pathExistsSync(filePath: string):boolean{
-    try {
-        fs.accessSync(filePath);
-        return true;
-    } catch (e) {
-        return false;
-    }
-}
-
-/**路径不存在时创建路径 以path.sep结尾时创建文件夹 异步
- * @async
- * @param filePath - 待创建的路径
- * @param opt      - 可选参数
- * @param opt.dir  - 创建一个目录
- * @returns 是否成功创建
- */
-export async function createPath(filePath: string, opt?:CreatePathOpt):Promise<boolean>{
-    if(opt?.dir==true)
-        filePath = path.join(filePath,path.sep);
-
-    try{
-        if(filePath.endsWith(path.sep)){
-            await fs.promises.mkdir(filePath, {recursive: true});
-            return true;
-        }
-        await fs.promises.mkdir(path.dirname(filePath), {recursive: true});
-        const filehandle = await fs.promises.open(filePath, 'w');
-        await filehandle.close();
-        return true;
-    }
-    catch(e){
-        SLogger.error("createPath 错误",e);
-        return false;
-    }
-}
-
-/**路径不存在时创建路径 以path.sep结尾时创建文件夹 同步
- * @param filePath - 待创建的路径
- * @param opt      - 可选参数
- * @param opt.dir  - 创建一个目录
- * @returns 是否成功创建
- */
-export function createPathSync(filePath: string, opt?:CreatePathOpt):boolean{
-    if(opt?.dir==true)
-        filePath = path.join(filePath,path.sep);
-
-    try{
-        if(filePath.endsWith(path.sep)){
-            fs.mkdirSync(filePath, {recursive: true});
-            return true;
-        }
-        fs.mkdirSync(path.dirname(filePath), {recursive: true});
-        fs.openSync(filePath, 'w');
-        return true;
-    }
-    catch(e){
-        SLogger.error("createPathSync 错误",e);
-        return false;
-    }
-}
-
-/**确保路径存在 不存在时创建 异步
- * @async
- * @param filePath - 待验证的路径
- * @param opt      - 可选参数
- * @param opt.dir  - 强制验证一个文件夹
- * @returns 是否成功执行 创建或已存在
- */
-export async function ensurePathExists(filePath: string, opt?:EnsurePathExistsOpt):Promise<boolean>{
-    if(await pathExists(filePath))
-        return true;
-    return await createPath(filePath,opt);
-}
-
-/**确保路径存在 不存在时创建 同步
- * @param filePath - 待验证的路径
- * @param opt      - 可选参数
- * @param opt.dir  - 强制验证一个文件夹
- * @returns 是否成功执行 创建或已存在
- */
-export function ensurePathExistsSync(filePath: string, opt?:EnsurePathExistsOpt):boolean{
-    if(pathExistsSync(filePath))
-        return true;
-    return createPathSync(filePath,opt);
-}
-
-/**加载json文件 同步
- * @param filePath - 文件路径
- * @returns 加载完成的对象或空{}
- */
-export function loadJSONFileSync(filePath: string): JToken
-/**加载json文件 同步
- * @param filePath - 文件路径
- * @param opt      - 可选参数
- * @param opt.default  - 默认值
- * @param opt.json5    - json5模式
- * @param opt.forceExt - 不自动修改扩展名为json
- * @returns 加载完成的对象或默认值
- */
-export function loadJSONFileSync<T extends JToken>(filePath: string,opt:LoadJsonFileOpt<T>): T
-export function loadJSONFileSync<T extends JToken>(filePath: string,opt?:LoadJsonFileOpt<T>): T {
-    if(opt?.forceExt!==true && path.extname(filePath) !== '.json')
-        filePath += '.json';
-
-    const str = pathExistsSync(filePath)
-        ? fs.readFileSync(filePath, "utf-8")
-        : "";
-
-    // 如果不存在则返回默认值
-    if (str == "" || str == null){
-        if(opt?.default!==undefined)
-            return opt.default;
-        return {} as T;
-    }
-    if(opt?.json5)
-        return JSON5.parse(str);
-    return JSON.parse(str);
-}
-
-/**加载json文件 异步
- * @async
- * @param filePath   - 文件路径
- * @returns 加载完成的对象或空{}
- */
-export async function loadJSONFile(filePath: string): Promise<JToken>
-/**加载json文件 异步
- * @async
- * @param filePath - 文件路径
- * @param opt      - 可选参数
- * @param opt.default  - 默认值
- * @param opt.json5    - json5模式
- * @param opt.forceExt - 不自动修改扩展名为json
- * @returns 加载完成的对象或默认值
- */
-export async function loadJSONFile<T extends JToken>(filePath: string,opt:LoadJsonFileOpt<T>): Promise<T>
-export async function loadJSONFile<T extends JToken>(filePath: string,opt?:LoadJsonFileOpt<T>): Promise<T> {
-    if(opt?.forceExt!==true && path.extname(filePath) !== '.json')
-        filePath += '.json';
-
-    const str = (await pathExists(filePath))
-        ? await fs.promises.readFile(filePath, "utf-8")
-        : "";
-
-    // 如果不存在则返回默认值
-    if (str == "" || str == null){
-        if(opt?.default!==undefined)
-            return opt.default;
-        return {} as T;
-    }
-    if(opt?.json5)
-        return JSON5.parse(str);
-    return JSON.parse(str);
-}
-
-/**写入JSON文件
- * @async
- * @param filePath - 文件路径
- * @param token    - 所要写入的JToken
- * @param opt      - 可选参数
- * @param opt.compress          - 使用紧凑风格 将会用/\uF121\uF122\uF123.+\uF121\uF122\uF123/作为特殊标记, 原始文本内若出现相同格式将会产生错误
- * @param opt.forceExt          - 不自动修改扩展名为json
- * @param opt.compressThreshold - 紧凑风格 压缩阈值 默认100
- */
-export async function writeJSONFile(
-    filePath: string,
-    token: JToken,
-    opt?: WriteJsonFileOpt
-): Promise<void> {
-    const str = UtilFunc.stringifyJToken(token,opt);
-    if(opt?.forceExt!==true && path.extname(filePath) !== '.json')
-        filePath += '.json';
-
-    // 判断文件路径是否存在 不存在则创建
-    if(!(await pathExists(filePath)))
-        await createPath(filePath);
-
-	// 写入文件
-    try {
-        await fs.promises.writeFile(filePath, str);
-        SLogger.verbose(`${filePath} writeJSONFile 成功`);
-    } catch (err) {
-        SLogger.error(`${filePath} writeJSONFile 错误`,err);
-    }
-}
-/**保证路径为某个风格
- * @param filePath - 输入路径
- * @param style    - 目标风格 undefined 时不改变
- * @returns 新的符合目标风格的路径
- */
-export function stylizePath(filePath:string,style?:'win32'|'posix'){
-    if(style===undefined) return filePath;
-    return UtilFunc.matchProc(style, {
-        posix: (nor) => filePath.replaceAll("\\", "/"),
-        win32: (nor) => filePath.replaceAll("/", "\\"),
-    });
-}
-/**保证路径为POSIX风格
- * @param filePath - 输入路径
- * @returns 新的符合POSIX风格的路径
- */
-export function posixizePath(filePath: string): string {
-    return stylizePath(filePath, 'posix');
-}
-
-/**保证路径为Win32风格
- * @param filePath - 输入路径
- * @returns 新的符合Win32风格的路径
- */
-export function win32izePath(filePath: string): string {
-    return stylizePath(filePath, 'win32');
-}
-
-/**保证路径为当前系统风格
- * @param filePath - 输入路径
- * @returns 新的符合当前系统风格的路径
- */
-export function currosizePath(filePath: string): string {
-    const system = os.platform();
-    if (system === 'win32')
-        return win32izePath(filePath);
-    return posixizePath(filePath);
-}
-/**逐级寻找node_modules文件夹
- * @param basePath - 基础位置
- */
-export async function findNodeModulesDir(basePath:string){
-    let currentDir = basePath;
-    while (currentDir) {
-        const nodeModulesPath = path.join(currentDir, 'node_modules');
-        if (await UtilFT.pathExists(nodeModulesPath))
-            return nodeModulesPath;
-        const parentDir = path.dirname(currentDir);
-        if (parentDir === currentDir) break;
-        currentDir = parentDir;
-    }
-    return undefined;
-}
-
-
-
-
-/**搜索路径符合正则表达式的文件
- * @param dir           - 起始目录
- * @param traitRegex    - 正则表达式
- * @param opt           - 可选参数
- * @param opt.relative  - 搜索子目录
- * @returns 文件名路径数组
- */
-export async function fileSearchRegex(dir: string, traitRegex: string, opt?:FileSearchRegexOpt) {
-    const relative = opt?.relative ?? true;
-    const outArray: string[] = [];
-    const subFiles = await fs.promises.readdir(dir, { withFileTypes: true });
-    //如果使用 g 会导致 RegExp.lastIndex 更改, 将会导致匹配错误
-    const regex = new RegExp(traitRegex);
-    await Promise.all(subFiles.map(async (subFile)=>{
-        const subFilePath = path.join(dir, subFile.name);
-        //判断是否是文件夹，递归调用
-        if (subFile.isDirectory()) {
-            if (relative)
-                outArray.push(... await fileSearchRegex(path.join(subFilePath, path.sep), traitRegex));
-            return;
-        }
-        if (regex.test(subFilePath)) outArray.push(subFilePath);
-    }));
-    return outArray.map((filePath) => path.normalize(filePath));
-}
-/**搜索路径符合正则表达式的文件 同步版本
- * @param dir           - 起始目录
- * @param traitRegex    - 正则表达式
- * @param opt           - 可选参数
- * @param opt.relative  - 搜索子目录
- * @returns 文件名路径数组
- */
-export function fileSearchRegexSync(dir: string, traitRegex: string, opt?:FileSearchRegexOpt) {
-    const relative = opt?.relative ?? true;
-    const outArray: string[] = [];
-    const subFiles = fs.readdirSync(dir, { withFileTypes: true });
-    //如果使用 g 会导致 RegExp.lastIndex 更改, 将会导致匹配错误
-    const regex = new RegExp(traitRegex);
-    for (const subFile of subFiles) {
-        const subFilePath = path.join(dir, subFile.name);
-        //判断是否是文件夹，递归调用
-        if (subFile.isDirectory()) {
-            if (relative)
-                outArray.push(...fileSearchRegexSync(path.join(subFilePath, path.sep), traitRegex));
-            continue;
-        }
-        if (regex.test(subFilePath)) outArray.push(subFilePath);
-    }
-    return outArray.map((filePath) => path.normalize(filePath));
-}
-/**搜索符合Glob匹配的文件
- * @param dir         - 起始目录
- * @param globPattern - glob匹配
- * @param opt         - 可选参数
- * @param opt.ignore  - 忽略的文件
- * @returns 文件绝对路径数组
- */
-export async function fileSearchGlob(dir: string, globPattern:string|string[],opt?:FileSearchGlobOpt){
-    const fixedPath = typeof globPattern === "string"
-        ? path.join(dir,globPattern)
-        : globPattern.map((p)=>path.join(dir,p));
-    return (await glob(fixedPath, { ignore: opt?.ingore, absolute: true }))
-        .map((filePath) => path.normalize(filePath));
-}
-/**搜索符合Glob匹配的文件 同步版本
- * @param dir         - 起始目录
- * @param globPattern - glob匹配
- * @param opt         - 可选参数
- * @param opt.ignore  - 忽略的文件
- * @returns 文件绝对路径数组
- */
-export function fileSearchGlobSync(dir: string, globPattern:string|string[],opt?:FileSearchGlobOpt){
-    const fixedPath = typeof globPattern === "string"
-        ? path.join(dir,globPattern)
-        : globPattern.map((p)=>path.join(dir,p));
-    return globSync(fixedPath, { ignore: opt?.ingore, absolute: true })
-        .map((filePath) => path.normalize(filePath));
-}
-/**是一个有效的文件路径
- * @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;
-}
-}