@vltpkg/package-json 0.0.0-0.1730239248325

package/LICENSE

@@ -0,0 +1,15 @@
+Copyright (c) vlt technology, Inc.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+   Subject to the terms and conditions of this license, each copyright holder and contributor hereby grants to those receiving rights under this license a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except for failure to satisfy the conditions of this license) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer this software, where such license applies only to those patent claims, already acquired or hereafter acquired, licensable by such copyright holder or contributor that are necessarily infringed by:
+
+(a) their Contribution(s) (the licensed copyrights of copyright holders and non-copyrightable additions of contributors, in source or binary form) alone; or
+(b) combination of their Contribution(s) with the work of authorship to which such Contribution(s) was added by such copyright holder or contributor, if, at the time the Contribution is added, such addition causes such combination to be necessarily infringed. The patent license shall not apply to any other combinations which include the Contribution.
+Except as expressly stated above, no rights or licenses from any copyright holder or contributor is granted under this license, whether expressly, by implication, estoppel or otherwise.
+
+DISCLAIMER
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -0,0 +1,15 @@
+# `@vltpkg/package-json`
+
+Manages reading `package.json` files.
+
+Caches previously seen files and augments error messages for clarity.
+
+## USAGE
+
+```js
+import { PackageJson } from '@vltpkg/package-json'
+
+const packageJson = new PackageJson()
+const dir = process.cwd()
+const pkg = await packageJson.read(dir)
+```

package/dist/esm/index.d.ts

