@ms-cloudpack/json-utilities 0.0.3 → 0.0.5

package/lib/index.d.ts

@@ -0,0 +1,2 @@
+export { readJson, readJsonSync } from './readJson.js';
+export { writeJson, writeJsonSync } from './writeJson.js';

package/lib/index.js

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

package/lib/index.js.map

@@ -0,0 +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"}

package/lib/readJson.d.ts

@@ -0,0 +1,9 @@
+/**
+ * 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>;
+/**
+ * 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;

package/lib/readJson.js

@@ -0,0 +1,30 @@
+import fs from 'fs';
+const { readFile } = fs.promises;
+/**
+ * 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;
+    try {
+        result = JSON.parse(await readFile(path, 'utf8'));
+    }
+    catch {
+        /* no-op */
+    }
+    return result;
+}
+/**
+ * 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;
+    try {
+        result = JSON.parse(fs.readFileSync(path, 'utf8'));
+    }
+    catch {
+        /* no-op */
+    }
+    return result;
+}
+//# sourceMappingURL=readJson.js.map

package/lib/readJson.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"readJson.js","sourceRoot":"","sources":["../src/readJson.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,IAAI,CAAC;AAEpB,MAAM,EAAE,QAAQ,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC;AAEjC;;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,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,CAAU,CAAC;KAC5D;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"}

package/lib/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.34.3"
+    }
+  ]
+}

package/lib/writeJson.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Writes json to a path. Ensures the path exists.
+ */
+export declare function writeJson(filePath: string, data: any): Promise<void>;
+/**
+ * Synchronously writes json to a path. Ensures the path exists.
+ */
+export declare function writeJsonSync(filePath: string, data: any): void;

package/lib/writeJson.js

@@ -0,0 +1,23 @@
+import fs from 'fs';
+import path from 'path';
+import { ensureDir, ensureDirSync } from 'fs-extra';
+const { writeFile } = fs.promises;
+/**
+ * Writes json to a path. Ensures the path exists.
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export async function writeJson(filePath, data) {
+    const folderPath = path.dirname(filePath);
+    await ensureDir(folderPath);
+    await writeFile(filePath, JSON.stringify(data, null, 2), 'utf8');
+}
+/**
+ * Synchronously writes json to a path. Ensures the path exists.
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export function writeJsonSync(filePath, data) {
+    const folderPath = path.dirname(filePath);
+    ensureDirSync(folderPath);
+    fs.writeFileSync(filePath, JSON.stringify(data, null, 2), 'utf8');
+}
+//# sourceMappingURL=writeJson.js.map

package/lib/writeJson.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"writeJson.js","sourceRoot":"","sources":["../src/writeJson.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAEpD,MAAM,EAAE,SAAS,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC;AAElC;;GAEG;AACH,8DAA8D;AAC9D,MAAM,CAAC,KAAK,UAAU,SAAS,CAAC,QAAgB,EAAE,IAAS;IACzD,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IAE1C,MAAM,SAAS,CAAC,UAAU,CAAC,CAAC;IAC5B,MAAM,SAAS,CAAC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;AACnE,CAAC;AAED;;GAEG;AACH,8DAA8D;AAC9D,MAAM,UAAU,aAAa,CAAC,QAAgB,EAAE,IAAS;IACvD,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IAE1C,aAAa,CAAC,UAAU,CAAC,CAAC;IAC1B,EAAE,CAAC,aAAa,CAAC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;AACpE,CAAC"}

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@ms-cloudpack/json-utilities",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "description": "Helpers for reading/writing json files.",
+  "license": "MIT",
   "type": "module",
   "types": "./lib/index.d.ts",
   "sideEffects": false,
@@ -12,20 +13,21 @@
     }
   },
   "dependencies": {
-    "fs-extra": "^10.1.0"
+    "fs-extra": "^11.0.0"
   },
   "devDependencies": {
     "@ms-cloudpack/eslint-config-base": "*",
-    "@ms-cloudpack/scripts": "*",
-    "@types/fs-extra": "9.0.13"
+    "@ms-cloudpack/scripts": "*"
   },
   "scripts": {
-    "build": "just-scripts build",
-    "build:watch": "just-scripts build:watch",
-    "lint": "just-scripts lint",
-    "lint:fix": "just-scripts lint:fix"
+    "api:update": "cloudpack-scripts api-update",
+    "api": "cloudpack-scripts api",
+    "build:watch": "cloudpack-scripts build-watch",
+    "build": "cloudpack-scripts build",
+    "lint:update": "cloudpack-scripts lint-update",
+    "lint": "cloudpack-scripts lint"
   },
   "files": [
-    "/lib"
+    "lib/**/!(*.test.*)"
   ]
 }

package/CHANGELOG.json

@@ -1,43 +0,0 @@
-{
-  "name": "@ms-cloudpack/json-utilities",
-  "entries": [
-    {
-      "date": "Mon, 09 May 2022 23:39:20 GMT",
-      "tag": "@ms-cloudpack/json-utilities_v0.0.3",
-      "version": "0.0.3",
-      "comments": {
-        "none": [
-          {
-            "author": "dzearing@microsoft.com",
-            "package": "@ms-cloudpack/json-utilities",
-            "commit": "e68680ba160469e2aad19a0c1ef20de03bced434",
-            "comment": "removing changes."
-          }
-        ],
-        "patch": [
-          {
-            "author": "bot@renovateapp.com",
-            "package": "@ms-cloudpack/json-utilities",
-            "commit": "e68680ba160469e2aad19a0c1ef20de03bced434",
-            "comment": "Cleaning up problems found with depcheck"
-          }
-        ]
-      }
-    },
-    {
-      "date": "Mon, 09 May 2022 18:54:56 GMT",
-      "tag": "@ms-cloudpack/json-utilities_v0.0.2",
-      "version": "0.0.2",
-      "comments": {
-        "patch": [
-          {
-            "author": "dzearing@microsoft.com",
-            "package": "@ms-cloudpack/json-utilities",
-            "commit": "13c322180c016e6c653d4694b9f3380adeb8ad6f",
-            "comment": "Initial publish."
-          }
-        ]
-      }
-    }
-  ]
-}

package/CHANGELOG.md

@@ -1,21 +0,0 @@
-# Change Log - @ms-cloudpack/json-utilities
-
-This log was last generated on Mon, 09 May 2022 23:39:20 GMT and should not be manually modified.
-
-<!-- Start content -->
-
-## 0.0.3
-
-Mon, 09 May 2022 23:39:20 GMT
-
-### Patches
-
-- Cleaning up problems found with depcheck (bot@renovateapp.com)
-
-## 0.0.2
-
-Mon, 09 May 2022 18:54:56 GMT
-
-### Patches
-
-- Initial publish. (dzearing@microsoft.com)