fs-target-file 1.0.21 → 1.0.24

package/CHANGELOG.md

@@ -3,6 +3,44 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [1.0.24](https://github.com/bluelovers/ws-iconv/compare/fs-target-file@1.0.23...fs-target-file@1.0.24) (2026-03-01)
+
+**Note:** Version bump only for package fs-target-file
+
+
+
+
+
+## [1.0.23](https://github.com/bluelovers/ws-iconv/compare/fs-target-file@1.0.22...fs-target-file@1.0.23) (2026-03-01)
+
+
+
+### 📚　Documentation
+
+* 为多个包添加双语 README 和 JSDoc 注释 ([71544eb](https://github.com/bluelovers/ws-iconv/commit/71544eb1347aa061cb4ac71afc8d30e79f1ad3ad))
+
+
+### ♻️　Chores
+
+* Update jest config and add new files for testing ([f370583](https://github.com/bluelovers/ws-iconv/commit/f37058385c7bf24d3d0bc975c752f2f35cfe8356))
+
+
+
+## [1.0.22](https://github.com/bluelovers/ws-iconv/compare/fs-target-file@1.0.21...fs-target-file@1.0.22) (2024-08-29)
+
+
+
+### 🛠　Build System
+
+* update build ([263e72e](https://github.com/bluelovers/ws-iconv/commit/263e72e423867a305d52992f40543e2efd19a349))
+
+
+### 📌　Dependencies
+
+* update deps ([dffc6e3](https://github.com/bluelovers/ws-iconv/commit/dffc6e313e4017a32d608bd0dad6ef6faaf761a3))
+
+
+
 ## [1.0.21](https://github.com/bluelovers/ws-iconv/compare/fs-target-file@1.0.20...fs-target-file@1.0.21) (2022-10-16)
 
 

package/README.md

@@ -1,8 +1,16 @@
-# README.md
+# fs-target-file - 檔案目標處理工具
 
+這個模組提供了檔案目標處理的功能，支援讀取和寫入操作，並可以指定輸入和輸出檔案。
 
+## 主要功能
 
-## install
+- 檔案目標處理
+- 讀取和寫入操作
+- 支援 JSON 檔案
+- 輸入和輸出檔案指定
+- 異步處理
+
+## 安裝
 
 ```bash
 yarn add fs-target-file
@@ -10,3 +18,5 @@ yarn-tool add fs-target-file
 yt add fs-target-file
 ```
 
+## 快速開始
+

package/index.d.ts

@@ -9,7 +9,7 @@ export interface IFileMethodAsyncOptions<RO = ReadOptions, WO = WriteOptions, D
 }
 export declare function fsFileMethodAsync<RO = ReadOptions, WO = WriteOptions, D = unknown, N = string>(options?: IFileMethodAsyncOptions<RO, WO, D, N>): {
     read: (<T = D>(file: N, options?: RO) => Promise<T>) | ((file: any, options: any) => Promise<any>);
-    write: <T_1 = D>(file: N, data: ITSResolvable<T_1>, options?: RO) => Promise<any>;
+    write: <T = D>(file: N, data: ITSResolvable<T>, options?: RO) => Promise<any>;
 };
 export interface ITargetFileOptions<N = string> {
     inputFile: N;
@@ -20,7 +20,7 @@ export declare function fsTargetFile<D = unknown, RO = ReadOptions, WO = WriteOp
     readonly inputFile: N;
     readonly outputFile: N;
     read<T = D>(options?: RO): Promise<T>;
-    write<T_1 extends D = D>(data: T_1, options?: RO): Promise<unknown>;
+    write<T extends D = D>(data: T, options?: RO): Promise<unknown>;
     async(): Promise<any>;
 };
 export default fsTargetFile;

package/index.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.fsTargetFile = exports.toTargetFileOptions = exports.fsFileMethodAsync = void 0;
+exports.fsFileMethodAsync = fsFileMethodAsync;
+exports.toTargetFileOptions = toTargetFileOptions;
+exports.fsTargetFile = fsTargetFile;
 const fs_extra_1 = require("fs-extra");
 function fsFileMethodAsync(options) {
     options !== null && options !== void 0 ? options : (options = {});
@@ -19,7 +21,6 @@ function fsFileMethodAsync(options) {
         write,
     };
 }
-exports.fsFileMethodAsync = fsFileMethodAsync;
 function toTargetFileOptions(targetOptions) {
     var _a;
     let inputFile;
@@ -39,7 +40,6 @@ function toTargetFileOptions(targetOptions) {
         outputFile,
     };
 }
-exports.toTargetFileOptions = toTargetFileOptions;
 function fsTargetFile(targetOptions, options) {
     const { read, write } = fsFileMethodAsync(options);
     const { inputFile, outputFile } = toTargetFileOptions(targetOptions);
@@ -62,6 +62,5 @@ function fsTargetFile(targetOptions, options) {
     };
     return target;
 }
-exports.fsTargetFile = fsTargetFile;
 exports.default = fsTargetFile;
 //# sourceMappingURL=index.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fs-target-file",
-  "version": "1.0.21",
+  "version": "1.0.24",
   "description": "",
   "homepage": "https://github.com/bluelovers/ws-iconv/tree/master/packages/fs-target-file#readme",
   "bugs": {
@@ -15,9 +15,11 @@
   "author": "bluelovers",
   "main": "index.js",
   "scripts": {
+    "coverage": "yarn run test -- --coverage",
     "lint": "ynpx --quiet eslint -- **/*.ts",
     "test": "echo \"Error: no test specified\"",
     "test:jest": "ynpx --quiet jest -- --coverage --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",
@@ -27,15 +29,16 @@
     "prepublishOnly:check-bin": "ynpx --quiet @yarn-tool/check-pkg-bin",
     "prepublishOnly:update": "yarn run ncu && yarn run sort-package-json",
     "ncu": "yarn-tool ncu -u",
-    "sort-package-json": "yarn-tool sort"
+    "sort-package-json": "yarn-tool sort",
+    "tsc:showConfig": "ynpx get-current-tsconfig -p"
   },
   "dependencies": {
-    "fs-extra": "^10.1.0",
+    "fs-extra": "^11.2.0",
     "ts-type": "^3.0.1",
     "tslib": "^2"
   },
   "devDependencies": {
-    "@types/fs-extra": "^9"
+    "@types/fs-extra": "^11"
   },
-  "gitHead": "c0b9fe1181976f749a069a0eda79eebebccb52cb"
+  "gitHead": "6bcfe6a585ad7e5657a40a5b0727c6281b564b60"
 }

package/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":";;;AAAA,uCAA2E;AAa3E,SAAgB,iBAAiB,CAA+D,OAA+C;IAE9I,OAAO,aAAP,OAAO,cAAP,OAAO,IAAP,OAAO,GAAK,EAAE,EAAC;IAEf,MAAM,EACL,WAAW,EACX,YAAY,GAAG;QACd,MAAM,EAAE,CAAC;KACT,GACD,GAAG,OAAO,CAAC;IAEZ,MAAM,EACL,IAAI,GAAG,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE,CAAC,IAAA,mBAAQ,EAAC,IAAI,EAAE;QACxC,GAAG,WAAW;QACd,GAAG,OAAO;KACV,CAAC,EACF,KAAK,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,CAAC,IAAA,qBAAU,EAAC,IAAI,EAAE,IAAI,EAAE;QACvD,GAAG,YAAY;QACf,GAAG,OAAO;KACV,CAAC,GACF,GAAG,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,EAAE,CAAC;IAElB,OAAO;QACN,IAAI;QACJ,KAAK;KACL,CAAA;AACF,CAAC;AA1BD,8CA0BC;AAQD,SAAgB,mBAAmB,CAAa,aAAwC;;IAEvF,IAAI,SAAY,CAAC;IACjB,IAAI,UAAa,CAAC;IAElB,aAAa;IACb,IAAI,OAAO,CAAA,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,SAAS,CAAA,KAAK,WAAW,EACnD;QACC,aAAa;QACb,SAAS,GAAG,aAAa,CAAC,SAAS,CAAC;QACpC,aAAa;QACb,UAAU,GAAG,MAAA,aAAa,CAAC,UAAU,mCAAI,SAAS,CAAC;KACnD;SAED;QACC,SAAS,GAAG,UAAU,GAAG,aAAkB,CAAC;KAC5C;IAED,OAAO;QACN,SAAS;QACT,UAAU;KACV,CAAA;AACF,CAAC;AAtBD,kDAsBC;AAED,SAAgB,YAAY,CAA+D,aAAwC,EAAE,OAA+C;IAEnL,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,iBAAiB,CAAe,OAAO,CAAC,CAAC;IAEjE,MAAM,EAAE,SAAS,EAAE,UAAU,EAAE,GAAG,mBAAmB,CAAC,aAAa,CAAC,CAAC;IAErE,MAAM,MAAM,GAAG;QAEd,IAAI,SAAS;YAEZ,OAAO,SAAS,CAAA;QACjB,CAAC;QAED,IAAI,UAAU;YAEb,OAAO,UAAU,CAAA;QAClB,CAAC;QAED,IAAI,CAAQ,OAAY;YAEvB,OAAO,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,CAAA;QAChC,CAAC;QAED,KAAK,CAAkB,IAAO,EAAE,OAAY;YAE3C,OAAO,KAAK,CAAC,UAAU,EAAE,IAAI,EAAE,OAAO,CAAC,CAAA;QACxC,CAAC;QAED,KAAK,CAAC,KAAK;YAEV,OAAO,MAAM,CAAA;QACd,CAAC;KAED,CAAC;IAEF,OAAO,MAAM,CAAA;AAEd,CAAC;AArCD,oCAqCC;AAED,kBAAe,YAAY,CAAA","sourcesContent":["import { outputJSON, readJSON, ReadOptions, WriteOptions } from 'fs-extra';\nimport { ITSResolvable } from 'ts-type/lib/generic';\nimport { ITSRequiredPick } from 'ts-type/lib/type/record';\n\nexport interface IFileMethodAsyncOptions<RO = ReadOptions, WO = WriteOptions, D = unknown, N = string>\n{\n\tread?<T = D>(file: N, options?: RO): Promise<T>,\n\twrite?<T = D>(file: N, data: ITSResolvable<T>, options?: RO): Promise<any>,\n\n\treadOptions?: RO,\n\twriteOptions?: WO,\n}\n\nexport function fsFileMethodAsync<RO = ReadOptions, WO = WriteOptions, D = unknown, N = string>(options?: IFileMethodAsyncOptions<RO, WO, D, N>)\n{\n\toptions ??= {};\n\n\tconst {\n\t\treadOptions,\n\t\twriteOptions = {\n\t\t\tspaces: 2,\n\t\t},\n\t} = options;\n\n\tconst {\n\t\tread = (file, options) => readJSON(file, {\n\t\t\t...readOptions,\n\t\t\t...options,\n\t\t}),\n\t\twrite = (file, data, options) => outputJSON(file, data, {\n\t\t\t...writeOptions,\n\t\t\t...options,\n\t\t}),\n\t} = options ?? {};\n\n\treturn {\n\t\tread,\n\t\twrite,\n\t}\n}\n\nexport interface ITargetFileOptions<N = string>\n{\n\tinputFile: N,\n\toutputFile?: N,\n}\n\nexport function toTargetFileOptions<N = string>(targetOptions: N | ITargetFileOptions<N>): ITSRequiredPick<ITargetFileOptions<N>>\n{\n\tlet inputFile: N;\n\tlet outputFile: N;\n\n\t// @ts-ignore\n\tif (typeof targetOptions?.inputFile !== 'undefined')\n\t{\n\t\t// @ts-ignore\n\t\tinputFile = targetOptions.inputFile;\n\t\t// @ts-ignore\n\t\toutputFile = targetOptions.outputFile ?? inputFile;\n\t}\n\telse\n\t{\n\t\tinputFile = outputFile = targetOptions as N;\n\t}\n\n\treturn {\n\t\tinputFile,\n\t\toutputFile,\n\t}\n}\n\nexport function fsTargetFile<D = unknown, RO = ReadOptions, WO = WriteOptions, N = string>(targetOptions: N | ITargetFileOptions<N>, options?: IFileMethodAsyncOptions<RO, WO, D, N>)\n{\n\tconst { read, write } = fsFileMethodAsync<RO, WO, D, N>(options);\n\n\tconst { inputFile, outputFile } = toTargetFileOptions(targetOptions);\n\n\tconst target = {\n\n\t\tget inputFile()\n\t\t{\n\t\t\treturn inputFile\n\t\t},\n\n\t\tget outputFile()\n\t\t{\n\t\t\treturn outputFile\n\t\t},\n\n\t\tread<T = D>(options?: RO): Promise<T>\n\t\t{\n\t\t\treturn read(inputFile, options)\n\t\t},\n\n\t\twrite<T extends D = D>(data: T, options?: RO): Promise<unknown>\n\t\t{\n\t\t\treturn write(outputFile, data, options)\n\t\t},\n\n\t\tasync async()\n\t\t{\n\t\t\treturn target\n\t\t}\n\n\t};\n\n\treturn target\n\n}\n\nexport default fsTargetFile\n"]}