@ms-cloudpack/json-utilities 0.0.8 → 0.1.0

package/lib/index.d.ts

@@ -1,3 +1,3 @@
-export { readJson, readJsonSync } from './readJson.js';
+export { readJson, readJsonSync, type ReadJsonOptions } from './readJson.js';
 export { writeJson, writeJsonSync } from './writeJson.js';
 //# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AACvD,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,KAAK,eAAe,EAAE,MAAM,eAAe,CAAC;AAC7E,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC"}

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AACvD,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC","sourcesContent":["export { readJson, readJsonSync } from './readJson.js';\nexport { writeJson, writeJsonSync } from './writeJson.js';\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAwB,MAAM,eAAe,CAAC;AAC7E,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC","sourcesContent":["export { readJson, readJsonSync, type ReadJsonOptions } from './readJson.js';\nexport { writeJson, writeJsonSync } from './writeJson.js';\n"]}

package/lib/readJson.d.ts

@@ -1,10 +1,28 @@
+/**
+ * Options for `readJson` and `readJsonSync`.
+ */
+export interface ReadJsonOptions {
+    /**
+     * How to read the JSON file:
+     * - `strict`: Use `JSON.parse` (fastest, but does not give informative error messages)
+     * - `permissive`: Use `jju.parse` (slower, but allows comments and trailing commas, and gives
+     *   informative error messages if `verbose` is true)
+     * @default 'strict'
+     */
+    mode?: 'strict' | 'permissive';
+    /**
+     * If true, log a warning if the file can't be parsed (or exists but can't be read).
+     * This does NOT log a message if the file doesn't exist.
+     */
+    verbose?: boolean;
+}
 /**
  * Reads JSON from a path and returns the object, or undefined if it does not exist or is unparsable.
  */
-export declare function readJson<TData>(path: string): Promise<TData | undefined>;
+export declare function readJson<TData>(path: string, options?: ReadJsonOptions): Promise<TData | undefined>;
 /**
  * Synchronously reads JSON from a path and returns the object, or undefined if it does not exist
  * or is unparsable.
  */
-export declare function readJsonSync<TData>(path: string): TData | undefined;
+export declare function readJsonSync<TData>(path: string, options?: ReadJsonOptions): TData | undefined;
 //# sourceMappingURL=readJson.d.ts.map

package/lib/readJson.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"readJson.d.ts","sourceRoot":"","sources":["../src/readJson.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,wBAAsB,QAAQ,CAAC,KAAK,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,GAAG,SAAS,CAAC,CAU9E;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,IAAI,EAAE,MAAM,GAAG,KAAK,GAAG,SAAS,CAUnE"}
+{"version":3,"file":"readJson.d.ts","sourceRoot":"","sources":["../src/readJson.ts"],"names":[],"mappings":"AAKA;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;;;;;OAMG;IACH,IAAI,CAAC,EAAE,QAAQ,GAAG,YAAY,CAAC;IAC/B;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;GAEG;AACH,wBAAsB,QAAQ,CAAC,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE,eAAoB,GAAG,OAAO,CAAC,KAAK,GAAG,SAAS,CAAC,CAe7G;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE,eAAoB,GAAG,KAAK,GAAG,SAAS,CAelG"}

package/lib/readJson.js

@@ -1,31 +1,57 @@
 import fs from 'fs';
 // NOTE: Importing the whole module (not named exports) is required to make Jest mocks work elsewhere.
 import fsPromises from 'fs/promises';
+import jju from 'jju';
 /**
  * Reads JSON from a path and returns the object, or undefined if it does not exist or is unparsable.
  */