@@ -0,0 +1,14 @@
+import { Manifest } from '@vltpkg/types';
+export declare class PackageJson {
+    #private;
+    /**
+     * Reads and parses contents of a `package.json` file at a directory `dir`.
+     * `reload` will optionally skip reading from the cache when set to `true`.
+     */
+    read(dir: string, { reload }?: {
+        reload?: boolean;
+    }): Manifest;
+    write(dir: string, manifest: Manifest): void;
+    save(manifest: Manifest): void;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/esm/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAc,QAAQ,EAAE,MAAM,eAAe,CAAA;AAKpD,qBAAa,WAAW;;IAgBtB;;;OAGG;IACH,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,GAAE;QAAE,MAAM,CAAC,EAAE,OAAO,CAAA;KAAO,GAAG,QAAQ;IAiClE,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,GAAG,IAAI;IAyB5C,IAAI,CAAC,QAAQ,EAAE,QAAQ,GAAG,IAAI;CAa/B"}

package/dist/esm/index.js

@@ -0,0 +1,79 @@
+import { error } from '@vltpkg/error-cause';
+import { asManifest } from '@vltpkg/types';
+import { readFileSync, writeFileSync } from 'node:fs';
+import { resolve } from 'node:path';
+import { parse, stringify } from 'polite-json';
+export class PackageJson {
+    /**
+     * cache of `package.json` loads
+     */
+    #cache = new Map();
+    /**
+     * cache of `package.json` paths by manifest
+     */
+    #pathCache = new Map();
+    /**
+     * cache of load errors
+     */
+    #errCache = new Map();
+    /**
+     * Reads and parses contents of a `package.json` file at a directory `dir`.
+     * `reload` will optionally skip reading from the cache when set to `true`.
+     */
+    read(dir, { reload } = {}) {
+        const cachedPackageJson = !reload && this.#cache.get(dir);
+        if (cachedPackageJson) {
+            return cachedPackageJson;
+        }
+        const filename = resolve(dir, 'package.json');
+        const fail = (err) => error('Could not read package.json file', err, this.read);
+        const cachedError = !reload && this.#errCache.get(dir);
+        if (cachedError) {
+            throw fail(cachedError);
+        }
+        try {
+            const res = asManifest(parse(readFileSync(filename, { encoding: 'utf8' })));
+            this.#cache.set(dir, res);
+            this.#pathCache.set(res, dir);
+            return res;
+        }
+        catch (err) {
+            const ec = {
+                path: filename,
+                cause: err,
+            };
+            this.#errCache.set(dir, ec);
+            throw fail(ec);
+        }
+    }
+    write(dir, manifest) {
+        const filename = resolve(dir, 'package.json');
+        try {
+            // This assumes kIndent and kNewline are already present on the manifest because we would
+            // only write a package.json after reading it which will set those properties.
+            writeFileSync(filename, stringify(manifest));
+            this.#cache.set(dir, manifest);
+            this.#pathCache.set(manifest, dir);
+        }
+        catch (err) {
+            // If there was an error writing to this package.json then also delete it from our cache
+            // just in case a future read would get stale data.
+            this.#cache.delete(dir);
+            this.#pathCache.delete(manifest);
+            throw error('Could not write package.json file', {
+                path: filename,
+                cause: err,
+            }, this.write);
+        }
+    }
+    save(manifest) {
+        const dir = this.#pathCache.get(manifest);
+        if (!dir) {
+            throw error('Could not save manifest', {
+                manifest,
+            }, this.save);
+        }
+        this.write(dir, manifest);
+    }
+}
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAoB,MAAM,qBAAqB,CAAA;AAC7D,OAAO,EAAE,UAAU,EAAY,MAAM,eAAe,CAAA;AACpD,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA;AACrD,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AACnC,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAE9C,MAAM,OAAO,WAAW;IACtB;;OAEG;IACH,MAAM,GAAG,IAAI,GAAG,EAAoB,CAAA;IAEpC;;OAEG;IACH,UAAU,GAAG,IAAI,GAAG,EAAoB,CAAA;IAExC;;OAEG;IACH,SAAS,GAAG,IAAI,GAAG,EAA4B,CAAA;IAE/C;;;OAGG;IACH,IAAI,CAAC,GAAW,EAAE,EAAE,MAAM,KAA2B,EAAE;QACrD,MAAM,iBAAiB,GAAG,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;QACzD,IAAI,iBAAiB,EAAE,CAAC;YACtB,OAAO,iBAAiB,CAAA;QAC1B,CAAC;QAED,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,EAAE,cAAc,CAAC,CAAA;QAE7C,MAAM,IAAI,GAAG,CAAC,GAAqB,EAAE,EAAE,CACrC,KAAK,CAAC,kCAAkC,EAAE,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,CAAA;QAE3D,MAAM,WAAW,GAAG,CAAC,MAAM,IAAI,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;QACtD,IAAI,WAAW,EAAE,CAAC;YAChB,MAAM,IAAI,CAAC,WAAW,CAAC,CAAA;QACzB,CAAC;QAED,IAAI,CAAC;YACH,MAAM,GAAG,GAAa,UAAU,CAC9B,KAAK,CAAC,YAAY,CAAC,QAAQ,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,CAAC,CACpD,CAAA;YACD,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,CAAA;YACzB,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,CAAA;YAC7B,OAAO,GAAG,CAAA;QACZ,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,MAAM,EAAE,GAAqB;gBAC3B,IAAI,EAAE,QAAQ;gBACd,KAAK,EAAE,GAAY;aACpB,CAAA;YACD,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,CAAC,CAAA;YAC3B,MAAM,IAAI,CAAC,EAAE,CAAC,CAAA;QAChB,CAAC;IACH,CAAC;IAED,KAAK,CAAC,GAAW,EAAE,QAAkB;QACnC,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,EAAE,cAAc,CAAC,CAAA;QAE7C,IAAI,CAAC;YACH,yFAAyF;YACzF,8EAA8E;YAC9E,aAAa,CAAC,QAAQ,EAAE,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAA;YAC5C,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAA;YAC9B,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAA;QACpC,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,wFAAwF;YACxF,mDAAmD;YACnD,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;YACvB,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;YAChC,MAAM,KAAK,CACT,mCAAmC,EACnC;gBACE,IAAI,EAAE,QAAQ;gBACd,KAAK,EAAE,GAAY;aACpB,EACD,IAAI,CAAC,KAAK,CACX,CAAA;QACH,CAAC;IACH,CAAC;IAED,IAAI,CAAC,QAAkB;QACrB,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;QACzC,IAAI,CAAC,GAAG,EAAE,CAAC;YACT,MAAM,KAAK,CACT,yBAAyB,EACzB;gBACE,QAAQ;aACT,EACD,IAAI,CAAC,IAAI,CACV,CAAA;QACH,CAAC;QACD,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAA;IAC3B,CAAC;CACF","sourcesContent":["import { error, ErrorCauseObject } from '@vltpkg/error-cause'\nimport { asManifest, Manifest } from '@vltpkg/types'\nimport { readFileSync, writeFileSync } from 'node:fs'\nimport { resolve } from 'node:path'\nimport { parse, stringify } from 'polite-json'\n\nexport class PackageJson {\n  /**\n   * cache of `package.json` loads\n   */\n  #cache = new Map<string, Manifest>()\n\n  /**\n   * cache of `package.json` paths by manifest\n   */\n  #pathCache = new Map<Manifest, string>()\n\n  /**\n   * cache of load errors\n   */\n  #errCache = new Map<string, ErrorCauseObject>()\n\n  /**\n   * Reads and parses contents of a `package.json` file at a directory `dir`.\n   * `reload` will optionally skip reading from the cache when set to `true`.\n   */\n  read(dir: string, { reload }: { reload?: boolean } = {}): Manifest {\n    const cachedPackageJson = !reload && this.#cache.get(dir)\n    if (cachedPackageJson) {\n      return cachedPackageJson\n    }\n\n    const filename = resolve(dir, 'package.json')\n\n    const fail = (err: ErrorCauseObject) =>\n      error('Could not read package.json file', err, this.read)\n\n    const cachedError = !reload && this.#errCache.get(dir)\n    if (cachedError) {\n      throw fail(cachedError)\n    }\n\n    try {\n      const res: Manifest = asManifest(\n        parse(readFileSync(filename, { encoding: 'utf8' })),\n      )\n      this.#cache.set(dir, res)\n      this.#pathCache.set(res, dir)\n      return res\n    } catch (err) {\n      const ec: ErrorCauseObject = {\n        path: filename,\n        cause: err as Error,\n      }\n      this.#errCache.set(dir, ec)\n      throw fail(ec)\n    }\n  }\n\n  write(dir: string, manifest: Manifest): void {\n    const filename = resolve(dir, 'package.json')\n\n    try {\n      // This assumes kIndent and kNewline are already present on the manifest because we would\n      // only write a package.json after reading it which will set those properties.\n      writeFileSync(filename, stringify(manifest))\n      this.#cache.set(dir, manifest)\n      this.#pathCache.set(manifest, dir)\n    } catch (err) {\n      // If there was an error writing to this package.json then also delete it from our cache\n      // just in case a future read would get stale data.\n      this.#cache.delete(dir)\n      this.#pathCache.delete(manifest)\n      throw error(\n        'Could not write package.json file',\n        {\n          path: filename,\n          cause: err as Error,\n        },\n        this.write,\n      )\n    }\n  }\n\n  save(manifest: Manifest): void {\n    const dir = this.#pathCache.get(manifest)\n    if (!dir) {\n      throw error(\n        'Could not save manifest',\n        {\n          manifest,\n        },\n        this.save,\n      )\n    }\n    this.write(dir, manifest)\n  }\n}\n"]}

package/dist/esm/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

package/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "@vltpkg/package-json",
+  "description": "Manage reading package.json files",
+  "version": "0.0.0-0.1730239248325",
+  "tshy": {
+    "selfLink": false,
+    "dialects": [
+      "esm"
+    ],
+    "exports": {
+      "./package.json": "./package.json",
+      ".": "./src/index.ts"
+    }
+  },
+  "dependencies": {
+    "polite-json": "^5.0.0",
+    "@vltpkg/error-cause": "0.0.0-0.1730239248325",
+    "@vltpkg/types": "0.0.0-0.1730239248325"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.8.0",
+    "@types/eslint__js": "^8.42.3",
+    "@types/node": "^22.4.1",
+    "eslint": "^9.8.0",
+    "prettier": "^3.3.2",
+    "tap": "^21.0.1",
+    "tshy": "^3.0.2",
+    "typescript": "^5.5.4",
+    "typescript-eslint": "^8.0.1"
+  },
+  "license": "BSD-2-Clause-Patent",
+  "engines": {
+    "node": "20 || >=22"
+  },
+  "tap": {
+    "extends": "../../tap-config.yaml"
+  },
+  "prettier": "../../.prettierrc.js",
+  "module": "./dist/esm/index.js",
+  "type": "module",
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "import": {
+        "types": "./dist/esm/index.d.ts",
+        "default": "./dist/esm/index.js"
+      }
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "format": "prettier --write . --log-level warn --ignore-path ../../.prettierignore --cache",
+    "format:check": "prettier --check . --ignore-path ../../.prettierignore --cache",
+    "lint": "eslint . --fix",
+    "lint:check": "eslint .",
+    "presnap": "tshy",
+    "snap": "tap",
+    "pretest": "tshy",
+    "test": "tap"
+  }
+}