@ybgnb/file-naming 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 hzhilong
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,3 @@
+# @ybgnb/file-naming
+
+文件命名模板解析器

package/dist/index.d.ts

@@ -0,0 +1,185 @@
+/**
+ * 日期格式映射（键：dayjs格式，值：示例）
+ */
+declare const dateFormatMap: {
+    readonly 'YYYY-MM-DD': "2026-07-02";
+    readonly YYYY_MM_DD: "2026_07_02";
+    readonly YYYYMMDD: "20260702";
+    readonly 'YY-MM-DD': "26-07-02";
+    readonly YY_MM_DD: "26_07_02";
+    readonly YYMMDD: "260702";
+};
+/**
+ * 日期格式
+ */
+type DateFormat = keyof typeof dateFormatMap;
+/**
+ * 时间格式映射（键：dayjs格式，值：示例）
+ */
+declare const timeFormatMap: {
+    readonly HHmmss: "143045";
+    readonly 'HH-mm-ss': "14-30-45";
+    readonly HH_mm_ss: "14_30_45";
+    readonly HHmm: "1430";
+    readonly 'HH-mm': "14-30";
+    readonly HH_mm: "14_30";
+};
+/**
+ * 时间格式
+ */
+type TimeFormat = keyof typeof timeFormatMap;
+/**
+ * 序号格式映射
+ */
+declare const serialNumberFormatMap: {
+    readonly natural: "自然数";
+    readonly zeroPad: "前导零填充";
+};
+/**
+ * 序号格式
+ */
+type SerialNumberFormat = keyof typeof serialNumberFormatMap;
+/**
+ * 扩展的格式
+ */
+interface ExtendedFormats {
+    dateFormat: DateFormat;
+    timeFormat: TimeFormat;
+    serialNumberFormat: SerialNumberFormat;
+}
+
+/**
+ * 文件命名上下文
+ */
+interface FileNamingContext<TData = unknown> {
+    /**
+     * 序号，单个文件解析时为1
+     */
+    serialNumber: number;
+    /**
+     * 总数，单个文件解析时为1
+     */
+    total: number;
+    /**
+     * 解析日期
+     */
+    resolveDate: Date;
+    /**
+     * 扩展的格式
+     */
+    extendedFormats: ExtendedFormats;
+    /**
+     * 解析的数据
+     */
+    data: TData;
+}
+
+/**
+ * 文件命名字段定义
+ */
+interface FileNamingFieldDefinition<TData = unknown> {
+    label: string;
+    resolve: (context: FileNamingContext<TData>) => string;
+}
+/**
+ * 文件命名字段映射
+ */
+declare const baseFileNamingFieldMap: {
+    readonly "-": FileNamingFieldDefinition<unknown>;
+    readonly _: FileNamingFieldDefinition<unknown>;
+    readonly ".": FileNamingFieldDefinition<unknown>;
+    readonly ",": FileNamingFieldDefinition<unknown>;
+    readonly ";": FileNamingFieldDefinition<unknown>;
+    readonly "\uFF08": FileNamingFieldDefinition<unknown>;
+    readonly "\uFF09": FileNamingFieldDefinition<unknown>;
+    readonly "(": FileNamingFieldDefinition<unknown>;
+    readonly ")": FileNamingFieldDefinition<unknown>;
+    readonly "[": FileNamingFieldDefinition<unknown>;
+    readonly "]": FileNamingFieldDefinition<unknown>;
+    readonly "{": FileNamingFieldDefinition<unknown>;
+    readonly "}": FileNamingFieldDefinition<unknown>;
+    readonly "+": FileNamingFieldDefinition<unknown>;
+    readonly "=": FileNamingFieldDefinition<unknown>;
+    readonly "~": FileNamingFieldDefinition<unknown>;
+    readonly "!": FileNamingFieldDefinition<unknown>;
+    readonly "@": FileNamingFieldDefinition<unknown>;
+    readonly "#": FileNamingFieldDefinition<unknown>;
+    readonly $: FileNamingFieldDefinition<unknown>;
+    readonly "%": FileNamingFieldDefinition<unknown>;
+    readonly "^": FileNamingFieldDefinition<unknown>;
+    readonly "&": FileNamingFieldDefinition<unknown>;
+    readonly "\u201C": FileNamingFieldDefinition<unknown>;
+    readonly "\u201D": FileNamingFieldDefinition<unknown>;
+    readonly "\uFF1A": FileNamingFieldDefinition<unknown>;
+    readonly serialNumber: {
+        readonly label: "序号";
+        readonly resolve: ({ total, serialNumber, extendedFormats }: FileNamingContext<unknown>) => string;
+    };
+    readonly total: {
+        readonly label: "总数";
+        readonly resolve: ({ total }: FileNamingContext<unknown>) => string;
+    };
+    readonly space: {
+        readonly label: "空格";
+        readonly resolve: () => string;
+    };
+    readonly fileSeparator: {
+        readonly label: "/";
+        readonly resolve: () => string;
+    };
+};
+/**
+ * 基础文件命名字段
+ */
+type BaseFileNamingField = keyof typeof baseFileNamingFieldMap;
+/**
+ * 所有的基础文件命名字段
+ */
+declare const allBaseFileNamingFields: BaseFileNamingField[];
+
+/**
+ * 文件命名策略
+ */
+interface FileNamingStrategy<TData = unknown> {
+    fields: (FileNamingFieldDefinition<TData> | BaseFileNamingField)[];
+    extendedFormats: ExtendedFormats;
+}
+
+/**
+ * 解析文件路径的结果
+ */
+interface ResolveFilePathResult {
+    /**
+     * 相对路径
+     */
+    relativePath: string;
+    /**
+     * 路径片段（按路径分隔符拆分后的各级目录/文件名，不对应命名字段）
+     */
+    segments: string[];
+}
+
+/**
+ * 路径片段转换器
+ */
+type PathSegmentTransformer = (segment: string) => string;
+
+declare class FileNamer<TData = unknown> {
+    private strategy;
+    private pathSegmentTransformer;
+    constructor(options: Omit<FileNamingStrategy<TData>, 'extendedFormats'> & {
+        extendedFormats?: Partial<ExtendedFormats>;
+        pathSegmentTransformer?: PathSegmentTransformer;
+    });
+    private buildPathSegments;
+    private resolveOne;
+    resolve(data: TData): ResolveFilePathResult;
+    resolve(data: TData[]): ResolveFilePathResult[];
+}
+
+declare const createCharNamingField: <KEY extends string>(char: KEY, label?: string) => { [k in KEY]: FileNamingFieldDefinition; };
+declare const createCharNamingFields: <const CHARS extends readonly string[]>(chars: CHARS) => { [K in CHARS[number]]: FileNamingFieldDefinition; };
+
+declare function defaultSanitizePathSegment(segment: string): string;
+
+export { type BaseFileNamingField, type DateFormat, type ExtendedFormats, FileNamer, type FileNamingContext, type FileNamingFieldDefinition, type FileNamingStrategy, type PathSegmentTransformer, type ResolveFilePathResult, type SerialNumberFormat, type TimeFormat, allBaseFileNamingFields, baseFileNamingFieldMap, createCharNamingField, createCharNamingFields, dateFormatMap, defaultSanitizePathSegment, serialNumberFormatMap, timeFormatMap };

