@zwa73/dev-utils 1.0.80 → 1.0.82

package/dist/mjs/Command/Release.js

@@ -0,0 +1,88 @@
+import path from 'pathe';
+import { memoize, SLogger, throwError, UtilFT, UtilFunc } from '@zwa73/utils';
+import { checkProject, OFFICIAL_SOURCE, PROJECT_PATH } from './RouteInterface.js';
+import fs from 'fs';
+/**解析版本号为number数组 */
+function parseVersion(version) {
+    const arr = version.split(".").map(Number);
+    if (arr.length !== 3)
+        throwError(`${version} 不是有效的版本号`, 'error');
+    for (let i = 0; i < 3; i++) {
+        if (!isFinite(arr[i]))
+            throwError(`${version} 不是有效的版本号`, 'error');
+    }
+    return arr;
+}
+/**判断版本号是否有效 */
+function checkVersion(oldVersion, newVersion) {
+    const oldParts = parseVersion(oldVersion);
+    const newParts = parseVersion(newVersion);
+    for (let i = 0; i < 3; i++) {
+        if (newParts[i] < oldParts[i])
+            throwError(`${newVersion} 低于当前版本号 ${oldVersion}`, 'error');
+        if (newParts[i] > oldParts[i])
+            break;
+    }
+}
+/**更新版本号 */
+async function updateVersion(newVersion) {
+    const packagePath = path.join(PROJECT_PATH, "package.json");
+    const packageData = await memoize(UtilFT.loadJSONFile)(packagePath);
+    if (newVersion) {
+        checkVersion(packageData.version, newVersion);
+        packageData.version = newVersion;
+    }
+    else {
+        const version = packageData.version.split(".");
+        version[2] = (parseInt(version[2]) + 1).toString();
+        packageData.version = version.join(".");
+    }
+    await UtilFT.writeJSONFile(packagePath, packageData);
+    return packageData.version;
+}
+/**获取包名 */
+async function getPackName() {
+    const packagePath = path.join(PROJECT_PATH, "package.json");
+    const packageData = await memoize(UtilFT.loadJSONFile)(packagePath);
+    return packageData.name
+        .replace(/\//g, '-')
+        .replace(/^@/g, '');
+}
+/**更新版本号并发布npm包 */
+export const CmdRelease = (program) => program
+    .command("Release")
+    .alias("release")
+    .description("更新版本号并发布包")
+    .option("-v, --version <version>", "指定发布的版本号 格式应为 `${number}.${number}.${number}`")
+    .option("-a, --access <access>", "npm publish 的 access 参数 默认 public", "public")
+    .option("-l, --local <path>", "仅打包到本地对印目录下 如./build/", undefined)
+    .action(async (opt) => {
+    checkProject();
+    SLogger.info(`开始发布项目`);
+    try {
+        const newVersion = await updateVersion(opt.version);
+        SLogger.info(`新版本号: ${newVersion}`);
+        if (opt.local) {
+            SLogger.info("正在打包...");
+            const fullpath = path.join(process.cwd(), opt.local);
+            await UtilFT.ensurePathExists(fullpath, { dir: true });
+            await UtilFunc.exec(`npm pack`, { errlvl: 'info' });
+            const packageName = await getPackName();
+            const filelist = await fs.promises.readdir(process.cwd());
+            await Promise.all(filelist
+                .filter(p => new RegExp(packageName).test(p))
+                .map(async (p) => {
+                const packagePath = path.join(fullpath, p);
+                await fs.promises.rename(p, packagePath);
+            }));
+            return;
+        }
+        SLogger.info("正在发布...");
+        const cmd = `npm publish --registry ${OFFICIAL_SOURCE} --access ${opt.access}`;
+        await UtilFunc.exec(cmd, { errlvl: 'info' });
+        SLogger.info("发布完成");
+    }
+    catch (error) {
+        SLogger.error(error);
+    }
+});

package/dist/mjs/Command/Route.d.ts

@@ -0,0 +1 @@
+export declare function cliRoute(): Promise<void>;

package/dist/mjs/Command/Route.js

@@ -0,0 +1,20 @@
+import { program } from 'commander';
+import { CmdNode } from './Node.js';
+import { CmdRelease } from './Release.js';
+import { CmdMapPath } from './MapPath.js';
+import { CmdScanDups } from './ScanDups.js';
+import { CmdGenSchema } from './GenSchema.js';
+import { CmdExpandMacro } from './ExpandMacro.js';
+import { CmdGenI18n } from './GenI18n.js';
+import { CmdGenTemplate } from './GenTemplate.js';
+export async function cliRoute() {
+    CmdNode(program);
+    CmdRelease(program);
+    CmdMapPath(program);
+    CmdScanDups(program);
+    CmdGenSchema(program);
+    CmdExpandMacro(program);
+    CmdGenI18n(program);
+    CmdGenTemplate(program);
+    program.parse(process.argv);
+}

package/dist/mjs/Command/RouteInterface.d.ts

@@ -0,0 +1,24 @@
+/**npm镜像源 */
+export declare const MIRROR_SOURCE = "https://registry.npmmirror.com/";
+/**npm官方源 */
+export declare const OFFICIAL_SOURCE = "https://registry.npmjs.org/";
+/**根目录 */
+export declare const ROOT_PATH: string;
+/**data文件夹路径 */
+export declare const DATA_PATH: string;
+/**template文件夹路径 */
+export declare const TEMPLATE_PATH: string;
+/**项目路径 */
+export declare const PROJECT_PATH: string;
+/** 检测非浮点的整数类型 */
+export declare function parseInteger(value: string): number;
+/** 检测任意数字类型 */
+export declare function parseNumber(value: string): number;
+/** 检测布尔类型 */
+export declare function parseBoolean(value: string): boolean;
+/**在镜像源内镜像操作 */
+export declare function withMirrorSource(func: (() => any)): Promise<void>;
+/**在官方源内镜像操作 */
+export declare function withOfficialSource(func: (() => any)): Promise<void>;
+/**检查目录是否为项目 */
+export declare function checkProject(): Promise<void>;

package/{src/Command/RouteInterface.ts → dist/mjs/Command/RouteInterface.js}

@@ -1,63 +1,58 @@
-import path from 'pathe';
-
-import { SLogger, throwError, UtilFT, UtilFunc } from '@zwa73/utils';
-
-/**npm镜像源 */
-export const MIRROR_SOURCE = "https://registry.npmmirror.com/";
-/**npm官方源 */
-export const OFFICIAL_SOURCE = "https://registry.npmjs.org/";
-/**data文件夹路径 */
-export const DATA_PATH = path.join(__dirname,'..','..','data');
-/**项目路径 */
-export const PROJECT_PATH = process.cwd();
-
-/** 检测非浮点的整数类型 */
-export function parseInteger(value: string): number {
-    const num = Number(value);
-    if(!(typeof num === 'number' && isFinite(num) && Math.floor(num) === num))
-        throwError(`${value} 不是有效的整数数字`);
-    return num;
-}
-
-/** 检测任意数字类型 */
-export function parseNumber(value: string):number {
-    const num = Number(value);
-    if(!(typeof value === 'number' && isFinite(value)))
-        throwError(`${value} 不是有效的数字`);
-    return num;
-}
-
-/** 检测布尔类型 */
-export function parseBoolean(value: string): boolean {
-    return value? true:false;
-}
-
-
-/**在镜像源内镜像操作 */
-export async function withMirrorSource(func:(()=>any)){
-    const out = await UtilFunc.exec('npm config get registry');
-    const OriginSource = out.stdout.trim()//?
-    SLogger.info(`正在修改npm源为 镜像源: ${MIRROR_SOURCE}`);
-    await UtilFunc.exec(`npm config set registry ${MIRROR_SOURCE}`);
-    await func();
-    SLogger.info(`正在修改npm源为 原始源: ${OriginSource}`);
-    await UtilFunc.exec(`npm config set registry ${OriginSource}`);
-}
-
-/**在官方源内镜像操作 */
-export async function withOfficialSource(func:(()=>any)){
-    const out = await UtilFunc.exec('npm config get registry');
-    const OriginSource = out.stdout.trim()//?
-    SLogger.info(`正在修改npm源为 官方源: ${OFFICIAL_SOURCE}`);
-    await UtilFunc.exec(`npm config set registry ${OFFICIAL_SOURCE}`);
-    await func();
-    SLogger.info(`正在修改npm源为 原始源: ${OriginSource}`);
-    await UtilFunc.exec(`npm config set registry ${OriginSource}`);
-}
-
-/**检查目录是否为项目 */
-export async function checkProject() {
-    const filePath = path.join(PROJECT_PATH,"package.json");
-    if(!(await UtilFT.pathExists(filePath)))
-        throwError(`当前目录: ${PROJECT_PATH} 不是npm项目目录, 请先使用 npm init`);
-}
+import path from 'pathe';
+import { SLogger, throwError, UtilFT, UtilFunc } from '@zwa73/utils';
+/**npm镜像源 */
+export const MIRROR_SOURCE = "https://registry.npmmirror.com/";
+/**npm官方源 */
+export const OFFICIAL_SOURCE = "https://registry.npmjs.org/";
+/**根目录 */
+export const ROOT_PATH = path.join(`${process.platform === 'win32' ? '' : '/'}${/file:\/{2,3}(.+)\/[^/]/.exec(import.meta.url)[1]}`, '..', '..', '..');
+/**data文件夹路径 */
+export const DATA_PATH = path.join(ROOT_PATH, 'data');
+/**template文件夹路径 */
+export const TEMPLATE_PATH = path.join(DATA_PATH, 'template');
+/**项目路径 */
+export const PROJECT_PATH = process.cwd();
+/** 检测非浮点的整数类型 */
+export function parseInteger(value) {
+    const num = Number(value);
+    if (!(typeof num === 'number' && isFinite(num) && Math.floor(num) === num))
+        throwError(`${value} 不是有效的整数数字`);
+    return num;
+}
+/** 检测任意数字类型 */
+export function parseNumber(value) {
+    const num = Number(value);
+    if (!(typeof value === 'number' && isFinite(value)))
+        throwError(`${value} 不是有效的数字`);
+    return num;
+}
+/** 检测布尔类型 */
+export function parseBoolean(value) {
+    return value ? true : false;
+}
+/**在镜像源内镜像操作 */
+export async function withMirrorSource(func) {
+    const out = await UtilFunc.exec('npm config get registry');
+    const OriginSource = out.stdout.trim(); //?
+    SLogger.info(`正在修改npm源为 镜像源: ${MIRROR_SOURCE}`);
+    await UtilFunc.exec(`npm config set registry ${MIRROR_SOURCE}`);
+    await func();
+    SLogger.info(`正在修改npm源为 原始源: ${OriginSource}`);
+    await UtilFunc.exec(`npm config set registry ${OriginSource}`);
+}
+/**在官方源内镜像操作 */
+export async function withOfficialSource(func) {
+    const out = await UtilFunc.exec('npm config get registry');
+    const OriginSource = out.stdout.trim(); //?
+    SLogger.info(`正在修改npm源为 官方源: ${OFFICIAL_SOURCE}`);
+    await UtilFunc.exec(`npm config set registry ${OFFICIAL_SOURCE}`);
+    await func();
+    SLogger.info(`正在修改npm源为 原始源: ${OriginSource}`);
+    await UtilFunc.exec(`npm config set registry ${OriginSource}`);
+}
+/**检查目录是否为项目 */
+export async function checkProject() {
+    const filePath = path.join(PROJECT_PATH, "package.json");
+    if (!(await UtilFT.pathExists(filePath)))
+        throwError(`当前目录: ${PROJECT_PATH} 不是npm项目目录, 请先使用 npm init`);
+}

package/dist/mjs/Command/ScanDups.d.ts

@@ -0,0 +1,3 @@
+import { Command } from "commander";
+/**重命名文件或路径 scan_duplicates */
+export declare const CmdScanDups: (program: Command) => Command;

package/dist/mjs/Command/ScanDups.js

@@ -0,0 +1,43 @@
+import { SLogger, UtilFT } from "@zwa73/utils";
+import fs from "fs";
+import crypto from 'crypto';
+import path from "pathe";
+async function calculateHash(filePath) {
+    return new Promise((resolve, reject) => {
+        const hash = crypto.createHash('md5');
+        const stream = fs.createReadStream(filePath);
+        stream.on('data', (data) => hash.update(data));
+        stream.on('end', () => resolve(hash.digest('hex')));
+        stream.on('error', reject);
+    });
+}
+/**重命名文件或路径 scan_duplicates */
+export const CmdScanDups = (program) => program
+    .command("Scan-Dups")
+    .alias("scandups")
+    .description("扫描当前目录下hash重复的文件")
+    .option("-re, --regex <regex>", "文件的正则表达式, 使用posix路径", ".*")
+    .option("-o, --out <dir|console>", "输出的json文件路径, 默认 scandupsOut.json, 为 \"console\" 时无文件输出", "scandupsOut")
+    .option("-r, --recursive", "是否处理子目录, 默认 true", true)
+    .action(async (options) => {
+    const regex = new RegExp(options.regex);
+    const basePath = process.cwd();
+    const pList = (await UtilFT.fileSearchRegex(basePath, regex.source, {
+        relative: options.recursive,
+    })).map(async (filePath) => ({ filePath, hash: await calculateHash(filePath) }));
+    const hashMap = (await Promise.all(pList)).reduce((obj, cur) => {
+        obj[cur.hash] = (obj[cur.hash] ?? []).concat(cur.filePath);
+        return obj;
+    }, {});
+    const out = {};
+    for (const hash in hashMap) {
+        const duplicateFiles = hashMap[hash];
+        if (duplicateFiles.length <= 1)
+            continue;
+        out[hash] = duplicateFiles;
+    }
+    if (options.out === "console")
+        SLogger.info(out);
+    else
+        await UtilFT.writeJSONFile(path.join(basePath, options.out), out);
+});

package/dist/mjs/Command/index.d.ts

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

package/dist/mjs/Command/index.js

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

package/dist/mjs/Generator/Common.d.ts

@@ -0,0 +1,2 @@
+import Generator from "yeoman-generator";
+export declare const generatorBuilder: (templateName: string) => (new () => Generator);

package/dist/mjs/Generator/Common.js

@@ -0,0 +1,58 @@
+import { MIRROR_SOURCE, TEMPLATE_PATH } from "../Command/RouteInterface.js";
+import Generator from "yeoman-generator";
+import fs from 'fs';
+import path from 'pathe';
+import { UtilFT } from "@zwa73/utils";
+export const generatorBuilder = (templateName) => class extends Generator {
+    answers = {};
+    // 提示用户输入
+    async prompting() {
+        this.answers = await this.prompt([
+            {
+                type: "input",
+                name: "projectName",
+                message: "项目名称",
+                default: this.appname,
+            },
+            {
+                type: "input",
+                name: "projectDescription",
+                message: "项目描述",
+                default: "A new project",
+            },
+            {
+                type: "input",
+                name: "authorName",
+                message: "作者名",
+                default: "Your Name",
+            },
+        ]);
+    }
+    // 写入文件
+    writing() {
+        this.fs.copyTpl(this.templatePath(`${TEMPLATE_PATH}/${templateName}/package.json`), this.destinationPath(`${this.answers.projectName}/package.json`), this.answers);
+        this.fs.copyTpl(this.templatePath(`${TEMPLATE_PATH}/${templateName}/**/*`), this.destinationPath(this.answers.projectName), this.answers);
+    }
+    // 生成结束
+    async end() {
+        const dependencies = ['@zwa73/utils'];
+        const devDependencies = ['@types/node'];
+        await this.spawn('npm', ['install', ...dependencies, `--registry=${MIRROR_SOURCE}`], {
+            cwd: this.destinationPath(this.answers.projectName),
+            stdio: 'inherit'
+        });
+        await this.spawn('npm', ['install', ...devDependencies, `--registry=${MIRROR_SOURCE}`, '--save-dev'], {
+            cwd: this.destinationPath(this.answers.projectName),
+            stdio: 'inherit'
+        });
+        // 重命名 gitignore 文件为 .gitignore
+        const projectPath = this.destinationPath(this.answers.projectName);
+        const gitignorePath = path.join(projectPath, 'gitignore');
+        const dotGitignorePath = path.join(projectPath, '.gitignore');
+        if (await UtilFT.pathExists(gitignorePath)) {
+            fs.promises.rename(gitignorePath, dotGitignorePath);
+            this.log('gitignore 文件已重命名为 .gitignore');
+        }
+        this.log("All done!");
+    }
+};

package/dist/mjs/Generator/base/index.d.ts

@@ -0,0 +1,3 @@
+import Generator from "yeoman-generator";
+declare const _default: new () => Generator;
+export default _default;

package/dist/mjs/Generator/base/index.js

@@ -0,0 +1,2 @@
+import { generatorBuilder } from "../Common.js";
+export default generatorBuilder('base');

package/dist/mjs/Generator/electron/index.d.ts

@@ -0,0 +1,3 @@
+import Generator from "yeoman-generator";
+declare const _default: new () => Generator;
+export default _default;

package/dist/mjs/Generator/electron/index.js

@@ -0,0 +1,2 @@
+import { generatorBuilder } from "../Common.js";
+export default generatorBuilder('electron');

package/dist/mjs/Macro.macro.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/mjs/Macro.macro.js

@@ -0,0 +1,2 @@
+export {};
+//UtilMacro.exportComment('src/**/*.ts');

package/dist/mjs/QuickFunc.d.ts

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

package/dist/mjs/QuickFunc.js

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

package/dist/mjs/UtilAst.d.ts

@@ -0,0 +1,13 @@
+import { AnyFunc } from "@zwa73/utils";
+import { SyntaxKind, KindToNodeMappings, Node } from "ts-morph";
+export declare namespace UtilAst {
+    /**匹配Node的类型进行处理  无法匹配时返回undefined
+     * @param node    - ast节点
+     * @param funcMap - 处理函数映射表
+     */
+    function withKind<T extends Partial<{
+        [P in SyntaxKind]: ((n: KindToNodeMappings[P]) => unknown);
+    }>>(node: Node, funcMap: T): {
+        [P in keyof T]: T[P] extends AnyFunc ? ReturnType<T[P]> : never;
+    }[keyof T] | undefined;
+}

package/dist/mjs/UtilAst.js

@@ -0,0 +1,15 @@
+export var UtilAst;
+(function (UtilAst) {
+    /**匹配Node的类型进行处理  无法匹配时返回undefined
+     * @param node    - ast节点
+     * @param funcMap - 处理函数映射表
+     */
+    function withKind(node, funcMap) {
+        const kind = node.getKind();
+        const func = funcMap[kind];
+        if (func)
+            return func(node);
+        return undefined;
+    }
+    UtilAst.withKind = withKind;
+})(UtilAst || (UtilAst = {}));

package/dist/mjs/UtilDevTool.d.ts

@@ -0,0 +1,99 @@
+import { JObject } from '@zwa73/utils';
+export declare namespace UtilDT {
+    /**执行js/ts的可选项 */
+    type BatchNodeOpt = Partial<{
+        /**tsconfig路径 */
+        project: string;
+    }>;
+    /**build任意ts文件的可选项 */
+    type BuildMatchOpt = Partial<{
+        /**包含的glob */
+        include: string | string[];
+        /**忽略的glob */
+        exclude: string | string[];
+    }> & BatchNodeOpt;
+    /**build schema的可选项 */
+    type BuildSchemaOpt = Partial<{
+        /**将会覆盖 definitions 对应内容的表 */
+        coverDefine: JObject;
+        /**schema输出路径目录 如 ./schema/ */
+        outDir: string;
+        /**包含的types正则匹配数组 默认 [/.*\/] */
+        includeTypes?: string[];
+        /**排除的types正则匹配数组 */
+        excludeTypes?: string[];
+    }> & BuildMatchOpt;
+    /**生成匹配的文件的所有type的schema
+     * @async
+     * @param dir         - 基础目录
+     * @param opt         - 可选参数
+     * @param opt.include      - 包含的glob 默认 **\/\*.schema.ts
+     * @param opt.exclude      - 忽略的glob
+     * @param opt.coverDefine  - 将会覆盖 definitions 对应内容的表
+     * @param opt.project      - tsconfig路径
+     * @param opt.outDir       - schema输出路径目录 默认 ./schema/
+     * @param opt.includeTypes - 包含的types正则匹配数组 默认 [/.*\/]
+     * @param opt.excludeTypes - 排除的types正则匹配数组
+     */
+    export function generateSchema(dir: string, opt?: BuildSchemaOpt): Promise<void>;
+    /**运行所有匹配的的js/ts文件
+     * @async
+     * @param dir         - 基础目录
+     * @param opt         - 可选参数
+     * @param opt.include     - 包含的glob 默认 index.ts
+     * @param opt.exclude     - 忽略的glob
+     * @param opt.project     - tsconfig路径
+     */
+    export function matchNode(dir: string, opt?: BuildMatchOpt): Promise<void>;
+    /**运行所有js/ts文件
+     * @async
+     * @param filepath - 需要运行的文件
+     * @param opt      - 可选参数
+     * @param opt.project     - tsconfig路径
+     */
+    export function batchNode(filepath: string | string[], opt?: BatchNodeOpt): Promise<void>;
+    /**宏的可选参数 */
+    type MacroOpt = Partial<{
+        /**宏展开的目标文件 */
+        filePath: string[] | string;
+        /**使用glob匹配而非文件路径 */
+        glob: boolean;
+    }>;
+    /**codeText的参数 */
+    type CodeTextOpt = {
+        /**匹配的region/comment id */
+        matchId: string;
+        /**region/comment id正则的执行结果*/
+        execArr: RegExpExecArray;
+        /**展开宏的目标文件 */
+        filePath: string;
+        /**展开宏区域的原文本 */
+        text: string;
+        /**缩进 会自动应用 */
+        inent: string;
+    };
+    /**将codeText写入对应region
+     * @param regionId   - 区域id \`//#region ${id}\`
+     * @param codeText   - 文本
+     * @param opt        - 可选参数
+     * @param opt.filePath - 目标文件 默认为去除".macro"的同名文件
+     * @param opt.glob     - 使用glob匹配而非文件路径
+     */
+    export function regionMacro(regionId: string | RegExp, codeText: string | ((opt: CodeTextOpt) => 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 | RegExp, codeText: string | ((opt: CodeTextOpt) => 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 | ((opt: Omit<CodeTextOpt, 'ident' | 'matchId' | 'execArr'>) => string | Promise<string>), opt?: MacroOpt): Promise<void>;
+    export {};
+}