@bluelovers/fs-json 1.0.14 → 1.0.16

package/CHANGELOG.md

@@ -3,6 +3,34 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [1.0.16](https://github.com/bluelovers/ws-iconv/compare/@bluelovers/fs-json@1.0.15...@bluelovers/fs-json@1.0.16) (2026-03-01)
+
+**Note:** Version bump only for package @bluelovers/fs-json
+
+
+
+
+
+## [1.0.15](https://github.com/bluelovers/ws-iconv/compare/@bluelovers/fs-json@1.0.14...@bluelovers/fs-json@1.0.15) (2026-03-01)
+
+
+
+### 📚　Documentation
+
+* 为多个包添加全面的 JSDoc 文档和 README 更新 ([0d149e8](https://github.com/bluelovers/ws-iconv/commit/0d149e856aa9b274aca7fd7562776860c9d00473))
+
+
+### 🚨　Tests
+
+* **snap:** 更新跨套件測試快照並新增執行配置 ([06ad833](https://github.com/bluelovers/ws-iconv/commit/06ad833b318697003d731cc307205b9a70b1e094))
+
+
+### ♻️　Chores
+
+* Update jest config and add new files for testing ([f370583](https://github.com/bluelovers/ws-iconv/commit/f37058385c7bf24d3d0bc975c752f2f35cfe8356))
+
+
+
 ## [1.0.14](https://github.com/bluelovers/ws-iconv/compare/@bluelovers/fs-json@1.0.13...@bluelovers/fs-json@1.0.14) (2024-08-29)
 
 

package/README.md

@@ -1,12 +1,90 @@
-# README.md
+# @bluelovers/fs-json
 
-    
+Enhanced JSON file operations with final EOL (End of Line) support.
+增強型 JSON 檔案操作，支援結尾換行符號（EOL）。
 
-## install
+## Features / 功能
+
+- Read and write JSON files / 讀寫 JSON 檔案
+- Output JSON with auto directory creation / 輸出 JSON 並自動創建目錄
+- Stringify JSON with final EOL option / 字串化 JSON 並支援結尾換行選項
+- Parse JSON from string or Uint8Array / 從字串或 Uint8Array 解析 JSON
+- Based on fs-extra and jsonfile / 基於 fs-extra 和 jsonfile
+
+## Install / 安裝
 
 ```bash
 yarn add @bluelovers/fs-json
 yarn-tool add @bluelovers/fs-json
 yt add @bluelovers/fs-json
+pnpm add @bluelovers/fs-json
+npm install @bluelovers/fs-json
+```
+
+## Quick Start / 快速開始
+
+```typescript
+import {
+  readJSON,
+  readJSONSync,
+  writeJSON,
+  writeJSONSync,
+  outputJSON,
+  outputJSONSync,
+  stringifyJSON,
+  parseJSON
+} from '@bluelovers/fs-json';
+
+// Read JSON / 讀取 JSON
+const data = await readJSON('config.json');
+const dataSync = readJSONSync('config.json');
+
+// Write JSON / 寫入 JSON
+await writeJSON('output.json', { key: 'value' });
+writeJSONSync('output.json', { key: 'value' });
+
+// Output JSON (creates directory if needed) / 輸出 JSON（必要時創建目錄）
+await outputJSON('path/to/file.json', { key: 'value' });
+outputJSONSync('path/to/file.json', { key: 'value' });
+
+// Stringify with final EOL / 字串化並添加結尾換行
+const jsonString = stringifyJSON({ key: 'value' });
+console.log(jsonString); // '{"key":"value"}\n'
+
+// Parse JSON / 解析 JSON
+const obj = parseJSON('{"key":"value"}');
+const objFromUint8 = parseJSON(new Uint8Array([123, 34, 107, 101, 121, 34, 58, 34, 118, 97, 108, 117, 101, 34, 125]));
+```
+
+## API
+
+### `readJSON(file, options?)` / `readJSONSync(file, options?)`
+Reads a JSON file asynchronously or synchronously.
+異步或同步讀取 JSON 檔案。
+
+### `writeJSON(file, data, options?)` / `writeJSONSync(file, data, options?)`
+Writes a JSON file asynchronously or synchronously.
+異步或同步寫入 JSON 檔案。
+
+### `outputJSON(file, data, options?)` / `outputJSONSync(file, data, options?)`
+Writes a JSON file, creating the directory if it doesn't exist.
+寫入 JSON 檔案，如果目錄不存在則自動創建。
+
+### `stringifyJSON(data, options?)`
+Stringifies data to JSON with final EOL support.
+將資料字串化為 JSON，支援結尾換行。
+
+### `parseJSON(stringOrUint8Array, reviver?)`
+Parses JSON from string or Uint8Array.
+從字串或 Uint8Array 解析 JSON。
+
+### Options / 選項
+
+```typescript
+interface IWriteOptions {
+  finalEOL?: boolean;  // Add final newline (default: true) / 添加結尾換行（預設：true）
+  spaces?: string | number;  // Indentation / 縮排
+  // ... other fs-extra/jsonfile options
+}
 ```
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@bluelovers/fs-json",
-  "version": "1.0.14",
-  "description": "stringify with final EOL",
+  "version": "1.0.16",
+  "description": "Enhanced JSON file operations with final EOL support / 增強型 JSON 檔案操作，支援結尾換行符號",
   "keywords": [
     "create-by-yarn-tool"
   ],
@@ -22,6 +22,7 @@
     "lint": "ynpx --quiet eslint -- **/*.ts",
     "test": "jest --passWithNoTests",
     "test:jest": "jest --passWithNoTests",
+    "test:jest:coverage": "yarn run test:jest -- --coverage",
     "test:jest:snapshot": "yarn run test:jest -- -u",
     "test:mocha": "ynpx --quiet -p ts-node -p mocha mocha -- --require ts-node/register \"!(node_modules)/**/*.{test,spec}.{ts,tsx}\"",
     "test:snapshot": "yarn run test -- -u",
@@ -51,9 +52,8 @@
     "jsonfile": "^6.1.0",
     "tslib": "^2"
   },
-  "packageManager": "yarn@^1.22.11",
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "43bcf89adcf481e321b509f7510de10206e8030a"
+  "gitHead": "6bcfe6a585ad7e5657a40a5b0727c6281b564b60"
 }

package/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":";;;AAsBA,kDAKC;AAOD,gCAIC;AAED,wCAIC;AAED,8BAIC;AAED,sCAIC;AAED,sCAIC;AAED,8BAKC;AArED,uCAQkB;AAsBjB,yFA3BA,mBAAQ,OA2BA;AACR,6FA3BA,uBAAY,OA2BA;AAtBb,0CAA2C;AAa3C,SAAgB,mBAAmB,CAAC,OAAuB;;IAE1D,OAAO,aAAP,OAAO,cAAP,OAAO,IAAP,OAAO,GAAK,EAAE,EAAC;IACf,MAAA,OAAO,CAAC,QAAQ,oCAAhB,OAAO,CAAC,QAAQ,GAAK,IAAI,EAAC;IAC1B,OAAO,OAAO,CAAA;AACf,CAAC;AAOD,SAAgB,UAAU,CAAC,IAAY,EAAE,IAAS,EAAE,OAAuB;IAE1E,OAAO,GAAG,mBAAmB,CAAC,OAAO,CAAC,CAAC;IACvC,OAAO,IAAA,qBAAW,EAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAA;AACxC,CAAC;AAED,SAAgB,cAAc,CAAC,IAAY,EAAE,IAAS,EAAE,OAAuB;IAE9E,OAAO,GAAG,mBAAmB,CAAC,OAAO,CAAC,CAAC;IACvC,OAAO,IAAA,yBAAe,EAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAA;AAC5C,CAAC;AAED,SAAgB,SAAS,CAAC,IAAY,EAAE,IAAS,EAAE,OAAuB;IAEzE,OAAO,GAAG,mBAAmB,CAAC,OAAO,CAAC,CAAC;IACvC,OAAO,IAAA,oBAAU,EAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAA;AACvC,CAAC;AAED,SAAgB,aAAa,CAAC,IAAY,EAAE,IAAS,EAAE,OAAuB;IAE7E,OAAO,GAAG,mBAAmB,CAAC,OAAO,CAAC,CAAC;IACvC,OAAO,IAAA,wBAAc,EAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAA;AAC3C,CAAC;AAED,SAAgB,aAAa,CAAC,IAAS,EAAE,OAAuB;IAE/D,OAAO,GAAG,mBAAmB,CAAC,OAAO,CAAC,CAAC;IACvC,OAAO,IAAA,iBAAS,EAAC,IAAI,EAAE,OAAc,CAAC,CAAA;AACvC,CAAC;AAED,SAAgB,SAAS,CAAC,kBAAuC,EAChE,OAAqD;IAGrD,OAAO,IAAI,CAAC,KAAK,CAAC,kBAAkB,CAAC,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAA;AAC1D,CAAC","sourcesContent":["import {\n\toutputJSON as _outputJSON,\n\toutputJSONSync as _outputJSONSync,\n\treadJSON,\n\treadJSONSync,\n\twriteJSON as _writeJSON,\n\twriteJSONSync as _writeJSONSync,\n\tWriteOptions,\n} from 'fs-extra';\nimport { stringify } from 'jsonfile/utils';\nimport { JFWriteOptions } from 'jsonfile';\n\ndeclare module 'fs-extra'\n{\n\tinterface WriteOptions extends Exclude<JFWriteOptions, string | null>\n\t{\n\t\tfinalEOL?: boolean\n\t}\n}\n\nexport type IWriteOptions = WriteOptions & Exclude<JFWriteOptions, string | null>;\n\nexport function _handleWriteOptions(options?: IWriteOptions): IWriteOptions\n{\n\toptions ??= {};\n\toptions.finalEOL ??= true;\n\treturn options\n}\n\nexport {\n\treadJSON,\n\treadJSONSync,\n}\n\nexport function outputJSON(file: string, data: any, options?: IWriteOptions)\n{\n\toptions = _handleWriteOptions(options);\n\treturn _outputJSON(file, data, options)\n}\n\nexport function outputJSONSync(file: string, data: any, options?: IWriteOptions)\n{\n\toptions = _handleWriteOptions(options);\n\treturn _outputJSONSync(file, data, options)\n}\n\nexport function writeJSON(file: string, data: any, options?: IWriteOptions)\n{\n\toptions = _handleWriteOptions(options);\n\treturn _writeJSON(file, data, options)\n}\n\nexport function writeJSONSync(file: string, data: any, options?: IWriteOptions)\n{\n\toptions = _handleWriteOptions(options);\n\treturn _writeJSONSync(file, data, options)\n}\n\nexport function stringifyJSON(data: any, options?: IWriteOptions): string\n{\n\toptions = _handleWriteOptions(options);\n\treturn stringify(data, options as any)\n}\n\nexport function parseJSON(stringOrUint8Array: string | Uint8Array,\n\treviver?: (this: any, key: string, value: any) => any,\n): string\n{\n\treturn JSON.parse(stringOrUint8Array.toString(), reviver)\n}\n"]}