package/dist/index.js

@@ -0,0 +1 @@
+var F=(t,e)=>({[t]:{label:e??t,resolve:()=>t}}),m=t=>Object.assign({},...t.map(e=>F(e)));var i={serialNumber:{label:"\u5E8F\u53F7",resolve:({total:t,serialNumber:e,extendedFormats:r})=>r.serialNumberFormat==="natural"?String(e):String(e).padStart(String(t).length,"0")},total:{label:"\u603B\u6570",resolve:({total:t})=>String(t)},space:{label:"\u7A7A\u683C",resolve:()=>" "},fileSeparator:{label:"/",resolve:()=>"/"},...m(["-","_",".",",",";","\uFF08","\uFF09","(",")","[","]","{","}","+","=","~","!","@","#","$","%","^","&","\u201C","\u201D","\uFF1A"])},x=Object.keys(i);var f=/[<>:"/\\|?*\u0000-\u001F]/g,g=new Set(["CON","PRN","AUX","NUL","COM1","COM2","COM3","COM4","COM5","COM6","COM7","COM8","COM9","LPT1","LPT2","LPT3","LPT4","LPT5","LPT6","LPT7","LPT8","LPT9"]);function l(t){let e=t.trim();return e=e.replace(f,"_"),e=e.replace(/[. ]+$/,""),e.length===0?"":(g.has(e.toUpperCase())&&(e=`_${e}`),e)}var p=class{constructor(e){let{dateFormat:r,timeFormat:a,serialNumberFormat:o}=e.extendedFormats??{};this.strategy={fields:e.fields,extendedFormats:{dateFormat:r??"YYYY-MM-DD",timeFormat:a??"HH-mm-ss",serialNumberFormat:o??"zeroPad"}},this.pathSegmentTransformer=e.pathSegmentTransformer??l}buildPathSegments(e){let r=[],a="";for(let o of e){if(o==="/"){a&&(r.push(a),a="");continue}a+=o}return a&&r.push(a),r}resolveOne(e){let r={total:1,serialNumber:1,extendedFormats:this.strategy.extendedFormats,resolveDate:new Date,data:e},a=this.strategy.fields.map(s=>typeof s=="string"?i[s]?i[s].resolve(r):"":s.resolve(r)),n=this.buildPathSegments(a).filter(Boolean).map(this.pathSegmentTransformer);return{segments:n,relativePath:n.join("/")}}resolve(e){return Array.isArray(e)?e.map(r=>this.resolveOne(r)):this.resolveOne(e)}};var M={"YYYY-MM-DD":"2026-07-02",YYYY_MM_DD:"2026_07_02",YYYYMMDD:"20260702","YY-MM-DD":"26-07-02",YY_MM_DD:"26_07_02",YYMMDD:"260702"},S={HHmmss:"143045","HH-mm-ss":"14-30-45",HH_mm_ss:"14_30_45",HHmm:"1430","HH-mm":"14-30",HH_mm:"14_30"},T={natural:"\u81EA\u7136\u6570",zeroPad:"\u524D\u5BFC\u96F6\u586B\u5145"};export{p as FileNamer,x as allBaseFileNamingFields,i as baseFileNamingFieldMap,F as createCharNamingField,m as createCharNamingFields,M as dateFormatMap,l as defaultSanitizePathSegment,T as serialNumberFormatMap,S as timeFormatMap};

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "@ybgnb/file-naming",
+  "version": "0.0.1",
+  "author": "hzhilong",
+  "private": false,
+  "description": "文件命名模板解析器",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "check": "tsc --build --noEmit && eslint .",
+    "lint": "eslint . --fix",
+    "format": "prettier --write .",
+    "barrelsby": "barrelsby -c barrelsby.json & import-suffixer \"src/**/*.ts\"",
+    "build": "tsup",
+    "npm login": "npm login",
+    "npm publish": "npm publish --access public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/hzhilong/ybgnb-js",
+    "directory": "file-naming"
+  },
+  "keywords": [
+    "ybgnb"
+  ],
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/hzhilong/ybgnb-js/issues"
+  },
+  "homepage": "https://github.com/hzhilong/ybgnb-js/tree/main/file-naming#readme",
+  "dependencies": {
+    "@ybgnb/utils": "^0.3.1"
+  },
+  "devDependencies": {
+    "@types/node": "^25.6.0",
+    "barrelsby": "^2.8.1",
+    "eslint": "^9.39.4",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-n": "^18.0.1",
+    "import-suffixer": "^0.0.1",
+    "jiti": "^2.7.0",
+    "prettier": "^3.8.1",
+    "tsup": "^8.5.1",
+    "typescript": "^6.0.2",
+    "typescript-eslint": "^8.58.0"
+  }
+}