@wo658/redpact 0.3.0 → 0.5.0

package/node_modules/@rushstack/node-core-library/lib/MinimumHeap.js

@@ -0,0 +1,99 @@
+"use strict";
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MinimumHeap = void 0;
+/**
+ * Implements a standard heap data structure for items of type T and a custom comparator.
+ * The root will always be the minimum value as determined by the comparator.
+ *
+ * @public
+ */
+class MinimumHeap {
+    /**
+     * Constructs a new MinimumHeap instance.
+     * @param comparator - a comparator function that determines the order of the items in the heap.
+     *   If the comparator returns a value less than zero, then `a` will be considered less than `b`.
+     *   If the comparator returns zero, then `a` and `b` are considered equal.
+     *   Otherwise, `a` will be considered greater than `b`.
+     */
+    constructor(comparator) {
+        this._items = [];
+        this._comparator = comparator;
+    }
+    /**
+     * Returns the number of items in the heap.
+     * @returns the number of items in the heap.
+     */
+    get size() {
+        return this._items.length;
+    }
+    /**
+     * Retrieves the root item from the heap without removing it.
+     * @returns the root item, or `undefined` if the heap is empty
+     */
+    peek() {
+        return this._items[0];
+    }
+    /**
+     * Retrieves and removes the root item from the heap. The next smallest item will become the new root.
+     * @returns the root item, or `undefined` if the heap is empty
+     */
+    poll() {
+        if (this.size > 0) {
+            const result = this._items[0];
+            const item = this._items.pop();
+            const size = this.size;
+            if (size === 0) {
+                // Short circuit in the trivial case
+                return result;
+            }
+            let index = 0;
+            let smallerChildIndex = 1;
+            while (smallerChildIndex < size) {
+                let smallerChild = this._items[smallerChildIndex];
+                const rightChildIndex = smallerChildIndex + 1;
+                if (rightChildIndex < size) {
+                    const rightChild = this._items[rightChildIndex];
+                    if (this._comparator(rightChild, smallerChild) < 0) {
+                        smallerChildIndex = rightChildIndex;
+                        smallerChild = rightChild;
+                    }
+                }
+                if (this._comparator(smallerChild, item) < 0) {
+                    this._items[index] = smallerChild;
+                    index = smallerChildIndex;
+                    smallerChildIndex = index * 2 + 1;
+                }
+                else {
+                    break;
+                }
+            }
+            // Place the item in its final location satisfying the heap property
+            this._items[index] = item;
+            return result;
+        }
+    }
+    /**
+     * Pushes an item into the heap.
+     * @param item - the item to push
+     */
+    push(item) {
+        let index = this.size;
+        while (index > 0) {
+            // Due to zero-based indexing the parent is not exactly a bit shift
+            const parentIndex = ((index + 1) >> 1) - 1;
+            const parent = this._items[parentIndex];
+            if (this._comparator(item, parent) < 0) {
+                this._items[index] = parent;
+                index = parentIndex;
+            }
+            else {
+                break;
+            }
+        }
+        this._items[index] = item;
+    }
+}
+exports.MinimumHeap = MinimumHeap;
+//# sourceMappingURL=MinimumHeap.js.map

