@thi.ng/file-io 2.2.37 → 2.3.0

package/README.md

@@ -8,7 +8,7 @@
 
 > [!NOTE]
 
-> This is one of 215 standalone projects. LLM-free, human-made and
+> This is one of 216 standalone projects. LLM-free, human-made and
 > cared for software, maintained as part of the
 > [@thi.ng/umbrella](https://codeberg.org/thi.ng/umbrella/) ecosystem and
 > anti-framework.
@@ -108,7 +108,7 @@ For Node.js REPL:
 const fio = await import("@thi.ng/file-io");
 ```
 
-Package sizes (brotli'd, pre-treeshake): ESM: 2.44 KB
+Package sizes (brotli'd, pre-treeshake): ESM: 2.50 KB
 
 ## Dependencies
 

package/json.d.ts

@@ -14,6 +14,24 @@ export declare const readJSON: <T = any>(path: string, logger?: ILogger) => T;
  * @param logger
  */
 export declare const readJSONAsync: <T = any>(path: string, logger?: ILogger) => Promise<T>;
+/**
+ * Similar to {@link readJSON}, reads JSON file with comments.
+ *
+ * @remarks
+ * **IMPORTANT:** Only `//` single line comments (with optional leading
+ * whitespace) are supported! This is NOT a full JSONC parser.
+ *
+ * @param path
+ * @param logger
+ */
+export declare const readJSONC: <T = any>(path: string, logger?: ILogger) => T;
+/**
+ * Async version of {@link readJSONC}.
+ *
+ * @param path
+ * @param logger
+ */
+export declare const readJSONCAsync: <T = any>(path: string, logger?: ILogger) => Promise<T>;
 /**
  * Serializes `obj` to JSON and writes result to UTF-8 file `path`. See
  * {@link writeText} for more details.

package/json.js

@@ -1,6 +1,11 @@
 import { readText, readTextAsync, writeText, writeTextAsync } from "./text.js";
 const readJSON = (path, logger) => JSON.parse(readText(path, logger));
 const readJSONAsync = async (path, logger) => JSON.parse(await readTextAsync(path, logger));
+const readJSONC = (path, logger) => __parseJSONC(readText(path, logger));
+const readJSONCAsync = async (path, logger) => __parseJSONC(await readTextAsync(path, logger));
+const __parseJSONC = (src) => JSON.parse(
+  src.split(/\r?\n/g).filter((x) => !/^\s*\/\//.test(x)).join("\n")
+);
 const writeJSON = (path, obj, replacer, space, logger, dryRun = false) => writeText(
   path,
   JSON.stringify(obj, replacer, space) + "\n",
@@ -16,6 +21,8 @@ const writeJSONAsync = (path, obj, replacer, space, logger, dryRun = false) => w
 export {
   readJSON,
   readJSONAsync,
+  readJSONC,
+  readJSONCAsync,
   writeJSON,
   writeJSONAsync
 };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@thi.ng/file-io",
-	"version": "2.2.37",
+	"version": "2.3.0",
 	"description": "Assorted file I/O utils (w/ logging support) for NodeJS/Bun",
 	"type": "module",
 	"module": "./index.js",
@@ -40,11 +40,11 @@
 		"tool:tangle": "../../node_modules/.bin/tangle src/**/*.ts"
 	},
 	"dependencies": {
-		"@thi.ng/api": "^8.12.25",
-		"@thi.ng/checks": "^3.9.5",
-		"@thi.ng/hex": "^2.4.17",
-		"@thi.ng/logger": "^3.3.8",
-		"@thi.ng/random": "^4.1.51"
+		"@thi.ng/api": "^8.12.26",
+		"@thi.ng/checks": "^3.10.0",
+		"@thi.ng/hex": "^2.4.18",
+		"@thi.ng/logger": "^3.3.9",
+		"@thi.ng/random": "^4.1.52"
 	},
 	"devDependencies": {
 		"@types/node": "^25.6.2",
@@ -135,5 +135,5 @@
 		"status": "stable",
 		"year": 2022
 	},
-	"gitHead": "65b041e97110e16c01cf968949b72a0873f14445"
+	"gitHead": "c47c56420bcae2e0477d252a497be44f08ca185a"
 }