excel-csv-handler 1.0.11 → 1.1.0

package/package.json

@@ -1,31 +1,31 @@
 {
-  "name": "excel-csv-handler",
-  "version": "1.0.11",
-  "description": "A Node.js utility to read/write Excel and CSV files with GBK encoding support",
-  "main": "src/index.js",
-  "types": "src/excel-csv-handler.d.ts",
-  "type": "module",
-  "files": [
-    "src/",
-    "README.md"
-  ],
-  "keywords": [
-    "excel",
-    "csv",
-    "xlsx",
-    "gbk",
-    "node",
-    "file"
-  ],
-  "author": "Chao_bei",
-  "license": "MIT",
-  "dependencies": {
-    "chardet": "^2.1.1",
-    "fast-csv": "^5.0.5",
-    "iconv-lite": "^0.7.0",
-    "xlsx": "^0.18.5"
-  },
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  }
-}
+	"name": "excel-csv-handler",
+	"version": "1.1.0",
+	"description": "A Node.js utility to read/write Excel and CSV files with GBK encoding support",
+	"main": "src/index.js",
+	"types": "src/excel-csv-handler.d.ts",
+	"type": "module",
+	"files": [
+		"src/",
+		"README.md"
+	],
+	"scripts": {
+		"test": "echo \"Error: no test specified\" && exit 1"
+	},
+	"keywords": [
+		"excel",
+		"csv",
+		"xlsx",
+		"gbk",
+		"node",
+		"file"
+	],
+	"author": "Chao_bei",
+	"license": "MIT",
+	"dependencies": {
+		"chardet": "^2.1.1",
+		"fast-csv": "^5.0.5",
+		"iconv-lite": "^0.7.0",
+		"xlsx": "^0.18.5"
+	}
+}

package/src/excel-csv-handler.d.ts

@@ -44,4 +44,19 @@ export default class ExcelCsvHandler {
 		headers?: string[] | null,
 		encoding?: string
 	): Promise<void>;
+
+	/**
+	 * 从调用文件的相对路径获取绝对路径
+	 * @param importMetaUrl - 调用文件的 import.meta.url
+	 * @param relativePath - 相对路径（如 './dataset/file.docx' 或 'dataset/file.docx'）
+	 * @returns 绝对路径
+	 * 
+	 * @example
+	 * ```ts
+	 * import ExcelCsvHandler from 'excel-csv-handler';
+	 * const docxPath = ExcelCsvHandler.getAbsolutePath(import.meta.url, './dataset/sci-high-question.docx');
+	 * const csvPath = ExcelCsvHandler.getAbsolutePath(import.meta.url, 'data/output.csv');
+	 * ```
+	 */
+	static getAbsolutePath(importMetaUrl: string, relativePath: string): string;
 }

package/src/index.js

@@ -1,5 +1,6 @@
 // excel-csv-handler.js
 import { createRequire } from 'module';
+import { fileURLToPath } from 'url';
 
 import * as fs from 'fs';
 import * as path from 'path';
@@ -18,33 +19,33 @@ class ExcelCsvHandler {
     detectEncoding(filePath) {
         // 读取文件的前几个字节来检测编码
         const buffer = fs.readFileSync(filePath);
-        
+
         // 检查 UTF-8 BOM
-        if (buffer.length >= 3 && 
-            buffer[0] === 0xEF && 
-            buffer[1] === 0xBB && 
+        if (buffer.length >= 3 &&
+            buffer[0] === 0xEF &&
+            buffer[1] === 0xBB &&
             buffer[2] === 0xBF) {
             return 'utf8';
         }
-        
+
         // 使用 chardet 库检测编码
         const detected = chardet.detect(buffer);
-        
+
         // 将检测结果映射到 iconv-lite 支持的编码名称
         if (detected) {
             const encoding = detected.toLowerCase();
-            
+
             // GB2312, GBK, GB18030 都映射为 gbk
             if (encoding.includes('gb') || encoding.includes('gbk')) {
                 return 'gbk';
             }
-            
+
             // UTF-8 相关
             if (encoding.includes('utf-8') || encoding.includes('utf8')) {
                 return 'utf8';
             }
         }
-        
+
         // 默认返回 gbk（考虑到中国用户常用 GBK）
         return 'gbk';
     }
@@ -138,7 +139,7 @@ class ExcelCsvHandler {
     async #readCsvFile(filePath, headerRow) {
         // 自动检测编码
         const encoding = this.detectEncoding(filePath);
-        
+
         return new Promise((resolve, reject) => {
             const allRows = [];
             const stream = fs.createReadStream(filePath)
@@ -195,7 +196,7 @@ class ExcelCsvHandler {
         });
 
         const buffer = iconv.encode(csvString, encoding);
-        
+
         // 如果是 UTF-8，添加 BOM 标记以确保 Excel 正确识别
         if (encoding === 'utf8') {
             const bom = Buffer.from([0xEF, 0xBB, 0xBF]);
@@ -227,7 +228,7 @@ class ExcelCsvHandler {
             await this.#writeCsvFile(filePath, data, headers, encoding);
             return;
         }
-        
+
         // 文件存在时，检测现有文件的编码
         const detectedEncoding = this.detectEncoding(filePath);
 
@@ -256,6 +257,26 @@ class ExcelCsvHandler {
     }
 }
 
+/**
+ * 从调用文件的相对路径获取绝对路径
+ * @param {string} importMetaUrl - 调用文件的 import.meta.url
+ * @param {string} relativePath - 相对路径（如 './dataset/file.docx' 或 'dataset/file.docx'）
+ * @returns {string} 绝对路径
+ * 
+ * @example
+ * // 在你的文件中使用
+ * import ExcelCsvHandler from 'excel-csv-handler';
+ * const docxPath = ExcelCsvHandler.getAbsolutePath(import.meta.url, './dataset/sci-high-question.docx');
+ * const csvPath = ExcelCsvHandler.getAbsolutePath(import.meta.url, 'data/output.csv');
+ */
+ExcelCsvHandler.getAbsolutePath = function (importMetaUrl, relativePath) {
+    const __filename = fileURLToPath(importMetaUrl);
+    const __dirname = path.dirname(__filename);
+    // 去除开头的 './' 如果存在
+    const cleanPath = relativePath.startsWith('./') ? relativePath.slice(2) : relativePath;
+    return path.join(__dirname, cleanPath);
+};
+
 export default ExcelCsvHandler;
 
 // 示例用法（取消注释可测试）