package/node_modules/@rushstack/node-core-library/lib/MinimumHeap.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MinimumHeap.js","sourceRoot":"","sources":["../src/MinimumHeap.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAE3D;;;;;GAKG;AACH,MAAa,WAAW;IAItB;;;;;;OAMG;IACH,YAAmB,UAAkC;QAVpC,WAAM,GAAQ,EAAE,CAAC;QAWhC,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;IAChC,CAAC;IAED;;;OAGG;IACH,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC;IAC5B,CAAC;IAED;;;OAGG;IACI,IAAI;QACT,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IACxB,CAAC;IAED;;;OAGG;IACI,IAAI;QACT,IAAI,IAAI,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;YAClB,MAAM,MAAM,GAAM,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;YACjC,MAAM,IAAI,GAAM,IAAI,CAAC,MAAM,CAAC,GAAG,EAAG,CAAC;YAEnC,MAAM,IAAI,GAAW,IAAI,CAAC,IAAI,CAAC;YAC/B,IAAI,IAAI,KAAK,CAAC,EAAE,CAAC;gBACf,oCAAoC;gBACpC,OAAO,MAAM,CAAC;YAChB,CAAC;YAED,IAAI,KAAK,GAAW,CAAC,CAAC;YAEtB,IAAI,iBAAiB,GAAW,CAAC,CAAC;YAElC,OAAO,iBAAiB,GAAG,IAAI,EAAE,CAAC;gBAChC,IAAI,YAAY,GAAM,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC;gBAErD,MAAM,eAAe,GAAW,iBAAiB,GAAG,CAAC,CAAC;gBAEtD,IAAI,eAAe,GAAG,IAAI,EAAE,CAAC;oBAC3B,MAAM,UAAU,GAAM,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;oBACnD,IAAI,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,YAAY,CAAC,GAAG,CAAC,EAAE,CAAC;wBACnD,iBAAiB,GAAG,eAAe,CAAC;wBACpC,YAAY,GAAG,UAAU,CAAC;oBAC5B,CAAC;gBACH,CAAC;gBAED,IAAI,IAAI,CAAC,WAAW,CAAC,YAAY,EAAE,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;oBAC7C,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,YAAY,CAAC;oBAClC,KAAK,GAAG,iBAAiB,CAAC;oBAC1B,iBAAiB,GAAG,KAAK,GAAG,CAAC,GAAG,CAAC,CAAC;gBACpC,CAAC;qBAAM,CAAC;oBACN,MAAM;gBACR,CAAC;YACH,CAAC;YAED,oEAAoE;YACpE,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC;YAE1B,OAAO,MAAM,CAAC;QAChB,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,IAAI,CAAC,IAAO;QACjB,IAAI,KAAK,GAAW,IAAI,CAAC,IAAI,CAAC;QAC9B,OAAO,KAAK,GAAG,CAAC,EAAE,CAAC;YACjB,mEAAmE;YACnE,MAAM,WAAW,GAAW,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;YACnD,MAAM,MAAM,GAAM,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;YAC3C,IAAI,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC;gBACvC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC;gBAC5B,KAAK,GAAG,WAAW,CAAC;YACtB,CAAC;iBAAM,CAAC;gBACN,MAAM;YACR,CAAC;QACH,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC;IAC5B,CAAC;CACF;AAlGD,kCAkGC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\n/**\n * Implements a standard heap data structure for items of type T and a custom comparator.\n * The root will always be the minimum value as determined by the comparator.\n *\n * @public\n */\nexport class MinimumHeap<T> {\n  private readonly _items: T[] = [];\n  private readonly _comparator: (a: T, b: T) => number;\n\n  /**\n   * Constructs a new MinimumHeap instance.\n   * @param comparator - a comparator function that determines the order of the items in the heap.\n   *   If the comparator returns a value less than zero, then `a` will be considered less than `b`.\n   *   If the comparator returns zero, then `a` and `b` are considered equal.\n   *   Otherwise, `a` will be considered greater than `b`.\n   */\n  public constructor(comparator: (a: T, b: T) => number) {\n    this._comparator = comparator;\n  }\n\n  /**\n   * Returns the number of items in the heap.\n   * @returns the number of items in the heap.\n   */\n  public get size(): number {\n    return this._items.length;\n  }\n\n  /**\n   * Retrieves the root item from the heap without removing it.\n   * @returns the root item, or `undefined` if the heap is empty\n   */\n  public peek(): T | undefined {\n    return this._items[0];\n  }\n\n  /**\n   * Retrieves and removes the root item from the heap. The next smallest item will become the new root.\n   * @returns the root item, or `undefined` if the heap is empty\n   */\n  public poll(): T | undefined {\n    if (this.size > 0) {\n      const result: T = this._items[0];\n      const item: T = this._items.pop()!;\n\n      const size: number = this.size;\n      if (size === 0) {\n        // Short circuit in the trivial case\n        return result;\n      }\n\n      let index: number = 0;\n\n      let smallerChildIndex: number = 1;\n\n      while (smallerChildIndex < size) {\n        let smallerChild: T = this._items[smallerChildIndex];\n\n        const rightChildIndex: number = smallerChildIndex + 1;\n\n        if (rightChildIndex < size) {\n          const rightChild: T = this._items[rightChildIndex];\n          if (this._comparator(rightChild, smallerChild) < 0) {\n            smallerChildIndex = rightChildIndex;\n            smallerChild = rightChild;\n          }\n        }\n\n        if (this._comparator(smallerChild, item) < 0) {\n          this._items[index] = smallerChild;\n          index = smallerChildIndex;\n          smallerChildIndex = index * 2 + 1;\n        } else {\n          break;\n        }\n      }\n\n      // Place the item in its final location satisfying the heap property\n      this._items[index] = item;\n\n      return result;\n    }\n  }\n\n  /**\n   * Pushes an item into the heap.\n   * @param item - the item to push\n   */\n  public push(item: T): void {\n    let index: number = this.size;\n    while (index > 0) {\n      // Due to zero-based indexing the parent is not exactly a bit shift\n      const parentIndex: number = ((index + 1) >> 1) - 1;\n      const parent: T = this._items[parentIndex];\n      if (this._comparator(item, parent) < 0) {\n        this._items[index] = parent;\n        index = parentIndex;\n      } else {\n        break;\n      }\n    }\n    this._items[index] = item;\n  }\n}\n"]}

package/node_modules/@rushstack/node-core-library/lib/PackageJsonLookup.d.ts

@@ -0,0 +1,142 @@
+import type { IPackageJson, INodePackageJson } from './IPackageJson';
+/**
+ * Constructor parameters for {@link PackageJsonLookup}
+ *
+ * @public
+ */
+export interface IPackageJsonLookupParameters {
+    /**
+     * Certain package.json fields such as "contributors" can be very large, and may
+     * significantly increase the memory footprint for the PackageJsonLookup cache.
+     * By default, PackageJsonLookup only loads a subset of standard commonly used
+     * fields names.  Set loadExtraFields=true to always return all fields.
+     */
+    loadExtraFields?: boolean;
+}
+/**
+ * This class provides methods for finding the nearest "package.json" for a folder
+ * and retrieving the name of the package.  The results are cached.
+ *
+ * @public
+ */
+export declare class PackageJsonLookup {
+    private static _instance;
+    /**
+     * A singleton instance of `PackageJsonLookup`, which is useful for short-lived processes
+     * that can reasonably assume that the file system will not be modified after the cache
+     * is populated.
+     *
+     * @remarks
+     * For long-running processes that need to clear the cache at appropriate times,
+     * it is recommended to create your own instance of `PackageJsonLookup` instead
+     * of relying on this instance.
+     */
+    static get instance(): PackageJsonLookup;
+    private _loadExtraFields;
+    private _packageFolderCache;
+    private _packageJsonCache;
+    constructor(parameters?: IPackageJsonLookupParameters);
+    /**
+     * A helper for loading the caller's own package.json file.
+     *
+     * @remarks
+     *
+     * This function provides a concise and efficient way for an NPM package to report metadata about itself.
+     * For example, a tool might want to report its version.
+     *
+     * The `loadOwnPackageJson()` probes upwards from the caller's folder, expecting to find a package.json file,
+     * which is assumed to be the caller's package.  The result is cached, under the assumption that a tool's
+     * own package.json (and intermediary folders) will never change during the lifetime of the process.
+     *
+     * @example
+     * ```ts
+     * // Report the version of our NPM package
+     * const myPackageVersion: string = PackageJsonLookup.loadOwnPackageJson(__dirname).version;
+     * console.log(`Cool Tool - Version ${myPackageVersion}`);
+     * ```
+     *
+     * @param dirnameOfCaller - The NodeJS `__dirname` macro for the caller.
+     * @returns This function always returns a valid `IPackageJson` object.  If any problems are encountered during
+     * loading, an exception will be thrown instead.
+     */
+    static loadOwnPackageJson(dirnameOfCaller: string): IPackageJson;
+    /**
+     * Clears the internal file cache.
+     * @remarks
+     * Call this method if changes have been made to the package.json files on disk.
+     */
+    clearCache(): void;
+    /**
+     * Returns the absolute path of a folder containing a package.json file, by looking
+     * upwards from the specified fileOrFolderPath.  If no package.json can be found,
+     * undefined is returned.
+     *
+     * @remarks
+     * The fileOrFolderPath is not required to actually exist on disk.
+     * The fileOrFolderPath itself can be the return value, if it is a folder containing
+     * a package.json file.
+     * Both positive and negative lookup results are cached.
+     *
+     * @param fileOrFolderPath - a relative or absolute path to a source file or folder
+     * that may be part of a package
+     * @returns an absolute path to a folder containing a package.json file
+     */
+    tryGetPackageFolderFor(fileOrFolderPath: string): string | undefined;
+    /**
+     * If the specified file or folder is part of a package, this returns the absolute path
+     * to the associated package.json file.
+     *
+     * @remarks
+     * The package folder is determined using the same algorithm
+     * as {@link PackageJsonLookup.tryGetPackageFolderFor}.
+     *
+     * @param fileOrFolderPath - a relative or absolute path to a source file or folder
+     * that may be part of a package
+     * @returns an absolute path to * package.json file
+     */
+    tryGetPackageJsonFilePathFor(fileOrFolderPath: string): string | undefined;
+    /**
+     * If the specified file or folder is part of a package, this loads and returns the
+     * associated package.json file.
+     *
+     * @remarks
+     * The package folder is determined using the same algorithm
+     * as {@link PackageJsonLookup.tryGetPackageFolderFor}.
+     *
+     * @param fileOrFolderPath - a relative or absolute path to a source file or folder
+     * that may be part of a package
+     * @returns an IPackageJson object, or undefined if the fileOrFolderPath does not
+     * belong to a package
+     */
+    tryLoadPackageJsonFor(fileOrFolderPath: string): IPackageJson | undefined;
+    /**
+     * This function is similar to {@link PackageJsonLookup.tryLoadPackageJsonFor}, except that it does not report
+     * an error if the `version` field is missing from the package.json file.
+     */
+    tryLoadNodePackageJsonFor(fileOrFolderPath: string): INodePackageJson | undefined;
+    /**
+     * Loads the specified package.json file, if it is not already present in the cache.
+     *
+     * @remarks
+     * Unless {@link IPackageJsonLookupParameters.loadExtraFields} was specified,
+     * the returned IPackageJson object will contain a subset of essential fields.
+     * The returned object should be considered to be immutable; the caller must never
+     * modify it.
+     *
+     * @param jsonFilename - a relative or absolute path to a package.json file
+     */
+    loadPackageJson(jsonFilename: string): IPackageJson;
+    /**
+     * This function is similar to {@link PackageJsonLookup.loadPackageJson}, except that it does not report an error
+     * if the `version` field is missing from the package.json file.
+     */
+    loadNodePackageJson(jsonFilename: string): INodePackageJson;
+    private _loadPackageJsonInner;
+    /**
+     * Try to load a package.json file as an INodePackageJson,
+     * returning undefined if the found file does not contain a `name` field.
+     */
+    private _tryLoadNodePackageJsonInner;
+    private _tryGetPackageFolderFor;
+}
+//# sourceMappingURL=PackageJsonLookup.d.ts.map

package/node_modules/@rushstack/node-core-library/lib/PackageJsonLookup.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PackageJsonLookup.d.ts","sourceRoot":"","sources":["../src/PackageJsonLookup.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAIrE;;;;GAIG;AACH,MAAM,WAAW,4BAA4B;IAC3C;;;;;OAKG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B;AA8BD;;;;;GAKG;AACH,qBAAa,iBAAiB;IAC5B,OAAO,CAAC,MAAM,CAAC,SAAS,CAAgC;IAExD;;;;;;;;;OASG;IACH,WAAkB,QAAQ,IAAI,iBAAiB,CAM9C;IAED,OAAO,CAAC,gBAAgB,CAAkB;IAI1C,OAAO,CAAC,mBAAmB,CAAmC;IAI9D,OAAO,CAAC,iBAAiB,CAA6B;gBAEnC,UAAU,CAAC,EAAE,4BAA4B;IAS5D;;;;;;;;;;;;;;;;;;;;;;OAsBG;WACW,kBAAkB,CAAC,eAAe,EAAE,MAAM,GAAG,YAAY;IAuBvE;;;;OAIG;IACI,UAAU,IAAI,IAAI;IAKzB;;;;;;;;;;;;;;OAcG;IACI,sBAAsB,CAAC,gBAAgB,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAiB3E;;;;;;;;;;;OAWG;IACI,4BAA4B,CAAC,gBAAgB,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAQjF;;;;;;;;;;;;OAYG;IACI,qBAAqB,CAAC,gBAAgB,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS;IAQhF;;;OAGG;IACI,yBAAyB,CAAC,gBAAgB,EAAE,MAAM,GAAG,gBAAgB,GAAG,SAAS;IAQxF;;;;;;;;;;OAUG;IACI,eAAe,CAAC,YAAY,EAAE,MAAM,GAAG,YAAY;IAU1D;;;OAGG;IACI,mBAAmB,CAAC,YAAY,EAAE,MAAM,GAAG,gBAAgB;IAIlE,OAAO,CAAC,qBAAqB;IAkC7B;;;OAGG;IACH,OAAO,CAAC,4BAA4B;IAkEpC,OAAO,CAAC,uBAAuB;CAkChC"}

package/node_modules/@rushstack/node-core-library/lib/PackageJsonLookup.js

@@ -0,0 +1,338 @@
+"use strict";
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PackageJsonLookup = void 0;
+const path = __importStar(require("path"));
+const JsonFile_1 = require("./JsonFile");
+const Constants_1 = require("./Constants");
+const FileSystem_1 = require("./FileSystem");
+/**
+ * This class provides methods for finding the nearest "package.json" for a folder
+ * and retrieving the name of the package.  The results are cached.
+ *
+ * @public
+ */
+class PackageJsonLookup {
+    /**
+     * A singleton instance of `PackageJsonLookup`, which is useful for short-lived processes
+     * that can reasonably assume that the file system will not be modified after the cache
+     * is populated.
+     *
+     * @remarks
+     * For long-running processes that need to clear the cache at appropriate times,
+     * it is recommended to create your own instance of `PackageJsonLookup` instead
+     * of relying on this instance.
+     */
+    static get instance() {
+        if (!PackageJsonLookup._instance) {
+            PackageJsonLookup._instance = new PackageJsonLookup({ loadExtraFields: true });
+        }
+        return PackageJsonLookup._instance;
+    }
+    constructor(parameters) {
+        this._loadExtraFields = false;
+        if (parameters) {
+            if (parameters.loadExtraFields) {
+                this._loadExtraFields = parameters.loadExtraFields;
+            }
+        }
+        this.clearCache();
+    }
+    /**
+     * A helper for loading the caller's own package.json file.
+     *
+     * @remarks
+     *
+     * This function provides a concise and efficient way for an NPM package to report metadata about itself.
+     * For example, a tool might want to report its version.
+     *
+     * The `loadOwnPackageJson()` probes upwards from the caller's folder, expecting to find a package.json file,
+     * which is assumed to be the caller's package.  The result is cached, under the assumption that a tool's
+     * own package.json (and intermediary folders) will never change during the lifetime of the process.
+     *
+     * @example
+     * ```ts
+     * // Report the version of our NPM package
+     * const myPackageVersion: string = PackageJsonLookup.loadOwnPackageJson(__dirname).version;
+     * console.log(`Cool Tool - Version ${myPackageVersion}`);
+     * ```
+     *
+     * @param dirnameOfCaller - The NodeJS `__dirname` macro for the caller.
+     * @returns This function always returns a valid `IPackageJson` object.  If any problems are encountered during
+     * loading, an exception will be thrown instead.
+     */
+    static loadOwnPackageJson(dirnameOfCaller) {
+        const packageJson = PackageJsonLookup.instance.tryLoadPackageJsonFor(dirnameOfCaller);
+        if (packageJson === undefined) {
+            throw new Error(`PackageJsonLookup.loadOwnPackageJson() failed to find the caller's package.json.` +
+                `  The __dirname was: ${dirnameOfCaller}`);
+        }
+        if (packageJson.version !== undefined) {
+            return packageJson;
+        }
+        const errorPath = PackageJsonLookup.instance.tryGetPackageJsonFilePathFor(dirnameOfCaller) || 'package.json';
+        throw new Error(`PackageJsonLookup.loadOwnPackageJson() failed because the "version" field is missing in` +
+            ` ${errorPath}`);
+    }
+    /**
+     * Clears the internal file cache.
+     * @remarks
+     * Call this method if changes have been made to the package.json files on disk.
+     */
+    clearCache() {
+        this._packageFolderCache = new Map();
+        this._packageJsonCache = new Map();
+    }
+    /**
+     * Returns the absolute path of a folder containing a package.json file, by looking
+     * upwards from the specified fileOrFolderPath.  If no package.json can be found,
+     * undefined is returned.
+     *
+     * @remarks
+     * The fileOrFolderPath is not required to actually exist on disk.
+     * The fileOrFolderPath itself can be the return value, if it is a folder containing
+     * a package.json file.
+     * Both positive and negative lookup results are cached.
+     *
+     * @param fileOrFolderPath - a relative or absolute path to a source file or folder
+     * that may be part of a package
+     * @returns an absolute path to a folder containing a package.json file
+     */
+    tryGetPackageFolderFor(fileOrFolderPath) {
+        // Convert it to an absolute path
+        const resolvedFileOrFolderPath = path.resolve(fileOrFolderPath);
+        // Optimistically hope that the starting string is already in the cache,
+        // in which case we can avoid disk access entirely.
+        //
+        // (Two lookups are required, because get() cannot distinguish the undefined value
+        // versus a missing key.)
+        if (this._packageFolderCache.has(resolvedFileOrFolderPath)) {
+            return this._packageFolderCache.get(resolvedFileOrFolderPath);
+        }
+        // Now call the recursive part of the algorithm
+        return this._tryGetPackageFolderFor(resolvedFileOrFolderPath);
+    }
+    /**
+     * If the specified file or folder is part of a package, this returns the absolute path
+     * to the associated package.json file.
+     *
+     * @remarks
+     * The package folder is determined using the same algorithm
+     * as {@link PackageJsonLookup.tryGetPackageFolderFor}.
+     *
+     * @param fileOrFolderPath - a relative or absolute path to a source file or folder
+     * that may be part of a package
+     * @returns an absolute path to * package.json file
+     */
+    tryGetPackageJsonFilePathFor(fileOrFolderPath) {
+        const packageJsonFolder = this.tryGetPackageFolderFor(fileOrFolderPath);
+        if (!packageJsonFolder) {
+            return undefined;
+        }
+        return path.join(packageJsonFolder, Constants_1.FileConstants.PackageJson);
+    }
+    /**
+     * If the specified file or folder is part of a package, this loads and returns the
+     * associated package.json file.
+     *
+     * @remarks
+     * The package folder is determined using the same algorithm
+     * as {@link PackageJsonLookup.tryGetPackageFolderFor}.
+     *
+     * @param fileOrFolderPath - a relative or absolute path to a source file or folder
+     * that may be part of a package
+     * @returns an IPackageJson object, or undefined if the fileOrFolderPath does not
+     * belong to a package
+     */
+    tryLoadPackageJsonFor(fileOrFolderPath) {
+        const packageJsonFilePath = this.tryGetPackageJsonFilePathFor(fileOrFolderPath);
+        if (!packageJsonFilePath) {
+            return undefined;
+        }
+        return this.loadPackageJson(packageJsonFilePath);
+    }
+    /**
+     * This function is similar to {@link PackageJsonLookup.tryLoadPackageJsonFor}, except that it does not report
+     * an error if the `version` field is missing from the package.json file.
+     */
+    tryLoadNodePackageJsonFor(fileOrFolderPath) {
+        const packageJsonFilePath = this.tryGetPackageJsonFilePathFor(fileOrFolderPath);
+        if (!packageJsonFilePath) {
+            return undefined;
+        }
+        return this.loadNodePackageJson(packageJsonFilePath);
+    }
+    /**
+     * Loads the specified package.json file, if it is not already present in the cache.
+     *
+     * @remarks
+     * Unless {@link IPackageJsonLookupParameters.loadExtraFields} was specified,
+     * the returned IPackageJson object will contain a subset of essential fields.
+     * The returned object should be considered to be immutable; the caller must never
+     * modify it.
+     *
+     * @param jsonFilename - a relative or absolute path to a package.json file
+     */
+    loadPackageJson(jsonFilename) {
+        const packageJson = this.loadNodePackageJson(jsonFilename);
+        if (!packageJson.version) {
+            throw new Error(`Error reading "${jsonFilename}":\n  The required field "version" was not found`);
+        }
+        return packageJson;
+    }
+    /**
+     * This function is similar to {@link PackageJsonLookup.loadPackageJson}, except that it does not report an error
+     * if the `version` field is missing from the package.json file.
+     */
+    loadNodePackageJson(jsonFilename) {
+        return this._loadPackageJsonInner(jsonFilename);
+    }
+    _loadPackageJsonInner(jsonFilename, errorsToIgnore) {
+        const loadResult = this._tryLoadNodePackageJsonInner(jsonFilename);
+        if (loadResult.error && (errorsToIgnore === null || errorsToIgnore === void 0 ? void 0 : errorsToIgnore.has(loadResult.error))) {
+            return undefined;
+        }
+        switch (loadResult.error) {
+            case 'FILE_NOT_FOUND': {
+                throw new Error(`Input file not found: ${jsonFilename}`);
+            }
+            case 'MISSING_NAME_FIELD': {
+                throw new Error(`Error reading "${jsonFilename}":\n  The required field "name" was not found`);
+            }
+            case 'OTHER_ERROR': {
+                throw loadResult.errorObject;
+            }
+            default: {
+                return loadResult.packageJson;
+            }
+        }
+    }
+    /**
+     * Try to load a package.json file as an INodePackageJson,
+     * returning undefined if the found file does not contain a `name` field.
+     */
+    _tryLoadNodePackageJsonInner(jsonFilename) {
+        // Since this will be a cache key, follow any symlinks and get an absolute path
+        // to minimize duplication.  (Note that duplication can still occur due to e.g. character case.)
+        let normalizedFilePath;
+        try {
+            normalizedFilePath = FileSystem_1.FileSystem.getRealPath(jsonFilename);
+        }
+        catch (e) {
+            if (FileSystem_1.FileSystem.isNotExistError(e)) {
+                return {
+                    error: 'FILE_NOT_FOUND'
+                };
+            }
+            else {
+                return {
+                    error: 'OTHER_ERROR',
+                    errorObject: e
+                };
+            }
+        }
+        let packageJson = this._packageJsonCache.get(normalizedFilePath);
+        if (!packageJson) {
+            const loadedPackageJson = JsonFile_1.JsonFile.load(normalizedFilePath);
+            // Make sure this is really a package.json file.  CommonJS has fairly strict requirements,
+            // but NPM only requires "name" and "version"
+            if (!loadedPackageJson.name) {
+                return {
+                    error: 'MISSING_NAME_FIELD'
+                };
+            }
+            if (this._loadExtraFields) {
+                packageJson = loadedPackageJson;
+            }
+            else {
+                packageJson = {};
+                // Unless "loadExtraFields" was requested, copy over the essential fields only
+                packageJson.bin = loadedPackageJson.bin;
+                packageJson.dependencies = loadedPackageJson.dependencies;
+                packageJson.description = loadedPackageJson.description;
+                packageJson.devDependencies = loadedPackageJson.devDependencies;
+                packageJson.exports = loadedPackageJson.exports;
+                packageJson.homepage = loadedPackageJson.homepage;
+                packageJson.license = loadedPackageJson.license;
+                packageJson.main = loadedPackageJson.main;
+                packageJson.name = loadedPackageJson.name;
+                packageJson.optionalDependencies = loadedPackageJson.optionalDependencies;
+                packageJson.peerDependencies = loadedPackageJson.peerDependencies;
+                packageJson.private = loadedPackageJson.private;
+                packageJson.scripts = loadedPackageJson.scripts;
+                packageJson.tsdocMetadata = loadedPackageJson.tsdocMetadata;
+                packageJson.typings = loadedPackageJson.typings || loadedPackageJson.types;
+                packageJson.version = loadedPackageJson.version;
+            }
+            Object.freeze(packageJson);
+            this._packageJsonCache.set(normalizedFilePath, packageJson);
+        }
+        return {
+            packageJson
+        };
+    }
+    // Recursive part of the algorithm from tryGetPackageFolderFor()
+    _tryGetPackageFolderFor(resolvedFileOrFolderPath) {
+        // Two lookups are required, because get() cannot distinguish the undefined value
+        // versus a missing key.
+        if (this._packageFolderCache.has(resolvedFileOrFolderPath)) {
+            return this._packageFolderCache.get(resolvedFileOrFolderPath);
+        }
+        // Is resolvedFileOrFolderPath itself a folder with a valid package.json file?  If so, return it.
+        const packageJsonFilePath = `${resolvedFileOrFolderPath}/${Constants_1.FileConstants.PackageJson}`;
+        const packageJson = this._loadPackageJsonInner(packageJsonFilePath, new Set(['FILE_NOT_FOUND', 'MISSING_NAME_FIELD']));
+        if (packageJson) {
+            this._packageFolderCache.set(resolvedFileOrFolderPath, resolvedFileOrFolderPath);
+            return resolvedFileOrFolderPath;
+        }
+        // Otherwise go up one level
+        const parentFolder = path.dirname(resolvedFileOrFolderPath);
+        if (!parentFolder || parentFolder === resolvedFileOrFolderPath) {
+            // We reached the root directory without finding a package.json file,
+            // so cache the negative result
+            this._packageFolderCache.set(resolvedFileOrFolderPath, undefined);
+            return undefined; // no match
+        }
+        // Recurse upwards, caching every step along the way
+        const parentResult = this._tryGetPackageFolderFor(parentFolder);
+        // Cache the parent's answer as well
+        this._packageFolderCache.set(resolvedFileOrFolderPath, parentResult);
+        return parentResult;
+    }
+}
+exports.PackageJsonLookup = PackageJsonLookup;
+//# sourceMappingURL=PackageJsonLookup.js.map

package/node_modules/@rushstack/node-core-library/lib/PackageJsonLookup.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PackageJsonLookup.js","sourceRoot":"","sources":["../src/PackageJsonLookup.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAE3D,2CAA6B;AAC7B,yCAAsC;AAEtC,2CAA4C;AAC5C,6CAA0C;AA6C1C;;;;;GAKG;AACH,MAAa,iBAAiB;IAG5B;;;;;;;;;OASG;IACI,MAAM,KAAK,QAAQ;QACxB,IAAI,CAAC,iBAAiB,CAAC,SAAS,EAAE,CAAC;YACjC,iBAAiB,CAAC,SAAS,GAAG,IAAI,iBAAiB,CAAC,EAAE,eAAe,EAAE,IAAI,EAAE,CAAC,CAAC;QACjF,CAAC;QAED,OAAO,iBAAiB,CAAC,SAAS,CAAC;IACrC,CAAC;IAYD,YAAmB,UAAyC;QAVpD,qBAAgB,GAAY,KAAK,CAAC;QAWxC,IAAI,UAAU,EAAE,CAAC;YACf,IAAI,UAAU,CAAC,eAAe,EAAE,CAAC;gBAC/B,IAAI,CAAC,gBAAgB,GAAG,UAAU,CAAC,eAAe,CAAC;YACrD,CAAC;QACH,CAAC;QACD,IAAI,CAAC,UAAU,EAAE,CAAC;IACpB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACI,MAAM,CAAC,kBAAkB,CAAC,eAAuB;QACtD,MAAM,WAAW,GACf,iBAAiB,CAAC,QAAQ,CAAC,qBAAqB,CAAC,eAAe,CAAC,CAAC;QAEpE,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;YAC9B,MAAM,IAAI,KAAK,CACb,kFAAkF;gBAChF,wBAAwB,eAAe,EAAE,CAC5C,CAAC;QACJ,CAAC;QAED,IAAI,WAAW,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YACtC,OAAO,WAA2B,CAAC;QACrC,CAAC;QAED,MAAM,SAAS,GACb,iBAAiB,CAAC,QAAQ,CAAC,4BAA4B,CAAC,eAAe,CAAC,IAAI,cAAc,CAAC;QAC7F,MAAM,IAAI,KAAK,CACb,yFAAyF;YACvF,IAAI,SAAS,EAAE,CAClB,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACI,UAAU;QACf,IAAI,CAAC,mBAAmB,GAAG,IAAI,GAAG,EAA8B,CAAC;QACjE,IAAI,CAAC,iBAAiB,GAAG,IAAI,GAAG,EAAwB,CAAC;IAC3D,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACI,sBAAsB,CAAC,gBAAwB;QACpD,iCAAiC;QACjC,MAAM,wBAAwB,GAAW,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC;QAExE,wEAAwE;QACxE,mDAAmD;QACnD,EAAE;QACF,kFAAkF;QAClF,yBAAyB;QACzB,IAAI,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,wBAAwB,CAAC,EAAE,CAAC;YAC3D,OAAO,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,wBAAwB,CAAC,CAAC;QAChE,CAAC;QAED,+CAA+C;QAC/C,OAAO,IAAI,CAAC,uBAAuB,CAAC,wBAAwB,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;;;;;;OAWG;IACI,4BAA4B,CAAC,gBAAwB;QAC1D,MAAM,iBAAiB,GAAuB,IAAI,CAAC,sBAAsB,CAAC,gBAAgB,CAAC,CAAC;QAC5F,IAAI,CAAC,iBAAiB,EAAE,CAAC;YACvB,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,OAAO,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,yBAAa,CAAC,WAAW,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;;;;;;;OAYG;IACI,qBAAqB,CAAC,gBAAwB;QACnD,MAAM,mBAAmB,GAAuB,IAAI,CAAC,4BAA4B,CAAC,gBAAgB,CAAC,CAAC;QACpG,IAAI,CAAC,mBAAmB,EAAE,CAAC;YACzB,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,OAAO,IAAI,CAAC,eAAe,CAAC,mBAAmB,CAAC,CAAC;IACnD,CAAC;IAED;;;OAGG;IACI,yBAAyB,CAAC,gBAAwB;QACvD,MAAM,mBAAmB,GAAuB,IAAI,CAAC,4BAA4B,CAAC,gBAAgB,CAAC,CAAC;QACpG,IAAI,CAAC,mBAAmB,EAAE,CAAC;YACzB,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,OAAO,IAAI,CAAC,mBAAmB,CAAC,mBAAmB,CAAC,CAAC;IACvD,CAAC;IAED;;;;;;;;;;OAUG;IACI,eAAe,CAAC,YAAoB;QACzC,MAAM,WAAW,GAAqB,IAAI,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;QAE7E,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,CAAC;YACzB,MAAM,IAAI,KAAK,CAAC,kBAAkB,YAAY,kDAAkD,CAAC,CAAC;QACpG,CAAC;QAED,OAAO,WAA2B,CAAC;IACrC,CAAC;IAED;;;OAGG;IACI,mBAAmB,CAAC,YAAoB;QAC7C,OAAO,IAAI,CAAC,qBAAqB,CAAC,YAAY,CAAC,CAAC;IAClD,CAAC;IAOO,qBAAqB,CAC3B,YAAoB,EACpB,cAAyD;QAEzD,MAAM,UAAU,GAAsC,IAAI,CAAC,4BAA4B,CAAC,YAAY,CAAC,CAAC;QAEtG,IAAI,UAAU,CAAC,KAAK,KAAI,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,CAAA,EAAE,CAAC;YAC9D,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,QAAQ,UAAU,CAAC,KAAK,EAAE,CAAC;YACzB,KAAK,gBAAgB,CAAC,CAAC,CAAC;gBACtB,MAAM,IAAI,KAAK,CAAC,yBAAyB,YAAY,EAAE,CAAC,CAAC;YAC3D,CAAC;YAED,KAAK,oBAAoB,CAAC,CAAC,CAAC;gBAC1B,MAAM,IAAI,KAAK,CAAC,kBAAkB,YAAY,+CAA+C,CAAC,CAAC;YACjG,CAAC;YAED,KAAK,aAAa,CAAC,CAAC,CAAC;gBACnB,MAAM,UAAU,CAAC,WAAW,CAAC;YAC/B,CAAC;YAED,OAAO,CAAC,CAAC,CAAC;gBACR,OAAO,UAAU,CAAC,WAAW,CAAC;YAChC,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;OAGG;IACK,4BAA4B,CAAC,YAAoB;QACvD,+EAA+E;QAC/E,gGAAgG;QAChG,IAAI,kBAA0B,CAAC;QAC/B,IAAI,CAAC;YACH,kBAAkB,GAAG,uBAAU,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;QAC5D,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,IAAI,uBAAU,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE,CAAC;gBAClC,OAAO;oBACL,KAAK,EAAE,gBAAgB;iBACxB,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACN,OAAO;oBACL,KAAK,EAAE,aAAa;oBACpB,WAAW,EAAE,CAAC;iBACf,CAAC;YACJ,CAAC;QACH,CAAC;QAED,IAAI,WAAW,GAA6B,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;QAE3F,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,MAAM,iBAAiB,GAAiB,mBAAQ,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;YAE1E,0FAA0F;YAC1F,6CAA6C;YAC7C,IAAI,CAAC,iBAAiB,CAAC,IAAI,EAAE,CAAC;gBAC5B,OAAO;oBACL,KAAK,EAAE,oBAAoB;iBAC5B,CAAC;YACJ,CAAC;YAED,IAAI,IAAI,CAAC,gBAAgB,EAAE,CAAC;gBAC1B,WAAW,GAAG,iBAAiB,CAAC;YAClC,CAAC;iBAAM,CAAC;gBACN,WAAW,GAAG,EAAkB,CAAC;gBAEjC,8EAA8E;gBAC9E,WAAW,CAAC,GAAG,GAAG,iBAAiB,CAAC,GAAG,CAAC;gBACxC,WAAW,CAAC,YAAY,GAAG,iBAAiB,CAAC,YAAY,CAAC;gBAC1D,WAAW,CAAC,WAAW,GAAG,iBAAiB,CAAC,WAAW,CAAC;gBACxD,WAAW,CAAC,eAAe,GAAG,iBAAiB,CAAC,eAAe,CAAC;gBAChE,WAAW,CAAC,OAAO,GAAG,iBAAiB,CAAC,OAAO,CAAC;gBAChD,WAAW,CAAC,QAAQ,GAAG,iBAAiB,CAAC,QAAQ,CAAC;gBAClD,WAAW,CAAC,OAAO,GAAG,iBAAiB,CAAC,OAAO,CAAC;gBAChD,WAAW,CAAC,IAAI,GAAG,iBAAiB,CAAC,IAAI,CAAC;gBAC1C,WAAW,CAAC,IAAI,GAAG,iBAAiB,CAAC,IAAI,CAAC;gBAC1C,WAAW,CAAC,oBAAoB,GAAG,iBAAiB,CAAC,oBAAoB,CAAC;gBAC1E,WAAW,CAAC,gBAAgB,GAAG,iBAAiB,CAAC,gBAAgB,CAAC;gBAClE,WAAW,CAAC,OAAO,GAAG,iBAAiB,CAAC,OAAO,CAAC;gBAChD,WAAW,CAAC,OAAO,GAAG,iBAAiB,CAAC,OAAO,CAAC;gBAChD,WAAW,CAAC,aAAa,GAAG,iBAAiB,CAAC,aAAa,CAAC;gBAC5D,WAAW,CAAC,OAAO,GAAG,iBAAiB,CAAC,OAAO,IAAI,iBAAiB,CAAC,KAAK,CAAC;gBAC3E,WAAW,CAAC,OAAO,GAAG,iBAAiB,CAAC,OAAO,CAAC;YAClD,CAAC;YAED,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;YAC3B,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,kBAAkB,EAAE,WAAW,CAAC,CAAC;QAC9D,CAAC;QAED,OAAO;YACL,WAAW;SACZ,CAAC;IACJ,CAAC;IAED,gEAAgE;IACxD,uBAAuB,CAAC,wBAAgC;QAC9D,iFAAiF;QACjF,wBAAwB;QACxB,IAAI,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,wBAAwB,CAAC,EAAE,CAAC;YAC3D,OAAO,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,wBAAwB,CAAC,CAAC;QAChE,CAAC;QAED,iGAAiG;QACjG,MAAM,mBAAmB,GAAW,GAAG,wBAAwB,IAAI,yBAAa,CAAC,WAAW,EAAE,CAAC;QAC/F,MAAM,WAAW,GAA6B,IAAI,CAAC,qBAAqB,CACtE,mBAAmB,EACnB,IAAI,GAAG,CAAC,CAAC,gBAAgB,EAAE,oBAAoB,CAAC,CAAC,CAClD,CAAC;QACF,IAAI,WAAW,EAAE,CAAC;YAChB,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,wBAAwB,EAAE,wBAAwB,CAAC,CAAC;YACjF,OAAO,wBAAwB,CAAC;QAClC,CAAC;QAED,4BAA4B;QAC5B,MAAM,YAAY,GAAuB,IAAI,CAAC,OAAO,CAAC,wBAAwB,CAAC,CAAC;QAChF,IAAI,CAAC,YAAY,IAAI,YAAY,KAAK,wBAAwB,EAAE,CAAC;YAC/D,qEAAqE;YACrE,+BAA+B;YAC/B,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,wBAAwB,EAAE,SAAS,CAAC,CAAC;YAClE,OAAO,SAAS,CAAC,CAAC,WAAW;QAC/B,CAAC;QAED,oDAAoD;QACpD,MAAM,YAAY,GAAuB,IAAI,CAAC,uBAAuB,CAAC,YAAY,CAAC,CAAC;QACpF,oCAAoC;QACpC,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,wBAAwB,EAAE,YAAY,CAAC,CAAC;QAErE,OAAO,YAAY,CAAC;IACtB,CAAC;CACF;AA5VD,8CA4VC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\nimport * as path from 'path';\nimport { JsonFile } from './JsonFile';\nimport type { IPackageJson, INodePackageJson } from './IPackageJson';\nimport { FileConstants } from './Constants';\nimport { FileSystem } from './FileSystem';\n\n/**\n * Constructor parameters for {@link PackageJsonLookup}\n *\n * @public\n */\nexport interface IPackageJsonLookupParameters {\n  /**\n   * Certain package.json fields such as \"contributors\" can be very large, and may\n   * significantly increase the memory footprint for the PackageJsonLookup cache.\n   * By default, PackageJsonLookup only loads a subset of standard commonly used\n   * fields names.  Set loadExtraFields=true to always return all fields.\n   */\n  loadExtraFields?: boolean;\n}\n\ntype TryLoadPackageJsonInternalErrorCode =\n  | 'MISSING_NAME_FIELD'\n  | 'FILE_NOT_FOUND'\n  | 'MISSING_VERSION_FIELD'\n  | 'OTHER_ERROR';\n\ninterface ITryLoadPackageJsonInternalSuccessResult {\n  packageJson: IPackageJson;\n  error?: never;\n}\n\ninterface ITryLoadPackageJsonInternalFailureResult {\n  error: TryLoadPackageJsonInternalErrorCode;\n}\ninterface ITryLoadPackageJsonInternalKnownFailureResult extends ITryLoadPackageJsonInternalFailureResult {\n  error: 'MISSING_NAME_FIELD' | 'FILE_NOT_FOUND';\n}\n\ninterface ITryLoadPackageJsonInternalUnknownFailureResult extends ITryLoadPackageJsonInternalFailureResult {\n  error: 'OTHER_ERROR';\n  errorObject: Error;\n}\n\ntype ITryLoadPackageJsonInternalResult =\n  | ITryLoadPackageJsonInternalSuccessResult\n  | ITryLoadPackageJsonInternalKnownFailureResult\n  | ITryLoadPackageJsonInternalUnknownFailureResult;\n\n/**\n * This class provides methods for finding the nearest \"package.json\" for a folder\n * and retrieving the name of the package.  The results are cached.\n *\n * @public\n */\nexport class PackageJsonLookup {\n  private static _instance: PackageJsonLookup | undefined;\n\n  /**\n   * A singleton instance of `PackageJsonLookup`, which is useful for short-lived processes\n   * that can reasonably assume that the file system will not be modified after the cache\n   * is populated.\n   *\n   * @remarks\n   * For long-running processes that need to clear the cache at appropriate times,\n   * it is recommended to create your own instance of `PackageJsonLookup` instead\n   * of relying on this instance.\n   */\n  public static get instance(): PackageJsonLookup {\n    if (!PackageJsonLookup._instance) {\n      PackageJsonLookup._instance = new PackageJsonLookup({ loadExtraFields: true });\n    }\n\n    return PackageJsonLookup._instance;\n  }\n\n  private _loadExtraFields: boolean = false;\n\n  // Cached the return values for tryGetPackageFolder():\n  // sourceFilePath --> packageJsonFolder\n  private _packageFolderCache!: Map<string, string | undefined>;\n\n  // Cached the return values for getPackageName():\n  // packageJsonPath --> packageName\n  private _packageJsonCache!: Map<string, IPackageJson>;\n\n  public constructor(parameters?: IPackageJsonLookupParameters) {\n    if (parameters) {\n      if (parameters.loadExtraFields) {\n        this._loadExtraFields = parameters.loadExtraFields;\n      }\n    }\n    this.clearCache();\n  }\n\n  /**\n   * A helper for loading the caller's own package.json file.\n   *\n   * @remarks\n   *\n   * This function provides a concise and efficient way for an NPM package to report metadata about itself.\n   * For example, a tool might want to report its version.\n   *\n   * The `loadOwnPackageJson()` probes upwards from the caller's folder, expecting to find a package.json file,\n   * which is assumed to be the caller's package.  The result is cached, under the assumption that a tool's\n   * own package.json (and intermediary folders) will never change during the lifetime of the process.\n   *\n   * @example\n   * ```ts\n   * // Report the version of our NPM package\n   * const myPackageVersion: string = PackageJsonLookup.loadOwnPackageJson(__dirname).version;\n   * console.log(`Cool Tool - Version ${myPackageVersion}`);\n   * ```\n   *\n   * @param dirnameOfCaller - The NodeJS `__dirname` macro for the caller.\n   * @returns This function always returns a valid `IPackageJson` object.  If any problems are encountered during\n   * loading, an exception will be thrown instead.\n   */\n  public static loadOwnPackageJson(dirnameOfCaller: string): IPackageJson {\n    const packageJson: IPackageJson | undefined =\n      PackageJsonLookup.instance.tryLoadPackageJsonFor(dirnameOfCaller);\n\n    if (packageJson === undefined) {\n      throw new Error(\n        `PackageJsonLookup.loadOwnPackageJson() failed to find the caller's package.json.` +\n          `  The __dirname was: ${dirnameOfCaller}`\n      );\n    }\n\n    if (packageJson.version !== undefined) {\n      return packageJson as IPackageJson;\n    }\n\n    const errorPath: string =\n      PackageJsonLookup.instance.tryGetPackageJsonFilePathFor(dirnameOfCaller) || 'package.json';\n    throw new Error(\n      `PackageJsonLookup.loadOwnPackageJson() failed because the \"version\" field is missing in` +\n        ` ${errorPath}`\n    );\n  }\n\n  /**\n   * Clears the internal file cache.\n   * @remarks\n   * Call this method if changes have been made to the package.json files on disk.\n   */\n  public clearCache(): void {\n    this._packageFolderCache = new Map<string, string | undefined>();\n    this._packageJsonCache = new Map<string, IPackageJson>();\n  }\n\n  /**\n   * Returns the absolute path of a folder containing a package.json file, by looking\n   * upwards from the specified fileOrFolderPath.  If no package.json can be found,\n   * undefined is returned.\n   *\n   * @remarks\n   * The fileOrFolderPath is not required to actually exist on disk.\n   * The fileOrFolderPath itself can be the return value, if it is a folder containing\n   * a package.json file.\n   * Both positive and negative lookup results are cached.\n   *\n   * @param fileOrFolderPath - a relative or absolute path to a source file or folder\n   * that may be part of a package\n   * @returns an absolute path to a folder containing a package.json file\n   */\n  public tryGetPackageFolderFor(fileOrFolderPath: string): string | undefined {\n    // Convert it to an absolute path\n    const resolvedFileOrFolderPath: string = path.resolve(fileOrFolderPath);\n\n    // Optimistically hope that the starting string is already in the cache,\n    // in which case we can avoid disk access entirely.\n    //\n    // (Two lookups are required, because get() cannot distinguish the undefined value\n    // versus a missing key.)\n    if (this._packageFolderCache.has(resolvedFileOrFolderPath)) {\n      return this._packageFolderCache.get(resolvedFileOrFolderPath);\n    }\n\n    // Now call the recursive part of the algorithm\n    return this._tryGetPackageFolderFor(resolvedFileOrFolderPath);\n  }\n\n  /**\n   * If the specified file or folder is part of a package, this returns the absolute path\n   * to the associated package.json file.\n   *\n   * @remarks\n   * The package folder is determined using the same algorithm\n   * as {@link PackageJsonLookup.tryGetPackageFolderFor}.\n   *\n   * @param fileOrFolderPath - a relative or absolute path to a source file or folder\n   * that may be part of a package\n   * @returns an absolute path to * package.json file\n   */\n  public tryGetPackageJsonFilePathFor(fileOrFolderPath: string): string | undefined {\n    const packageJsonFolder: string | undefined = this.tryGetPackageFolderFor(fileOrFolderPath);\n    if (!packageJsonFolder) {\n      return undefined;\n    }\n    return path.join(packageJsonFolder, FileConstants.PackageJson);\n  }\n\n  /**\n   * If the specified file or folder is part of a package, this loads and returns the\n   * associated package.json file.\n   *\n   * @remarks\n   * The package folder is determined using the same algorithm\n   * as {@link PackageJsonLookup.tryGetPackageFolderFor}.\n   *\n   * @param fileOrFolderPath - a relative or absolute path to a source file or folder\n   * that may be part of a package\n   * @returns an IPackageJson object, or undefined if the fileOrFolderPath does not\n   * belong to a package\n   */\n  public tryLoadPackageJsonFor(fileOrFolderPath: string): IPackageJson | undefined {\n    const packageJsonFilePath: string | undefined = this.tryGetPackageJsonFilePathFor(fileOrFolderPath);\n    if (!packageJsonFilePath) {\n      return undefined;\n    }\n    return this.loadPackageJson(packageJsonFilePath);\n  }\n\n  /**\n   * This function is similar to {@link PackageJsonLookup.tryLoadPackageJsonFor}, except that it does not report\n   * an error if the `version` field is missing from the package.json file.\n   */\n  public tryLoadNodePackageJsonFor(fileOrFolderPath: string): INodePackageJson | undefined {\n    const packageJsonFilePath: string | undefined = this.tryGetPackageJsonFilePathFor(fileOrFolderPath);\n    if (!packageJsonFilePath) {\n      return undefined;\n    }\n    return this.loadNodePackageJson(packageJsonFilePath);\n  }\n\n  /**\n   * Loads the specified package.json file, if it is not already present in the cache.\n   *\n   * @remarks\n   * Unless {@link IPackageJsonLookupParameters.loadExtraFields} was specified,\n   * the returned IPackageJson object will contain a subset of essential fields.\n   * The returned object should be considered to be immutable; the caller must never\n   * modify it.\n   *\n   * @param jsonFilename - a relative or absolute path to a package.json file\n   */\n  public loadPackageJson(jsonFilename: string): IPackageJson {\n    const packageJson: INodePackageJson = this.loadNodePackageJson(jsonFilename);\n\n    if (!packageJson.version) {\n      throw new Error(`Error reading \"${jsonFilename}\":\\n  The required field \"version\" was not found`);\n    }\n\n    return packageJson as IPackageJson;\n  }\n\n  /**\n   * This function is similar to {@link PackageJsonLookup.loadPackageJson}, except that it does not report an error\n   * if the `version` field is missing from the package.json file.\n   */\n  public loadNodePackageJson(jsonFilename: string): INodePackageJson {\n    return this._loadPackageJsonInner(jsonFilename);\n  }\n\n  private _loadPackageJsonInner(jsonFilename: string): IPackageJson;\n  private _loadPackageJsonInner(\n    jsonFilename: string,\n    errorsToIgnore: Set<TryLoadPackageJsonInternalErrorCode>\n  ): IPackageJson | undefined;\n  private _loadPackageJsonInner(\n    jsonFilename: string,\n    errorsToIgnore?: Set<TryLoadPackageJsonInternalErrorCode>\n  ): IPackageJson | undefined {\n    const loadResult: ITryLoadPackageJsonInternalResult = this._tryLoadNodePackageJsonInner(jsonFilename);\n\n    if (loadResult.error && errorsToIgnore?.has(loadResult.error)) {\n      return undefined;\n    }\n\n    switch (loadResult.error) {\n      case 'FILE_NOT_FOUND': {\n        throw new Error(`Input file not found: ${jsonFilename}`);\n      }\n\n      case 'MISSING_NAME_FIELD': {\n        throw new Error(`Error reading \"${jsonFilename}\":\\n  The required field \"name\" was not found`);\n      }\n\n      case 'OTHER_ERROR': {\n        throw loadResult.errorObject;\n      }\n\n      default: {\n        return loadResult.packageJson;\n      }\n    }\n  }\n\n  /**\n   * Try to load a package.json file as an INodePackageJson,\n   * returning undefined if the found file does not contain a `name` field.\n   */\n  private _tryLoadNodePackageJsonInner(jsonFilename: string): ITryLoadPackageJsonInternalResult {\n    // Since this will be a cache key, follow any symlinks and get an absolute path\n    // to minimize duplication.  (Note that duplication can still occur due to e.g. character case.)\n    let normalizedFilePath: string;\n    try {\n      normalizedFilePath = FileSystem.getRealPath(jsonFilename);\n    } catch (e) {\n      if (FileSystem.isNotExistError(e)) {\n        return {\n          error: 'FILE_NOT_FOUND'\n        };\n      } else {\n        return {\n          error: 'OTHER_ERROR',\n          errorObject: e\n        };\n      }\n    }\n\n    let packageJson: IPackageJson | undefined = this._packageJsonCache.get(normalizedFilePath);\n\n    if (!packageJson) {\n      const loadedPackageJson: IPackageJson = JsonFile.load(normalizedFilePath);\n\n      // Make sure this is really a package.json file.  CommonJS has fairly strict requirements,\n      // but NPM only requires \"name\" and \"version\"\n      if (!loadedPackageJson.name) {\n        return {\n          error: 'MISSING_NAME_FIELD'\n        };\n      }\n\n      if (this._loadExtraFields) {\n        packageJson = loadedPackageJson;\n      } else {\n        packageJson = {} as IPackageJson;\n\n        // Unless \"loadExtraFields\" was requested, copy over the essential fields only\n        packageJson.bin = loadedPackageJson.bin;\n        packageJson.dependencies = loadedPackageJson.dependencies;\n        packageJson.description = loadedPackageJson.description;\n        packageJson.devDependencies = loadedPackageJson.devDependencies;\n        packageJson.exports = loadedPackageJson.exports;\n        packageJson.homepage = loadedPackageJson.homepage;\n        packageJson.license = loadedPackageJson.license;\n        packageJson.main = loadedPackageJson.main;\n        packageJson.name = loadedPackageJson.name;\n        packageJson.optionalDependencies = loadedPackageJson.optionalDependencies;\n        packageJson.peerDependencies = loadedPackageJson.peerDependencies;\n        packageJson.private = loadedPackageJson.private;\n        packageJson.scripts = loadedPackageJson.scripts;\n        packageJson.tsdocMetadata = loadedPackageJson.tsdocMetadata;\n        packageJson.typings = loadedPackageJson.typings || loadedPackageJson.types;\n        packageJson.version = loadedPackageJson.version;\n      }\n\n      Object.freeze(packageJson);\n      this._packageJsonCache.set(normalizedFilePath, packageJson);\n    }\n\n    return {\n      packageJson\n    };\n  }\n\n  // Recursive part of the algorithm from tryGetPackageFolderFor()\n  private _tryGetPackageFolderFor(resolvedFileOrFolderPath: string): string | undefined {\n    // Two lookups are required, because get() cannot distinguish the undefined value\n    // versus a missing key.\n    if (this._packageFolderCache.has(resolvedFileOrFolderPath)) {\n      return this._packageFolderCache.get(resolvedFileOrFolderPath);\n    }\n\n    // Is resolvedFileOrFolderPath itself a folder with a valid package.json file?  If so, return it.\n    const packageJsonFilePath: string = `${resolvedFileOrFolderPath}/${FileConstants.PackageJson}`;\n    const packageJson: IPackageJson | undefined = this._loadPackageJsonInner(\n      packageJsonFilePath,\n      new Set(['FILE_NOT_FOUND', 'MISSING_NAME_FIELD'])\n    );\n    if (packageJson) {\n      this._packageFolderCache.set(resolvedFileOrFolderPath, resolvedFileOrFolderPath);\n      return resolvedFileOrFolderPath;\n    }\n\n    // Otherwise go up one level\n    const parentFolder: string | undefined = path.dirname(resolvedFileOrFolderPath);\n    if (!parentFolder || parentFolder === resolvedFileOrFolderPath) {\n      // We reached the root directory without finding a package.json file,\n      // so cache the negative result\n      this._packageFolderCache.set(resolvedFileOrFolderPath, undefined);\n      return undefined; // no match\n    }\n\n    // Recurse upwards, caching every step along the way\n    const parentResult: string | undefined = this._tryGetPackageFolderFor(parentFolder);\n    // Cache the parent's answer as well\n    this._packageFolderCache.set(resolvedFileOrFolderPath, parentResult);\n\n    return parentResult;\n  }\n}\n"]}