-export async function readJson(path) {
-    let result = undefined;
+export async function readJson(path, options = {}) {
+    if (!fs.existsSync(path)) {
+        return undefined;
+    }
     try {
-        result = JSON.parse(await fsPromises.readFile(path, 'utf8'));
+        const contents = await fsPromises.readFile(path, 'utf8');
+        return parseJson({ contents, path, ...options });
     }
-    catch {
-        /* no-op */
+    catch (err) {
+        if (options.verbose) {
+            console.warn(`Error reading ${path}: ${err.message || err}`);
+        }
     }
-    return result;
+    return undefined;
 }
 /**
  * Synchronously reads JSON from a path and returns the object, or undefined if it does not exist
  * or is unparsable.
  */
-export function readJsonSync(path) {
-    let result = undefined;
+export function readJsonSync(path, options = {}) {
+    if (!fs.existsSync(path)) {
+        return undefined;
+    }
+    try {
+        const contents = fs.readFileSync(path, 'utf8');
+        return parseJson({ contents, path, ...options });
+    }
+    catch (err) {
+        if (options.verbose) {
+            console.warn(`Error reading ${path}: ${err.message || err}`);
+        }
+    }
+    return undefined;
+}
+function parseJson(params) {
+    const { contents, path, mode, verbose } = params;
     try {
-        result = JSON.parse(fs.readFileSync(path, 'utf8'));
+        if (mode === 'permissive') {
+            return jju.parse(contents);
+        }
+        return JSON.parse(contents);
     }
-    catch {
-        /* no-op */
+    catch (err) {
+        if (verbose) {
+            console.warn(`Error parsing JSON from ${path}: ${err.message || err}`);
+        }
     }
-    return result;
+    return undefined;
 }
 //# sourceMappingURL=readJson.js.map

package/lib/readJson.js.map

@@ -1 +1 @@
-{"version":3,"file":"readJson.js","sourceRoot":"","sources":["../src/readJson.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,sGAAsG;AACtG,OAAO,UAAU,MAAM,aAAa,CAAC;AAErC;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,QAAQ,CAAQ,IAAY;IAChD,IAAI,MAAM,GAAsB,SAAS,CAAC;IAE1C,IAAI;QACF,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,UAAU,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,CAAU,CAAC;KACvE;IAAC,MAAM;QACN,WAAW;KACZ;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,YAAY,CAAQ,IAAY;IAC9C,IAAI,MAAM,GAAsB,SAAS,CAAC;IAE1C,IAAI;QACF,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAU,CAAC;KAC7D;IAAC,MAAM;QACN,WAAW;KACZ;IAED,OAAO,MAAM,CAAC;AAChB,CAAC","sourcesContent":["import fs from 'fs';\n// NOTE: Importing the whole module (not named exports) is required to make Jest mocks work elsewhere.\nimport fsPromises from 'fs/promises';\n\n/**\n * Reads JSON from a path and returns the object, or undefined if it does not exist or is unparsable.\n */\nexport async function readJson<TData>(path: string): Promise<TData | undefined> {\n  let result: TData | undefined = undefined;\n\n  try {\n    result = JSON.parse(await fsPromises.readFile(path, 'utf8')) as TData;\n  } catch {\n    /* no-op */\n  }\n\n  return result;\n}\n\n/**\n * Synchronously reads JSON from a path and returns the object, or undefined if it does not exist\n * or is unparsable.\n */\nexport function readJsonSync<TData>(path: string): TData | undefined {\n  let result: TData | undefined = undefined;\n\n  try {\n    result = JSON.parse(fs.readFileSync(path, 'utf8')) as TData;\n  } catch {\n    /* no-op */\n  }\n\n  return result;\n}\n"]}
+{"version":3,"file":"readJson.js","sourceRoot":"","sources":["../src/readJson.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,sGAAsG;AACtG,OAAO,UAAU,MAAM,aAAa,CAAC;AACrC,OAAO,GAAG,MAAM,KAAK,CAAC;AAqBtB;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,QAAQ,CAAQ,IAAY,EAAE,UAA2B,EAAE;IAC/E,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE;QACxB,OAAO,SAAS,CAAC;KAClB;IAED,IAAI;QACF,MAAM,QAAQ,GAAG,MAAM,UAAU,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QACzD,OAAO,SAAS,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;KAClD;IAAC,OAAO,GAAG,EAAE;QACZ,IAAI,OAAO,CAAC,OAAO,EAAE;YACnB,OAAO,CAAC,IAAI,CAAC,iBAAiB,IAAI,KAAM,GAAa,CAAC,OAAO,IAAI,GAAG,EAAE,CAAC,CAAC;SACzE;KACF;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,YAAY,CAAQ,IAAY,EAAE,UAA2B,EAAE;IAC7E,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE;QACxB,OAAO,SAAS,CAAC;KAClB;IAED,IAAI;QACF,MAAM,QAAQ,GAAG,EAAE,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAC/C,OAAO,SAAS,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;KAClD;IAAC,OAAO,GAAG,EAAE;QACZ,IAAI,OAAO,CAAC,OAAO,EAAE;YACnB,OAAO,CAAC,IAAI,CAAC,iBAAiB,IAAI,KAAM,GAAa,CAAC,OAAO,IAAI,GAAG,EAAE,CAAC,CAAC;SACzE;KACF;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,SAAS,SAAS,CAAQ,MAA4D;IACpF,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;IACjD,IAAI;QACF,IAAI,IAAI,KAAK,YAAY,EAAE;YACzB,OAAO,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAU,CAAC;SACrC;QACD,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAU,CAAC;KACtC;IAAC,OAAO,GAAG,EAAE;QACZ,IAAI,OAAO,EAAE;YACX,OAAO,CAAC,IAAI,CAAC,2BAA2B,IAAI,KAAM,GAAa,CAAC,OAAO,IAAI,GAAG,EAAE,CAAC,CAAC;SACnF;KACF;IACD,OAAO,SAAS,CAAC;AACnB,CAAC","sourcesContent":["import fs from 'fs';\n// NOTE: Importing the whole module (not named exports) is required to make Jest mocks work elsewhere.\nimport fsPromises from 'fs/promises';\nimport jju from 'jju';\n\n/**\n * Options for `readJson` and `readJsonSync`.\n */\nexport interface ReadJsonOptions {\n  /**\n   * How to read the JSON file:\n   * - `strict`: Use `JSON.parse` (fastest, but does not give informative error messages)\n   * - `permissive`: Use `jju.parse` (slower, but allows comments and trailing commas, and gives\n   *   informative error messages if `verbose` is true)\n   * @default 'strict'\n   */\n  mode?: 'strict' | 'permissive';\n  /**\n   * If true, log a warning if the file can't be parsed (or exists but can't be read).\n   * This does NOT log a message if the file doesn't exist.\n   */\n  verbose?: boolean;\n}\n\n/**\n * Reads JSON from a path and returns the object, or undefined if it does not exist or is unparsable.\n */\nexport async function readJson<TData>(path: string, options: ReadJsonOptions = {}): Promise<TData | undefined> {\n  if (!fs.existsSync(path)) {\n    return undefined;\n  }\n\n  try {\n    const contents = await fsPromises.readFile(path, 'utf8');\n    return parseJson({ contents, path, ...options });\n  } catch (err) {\n    if (options.verbose) {\n      console.warn(`Error reading ${path}: ${(err as Error).message || err}`);\n    }\n  }\n\n  return undefined;\n}\n\n/**\n * Synchronously reads JSON from a path and returns the object, or undefined if it does not exist\n * or is unparsable.\n */\nexport function readJsonSync<TData>(path: string, options: ReadJsonOptions = {}): TData | undefined {\n  if (!fs.existsSync(path)) {\n    return undefined;\n  }\n\n  try {\n    const contents = fs.readFileSync(path, 'utf8');\n    return parseJson({ contents, path, ...options });\n  } catch (err) {\n    if (options.verbose) {\n      console.warn(`Error reading ${path}: ${(err as Error).message || err}`);\n    }\n  }\n\n  return undefined;\n}\n\nfunction parseJson<TData>(params: { contents: string; path: string } & ReadJsonOptions): TData | undefined {\n  const { contents, path, mode, verbose } = params;\n  try {\n    if (mode === 'permissive') {\n      return jju.parse(contents) as TData;\n    }\n    return JSON.parse(contents) as TData;\n  } catch (err) {\n    if (verbose) {\n      console.warn(`Error parsing JSON from ${path}: ${(err as Error).message || err}`);\n    }\n  }\n  return undefined;\n}\n"]}

package/lib/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.36.4"
+      "packageVersion": "7.37.1"
     }
   ]
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ms-cloudpack/json-utilities",
-  "version": "0.0.8",
+  "version": "0.1.0",
   "description": "Helpers for reading/writing json files.",
   "license": "MIT",
   "type": "module",
@@ -14,18 +14,23 @@
     }
   },
   "dependencies": {
-    "fs-extra": "^11.0.0"
+    "fs-extra": "^11.0.0",
+    "jju": "^1.4.0"
   },
   "devDependencies": {
     "@ms-cloudpack/eslint-plugin-internal": "*",
-    "@ms-cloudpack/scripts": "*"
+    "@ms-cloudpack/scripts": "*",
+    "@types/jju": "^1.4.4"
   },
   "scripts": {
     "api": "cloudpack-scripts api",
     "build:watch": "cloudpack-scripts build-watch",
     "build": "cloudpack-scripts build",
     "lint:update": "cloudpack-scripts lint-update",
-    "lint": "cloudpack-scripts lint"
+    "lint": "cloudpack-scripts lint",
+    "test:update": "cloudpack-scripts test-update",
+    "test:watch": "cloudpack-scripts test-watch",
+    "test": "cloudpack-scripts test"
   },
   "files": [
     "lib/**/!(*.test.*)"