@frsource/frs-replace 5.1.9 → 5.1.11

package/README.md

@@ -239,21 +239,21 @@ const result = sync({
 
 ## :chart_with_upwards_trend: Benchmarks
 
-> Tested on Node v20.18.1.
+> Tested on Node v20.18.2.
 
 ### input as glob pattern [40 files]
 
 | Rank | Library                       | Average latency [ms] | Difference percentage (comparing to best average latency) |
 | ---- | ----------------------------- | -------------------- | ----------------------------------------------------------------------------- |
-| 1    | @frsource/frs-replace (sync)  | 0.46 ± 1.12%         | +0.00%                                                                        |
-| 2    | replace-in-file (sync)        | 0.85 ± 1.57%         | +85.76%                                                                       |
-| 3    | @frsource/frs-replace (async) | 1.81 ± 1.33%         | +295.54%                                                                      |
-| 4    | replace-in-file (async)       | 3.12 ± 1.29%         | +580.17%                                                                      |
+| 1    | @frsource/frs-replace (sync)  | 0.45 ± 1.16%         | +0.00%                                                                        |
+| 2    | replace-in-file (sync)        | 0.80 ± 1.27%         | +76.77%                                                                       |
+| 3    | @frsource/frs-replace (async) | 1.82 ± 1.40%         | +301.01%                                                                      |
+| 4    | replace-in-file (async)       | 3.09 ± 1.22%         | +579.84%                                                                      |
 
 ### input & replacement as strings
 
 | Rank | Library                       | Average latency [ms] | Difference percentage (comparing to best average latency) |
 | ---- | ----------------------------- | -------------------- | ----------------------------------------------------------------------------- |
-| 1    | @frsource/frs-replace (sync)  | 0.01 ± 0.54%         | +0.00%                                                                        |
-| 2    | @frsource/frs-replace (async) | 0.01 ± 0.36%         | +12.34%                                                                       |
-| 3    | replaceString                 | 0.18 ± 1.01%         | +2179.82%                                                                     |
+| 1    | @frsource/frs-replace (sync)  | 0.01 ± 0.27%         | +0.00%                                                                        |
+| 2    | @frsource/frs-replace (async) | 0.01 ± 0.31%         | +12.10%                                                                       |
+| 3    | replaceString                 | 0.18 ± 1.08%         | +2155.02%                                                                     |

package/dist/async.d.mts

@@ -0,0 +1,7 @@
+declare function _default({ strategy, needle, replacement, ...args }: Args): Promise<import("./types.mjs").FileResult[]>;
+export default _default;
+export type Strategy = import("./types.mjs").Strategy;
+export type InputStrategyFn = import("./types.mjs").InputStrategyFn;
+export type OutputStrategyFn = import("./types.mjs").OutputStrategyFn;
+export type Args = import("./types.mjs").Args;
+export type FileResult = import("./types.mjs").FileResult;

package/dist/index.d.mts

@@ -0,0 +1,3 @@
+export * from "./types.mjs";
+export { default as sync } from "./sync.mjs";
+export { default as async } from "./async.mjs";

package/dist/sync.d.mts

@@ -0,0 +1,7 @@
+declare function _default({ strategy, needle, replacement, ...args }: Args): import("./types.mjs").FileResult[];
+export default _default;
+export type Strategy = import("./types.mjs").Strategy;
+export type InputStrategyFnSync = import("./types.mjs").InputStrategyFnSync;
+export type OutputStrategyFnSync = import("./types.mjs").OutputStrategyFnSync;
+export type Args = import("./types.mjs").Args;
+export type FileResult = import("./types.mjs").FileResult;

package/dist/types.d.mts

@@ -0,0 +1,24 @@
+export type Strategy = "join" | "flatten" | "preserve-structure";
+export type CommonArgs = {
+    strategy?: Strategy;
+    needle: string | RegExp;
+    replacement: string;
+};
+export type InputArgs = {
+    input: Parameters<typeof import("fast-glob").sync>[0];
+    inputReadOptions?: Parameters<typeof import("fs").readFileSync>[1];
+    inputGlobOptions?: Parameters<typeof import("fast-glob").sync>[1];
+} | {
+    content: string;
+};
+export type OutputArgs = {
+    output?: string;
+    outputWriteOptions?: Parameters<typeof import("fs").writeFileSync>[2];
+    outputJoinString?: string;
+} | object;
+export type Args = CommonArgs & InputArgs & OutputArgs;
+export type FileResult = [string, string];
+export type InputStrategyFnSync = (results: FileResult[], outputJoinString: string) => [FileResult[]] | [FileResult[], string];
+export type OutputStrategyFnSync = (results: FileResult[], output: string, outputWriteOptions: Parameters<typeof import("fs").writeFileSync>[2]) => FileResult[];
+export type InputStrategyFn = (results: Promise<Promise<FileResult>[]> | FileResult[], outputJoinString: string) => Promise<FileResult[]> | FileResult[];
+export type OutputStrategyFn = (results: Promise<FileResult[]> | FileResult[], output: string, outputWriteOptions: Parameters<typeof import("fs").writeFileSync>[2]) => Promise<FileResult[]>;

package/dist/utils.d.mts

@@ -0,0 +1,3 @@
+export function writeError(msg: string): never;
+export function getReplaceFn(needle: Args["needle"], replacement: string): (content: string) => string;
+export type Args = import("./types.mjs").Args;

package/package.json

@@ -1,16 +1,26 @@
 {
   "name": "@frsource/frs-replace",
-  "version": "5.1.9",
+  "version": "5.1.11",
   "description": "Simple wrapper around javascript replace with CLI usage support!",
   "bin": {
     "frs-replace": "bin/cli.mjs"
   },
   "type": "module",
-  "main": "dist/index.mjs",
+  "main": "src/index.mjs",
+  "types": "dist/index.d.mts",
   "exports": {
-    ".": "./src/index.mjs",
-    "./sync": "./src/sync.mjs",
-    "./async": "./src/async.mjs",
+    ".": {
+      "default": "./src/index.mjs",
+      "types": "./dist/index.d.mts"
+    },
+    "./sync": {
+      "default": "./src/sync.mjs",
+      "types": "./dist/sync.d.mts"
+    },
+    "./async": {
+      "default": "./src/async.mjs",
+      "types": "./dist/async.d.mts"
+    },
     "./*": "./*.mjs"
   },
   "repository": {
@@ -25,6 +35,7 @@
   },
   "homepage": "https://github.com/FRSOURCE/frs-replace#readme",
   "files": [
+    "dist",
     "bin/cli.mjs",
     "src/*.mjs",
     "package.json"
@@ -45,9 +56,10 @@
     "javascript"
   ],
   "scripts": {
-    "typecheck": "tsc --project tsconfig.json",
+    "typecheck": "tsc --project tsconfig.json --noEmit",
     "release": "semantic-release",
     "release:ci": "pnpm release --yes",
+    "build": "tsc --project tsconfig.json --declaration --emitDeclarationOnly",
     "test": "vitest",
     "coverage": "vitest --coverage",
     "test:ci": "vitest run --coverage && vitest bench --run && TEST_TYPE=bench vitest run --allowOnly",