@thi.ng/file-io 2.0.2 → 2.1.0

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2024-04-11T12:32:44Z
+- **Last updated**: 2024-04-23T07:02:17Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,18 @@ See [Conventional Commits](https://conventionalcommits.org/) for commit guidelin
 **Note:** Unlisted _patch_ versions only involve non-code or otherwise excluded changes
 and/or version bumps of transitive dependencies.
 
+## [2.1.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/file-io@2.1.0) (2024-04-23)
+
+#### 🚀 Features
+
+- add deleteDir() ([06b4ffc](https://github.com/thi-ng/umbrella/commit/06b4ffc))
+
+### [2.0.3](https://github.com/thi-ng/umbrella/tree/@thi.ng/file-io@2.0.3) (2024-04-20)
+
+#### ♻️ Refactoring
+
+- update type usage ([7dc9551](https://github.com/thi-ng/umbrella/commit/7dc9551))
+
 # [2.0.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/file-io@2.0.0) (2024-03-29)
 
 #### 🛑 Breaking changes

package/delete.d.ts

@@ -9,4 +9,13 @@ import type { ILogger } from "@thi.ng/logger";
  * @param dryRun
  */
 export declare const deleteFile: (path: string, logger?: ILogger, dryRun?: boolean) => void;
+/**
+ * Like {@link deleteFile}, but attempts to recursively remove an entire
+ * directory at given path.
+ *
+ * @param path
+ * @param logger
+ * @param dryRun
+ */
+export declare const deleteDir: (path: string, logger?: ILogger, dryRun?: boolean) => void;
 //# sourceMappingURL=delete.d.ts.map

package/delete.js

@@ -1,10 +1,17 @@
-import { unlinkSync } from "node:fs";
+import { rmSync, unlinkSync } from "node:fs";
 const deleteFile = (path, logger, dryRun = false) => {
   logger && logger.info(`${dryRun ? "[dryrun] " : ""}deleting file: ${path}`);
   if (dryRun)
     return;
   unlinkSync(path);
 };
+const deleteDir = (path, logger, dryRun = false) => {
+  logger && logger.info(`${dryRun ? "[dryrun] " : ""}deleting file: ${path}`);
+  if (dryRun)
+    return;
+  rmSync(path, { recursive: true, force: true });
+};
 export {
+  deleteDir,
   deleteFile
 };

package/json.d.ts

@@ -1,4 +1,4 @@
-import type { Fn3, NumOrString } from "@thi.ng/api";
+import type { Fn3, Maybe, Nullable, NumOrString } from "@thi.ng/api";
 import type { ILogger } from "@thi.ng/logger";
 export declare const readJSON: <T = any>(path: string, logger?: ILogger) => T;
 /**
@@ -16,5 +16,5 @@ export declare const readJSON: <T = any>(path: string, logger?: ILogger) => T;
  * @param logger
  * @param dryRun
  */
-export declare const writeJSON: (path: string, obj: any, replacer?: Fn3<any, string, any, any> | NumOrString[] | null | undefined, space?: NumOrString | undefined, logger?: ILogger, dryRun?: boolean) => void;
+export declare const writeJSON: (path: string, obj: any, replacer?: Fn3<any, string, any, any> | Nullable<NumOrString[]>, space?: Maybe<NumOrString>, logger?: ILogger, dryRun?: boolean) => void;
 //# sourceMappingURL=json.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/file-io",
-  "version": "2.0.2",
+  "version": "2.1.0",
   "description": "Assorted file I/O utils (with logging support) for NodeJS/Bun",
   "type": "module",
   "module": "./index.js",
@@ -27,7 +27,7 @@
     "build": "yarn build:esbuild && yarn build:decl",
     "build:decl": "tsc --declaration --emitDeclarationOnly",
     "build:esbuild": "esbuild --format=esm --platform=neutral --target=es2022 --tsconfig=tsconfig.json --outdir=. src/**/*.ts",
-    "clean": "rimraf --glob '*.js' '*.d.ts' '*.map' doc",
+    "clean": "bun ../../tools/src/clean-package.ts",
     "doc": "typedoc --excludePrivate --excludeInternal --out doc src/index.ts",
     "doc:ae": "mkdir -p .ae/doc .ae/temp && api-extractor run --local --verbose",
     "doc:readme": "bun ../../tools/src/module-stats.ts && bun ../../tools/src/readme.ts",
@@ -36,16 +36,15 @@
     "tool:tangle": "../../node_modules/.bin/tangle src/**/*.ts"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.10.1",
-    "@thi.ng/checks": "^3.6.1",
-    "@thi.ng/hex": "^2.3.43",
-    "@thi.ng/logger": "^3.0.9",
-    "@thi.ng/random": "^3.7.3"
+    "@thi.ng/api": "^8.11.1",
+    "@thi.ng/checks": "^3.6.3",
+    "@thi.ng/hex": "^2.3.45",
+    "@thi.ng/logger": "^3.0.11",
+    "@thi.ng/random": "^3.7.5"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.43.0",
     "esbuild": "^0.20.2",
-    "rimraf": "^5.0.5",
     "typedoc": "^0.25.12",
     "typescript": "^5.4.3"
   },
@@ -124,5 +123,5 @@
     "status": "stable",
     "year": 2022
   },
-  "gitHead": "18a0c063a7b33d790e5bc2486c106f45f663ac28\n"
+  "gitHead": "5dd66c18a3862a3af69a5b2f49563f7cbdd960c2\n"
 }