excel-csv-handler 1.0.0

package/README.md

@@ -0,0 +1,20 @@
+# excel-csv-handler
+
+A simple Node.js library to read and write Excel (`.xlsx`, `.xls`) and CSV files, with built-in GBK encoding support for Chinese users.
+
+## Install
+
+```bash
+npm install excel-csv-handler
+```
+
+## Usage
+
+```javascript
+import ExcelCsvHandler from 'excel-csv-handler';
+
+const handler = new ExcelCsvHandler();
+await handler.write('output.csv', [{ name: '张三', age: 25 }]);
+const data = await handler.read('output.csv');
+console.log(data);
+```

package/index.js

@@ -0,0 +1,172 @@
+// excel-csv-handler.js
+import * as XLSX from 'xlsx';
+import * as fs from 'fs';
+import * as path from 'path';
+import iconv from 'iconv-lite';
+import * as csv from 'fast-csv';
+import { writeToString } from 'fast-csv';
+
+class ExcelCsvHandler {
+    /**
+     * 读取 Excel 或 CSV 文件（支持 GBK 编码）
+     * @param {string} filePath - 文件路径
+     * @param {number} headerRow - 标题行索引（从 0 开始）
+     * @returns {Promise<Array<Object>>}
+     */
+    async read(filePath, headerRow = 0) {
+        const ext = path.extname(filePath).toLowerCase();
+
+        if (ext === '.xlsx' || ext === '.xls') {
+            return this.readExcelFile(filePath, headerRow);
+        } else if (ext === '.csv') {
+            return this.readCsvFile(filePath, headerRow);
+        } else {
+            throw new Error(`不支持的文件格式: ${ext}`);
+        }
+    }
+
+    /**
+     * 写入 Excel 或 CSV 文件（以 GBK 编码保存 CSV，Excel 保持默认）
+     * @param {string} filePath - 文件路径
+     * @param {Array<Object>} data - 要写入的数据
+     * @param {Array<string>} headers - 可选列顺序
+     */
+    async write(filePath, data, headers = null) {
+        const ext = path.extname(filePath).toLowerCase();
+
+        if (ext === '.xlsx' || ext === '.xls') {
+            this.writeExcelFile(filePath, data, headers);
+        } else if (ext === '.csv') {
+            await this.writeCsvFile(filePath, data, headers);
+        } else {
+            throw new Error(`不支持的文件格式: ${ext}`);
+        }
+    }
+
+    // ========= Excel 读写 =========
+
+    readExcelFile(filePath, headerRow) {
+        const workbook = XLSX.readFile(filePath);
+        const sheetName = workbook.SheetNames[0];
+        const worksheet = workbook.Sheets[sheetName];
+
+        // 读取原始行（数组形式）
+        const range = XLSX.utils.decode_range(worksheet['!ref'] || 'A1');
+        const rows = [];
+        for (let R = range.s.r; R <= range.e.r; ++R) {
+            const row = [];
+            for (let C = range.s.c; C <= range.e.c; ++C) {
+                const cellAddress = XLSX.utils.encode_cell({ r: R, c: C });
+                const cell = worksheet[cellAddress];
+                row.push(cell ? cell.v : '');
+            }
+            rows.push(row);
+        }
+
+        if (rows.length <= headerRow) return [];
+
+        const headers = rows[headerRow].map(String);
+        const dataRows = rows.slice(headerRow + 1);
+
+        return dataRows.map(row => {
+            const obj = {};
+            headers.forEach((key, idx) => {
+                obj[key] = idx < row.length ? String(row[idx] ?? '') : '';
+            });
+            return obj;
+        });
+    }
+
+    writeExcelFile(filePath, data, headers = null) {
+        if (!headers && data.length > 0) {
+            headers = Object.keys(data[0]);
+        } else if (!headers) {
+            headers = [];
+        }
+
+        const wsData = [headers, ...data.map(row => headers.map(h => row[h] ?? ''))];
+        const worksheet = XLSX.utils.aoa_to_sheet(wsData);
+        const workbook = XLSX.utils.book_new();
+        XLSX.utils.book_append_sheet(workbook, worksheet, 'Sheet1');
+        XLSX.writeFile(workbook, filePath);
+    }
+
+    // ========= CSV 读写 =========
+
+    async readCsvFile(filePath, headerRow) {
+        return new Promise((resolve, reject) => {
+            const allRows = [];
+            const stream = fs.createReadStream(filePath)
+                .pipe(iconv.decodeStream('gbk'))
+                .pipe(csv.parse({ headers: false, skipLines: headerRow }));
+
+            stream.on('data', row => {
+                allRows.push(row);
+            });
+
+            stream.on('end', () => {
+                if (allRows.length === 0) {
+                    resolve([]);
+                    return;
+                }
+
+                // 第一行作为 headers
+                const headers = allRows[0].map(h => String(h ?? ''));
+                const dataRows = allRows.slice(1);
+
+                const result = dataRows.map(row => {
+                    const obj = {};
+                    headers.forEach((key, idx) => {
+                        obj[key] = idx < row.length ? String(row[idx] ?? '') : '';
+                    });
+                    return obj;
+                });
+
+                resolve(result);
+            });
+
+            stream.on('error', reject);
+        });
+    }
+
+    async writeCsvFile(filePath, data, headers = null) {
+        if (!headers && data.length > 0) {
+            headers = Object.keys(data[0]);
+        } else if (!headers) {
+            headers = [];
+        }
+
+        const csvString = await writeToString(data, {
+            headers,
+            includeEndRowDelimiter: true,
+            rowDelimiter: '\r\n',
+        });
+
+        const gbkBuffer = iconv.encode(csvString, 'gbk');
+        fs.writeFileSync(filePath, gbkBuffer);
+    }
+}
+
+export default ExcelCsvHandler;
+
+// 示例用法（取消注释可测试）
+
+// (async () => {
+//     const handler = new ExcelCsvHandler();
+
+//     // 写回文件（自动用 GBK 编码）
+//     await handler.write('./output/result.csv', [
+//         { name: 'John Doe', age: 30 },
+//         { name: 'Jane Doe', age: 25 },
+//     ]);
+
+//     // 或写入 Excel
+//     await handler.write('./output/result.xlsx', [
+//         { name: 'John Doe', age: 30 },
+//         { name: 'Jane Doe', age: 25 },
+//     ]);
+
+//     // 读取文件（假设标题在第 1 行，即索引 0）
+//     const data = await handler.read('./output/result.csv', 0);
+//     console.log(data);
+// })();

package/package.json

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