@wo658/redpact 0.4.1 → 0.5.0

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

@@ -0,0 +1,438 @@
+"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.JsonFile = exports.JsonSyntax = void 0;
+const os = __importStar(require("os"));
+const jju = __importStar(require("jju"));
+const Text_1 = require("./Text");
+const FileSystem_1 = require("./FileSystem");
+/**
+ * Specifies the variant of JSON syntax to be used.
+ *
+ * @public
+ */
+var JsonSyntax;
+(function (JsonSyntax) {
+    /**
+     * Specifies the exact RFC 8259 format as implemented by the `JSON.parse()` system API.
+     * This format was designed for machine generated inputs such as an HTTP payload.
+     * It is not a recommend choice for human-authored files, because it does not support
+     * code comments.
+     *
+     * @remarks
+     *
+     * A well-known quote from Douglas Crockford, the inventor of JSON:
+     *
+     * "I removed comments from JSON because I saw people were using them to hold parsing directives,
+     * a practice which would have destroyed interoperability.  I know that the lack of comments makes
+     * some people sad, but it shouldn't.  Suppose you are using JSON to keep configuration files,
+     * which you would like to annotate.  Go ahead and insert all the comments you like.
+     * Then pipe it through JSMin before handing it to your JSON parser."
+     *
+     * @see {@link https://datatracker.ietf.org/doc/html/rfc8259 | RFC 8259}
+     */
+    JsonSyntax["Strict"] = "strict";
+    /**
+     * `JsonSyntax.JsonWithComments` is the recommended format for human-authored config files.
+     * It is a minimal extension to `JsonSyntax.Strict` adding support for code comments
+     * using `//` and `/*`.
+     *
+     * @remarks
+     *
+     * VS Code calls this format `jsonc`, but it should not be confused with unrelated file formats
+     * and libraries that also use the name "JSONC".
+     *
+     * To fix VS Code syntax highlighting, add this setting:
+     * `"files.associations": { "*.json": "jsonc" }`
+     *
+     * To fix GitHub syntax highlighting, add this to your `.gitattributes`:
+     * `*.json linguist-language=JSON-with-Comments`
+     */
+    JsonSyntax["JsonWithComments"] = "jsonWithComments";
+    /**
+     * JSON5 is a project that proposes a JSON-like format supplemented with ECMAScript 5.1
+     * notations for objects, numbers, comments, and more.
+     *
+     * @remarks
+     * Files using this format should use the `.json5` file extension instead of `.json`.
+     *
+     * JSON5 has substantial differences from JSON: object keys may be unquoted, trailing commas
+     * are allowed, and strings may span multiple lines.  Whereas {@link JsonSyntax.JsonWithComments} can
+     * be cheaply converted to standard JSON by stripping comments, parsing JSON5 requires a
+     * nontrivial algorithm that may not be easily available in some contexts or programming languages.
+     *
+     * @see {@link https://json5.org/ | JSON5 project website}
+     */
+    JsonSyntax["Json5"] = "json5";
+})(JsonSyntax || (exports.JsonSyntax = JsonSyntax = {}));
+const DEFAULT_ENCODING = 'utf8';
+/**
+ * Utilities for reading/writing JSON files.
+ * @public
+ */
+class JsonFile {
+    /**
+     * Loads a JSON file.
+     */
+    static load(jsonFilename, options) {
+        try {
+            const contents = FileSystem_1.FileSystem.readFile(jsonFilename);
+            const parseOptions = JsonFile._buildJjuParseOptions(options);
+            return jju.parse(contents, parseOptions);
+        }
+        catch (error) {
+            if (FileSystem_1.FileSystem.isNotExistError(error)) {
+                throw error;
+            }
+            else {
+                throw new Error(`Error reading "${JsonFile._formatPathForError(jsonFilename)}":` +
+                    os.EOL +
+                    `  ${error.message}`);
+            }
+        }
+    }
+    /**
+     * An async version of {@link JsonFile.load}.
+     */
+    static async loadAsync(jsonFilename, options) {
+        try {
+            const contents = await FileSystem_1.FileSystem.readFileAsync(jsonFilename);
+            const parseOptions = JsonFile._buildJjuParseOptions(options);
+            return jju.parse(contents, parseOptions);
+        }
+        catch (error) {
+            if (FileSystem_1.FileSystem.isNotExistError(error)) {
+                throw error;
+            }
+            else {
+                throw new Error(`Error reading "${JsonFile._formatPathForError(jsonFilename)}":` +
+                    os.EOL +
+                    `  ${error.message}`);
+            }
+        }
+    }
+    /**
+     * Parses a JSON file's contents.
+     */
+    static parseString(jsonContents, options) {
+        const parseOptions = JsonFile._buildJjuParseOptions(options);
+        return jju.parse(jsonContents, parseOptions);
+    }
+    /**
+     * Loads a JSON file and validate its schema.
+     */
+    static loadAndValidate(jsonFilename, jsonSchema, options) {
+        const jsonObject = JsonFile.load(jsonFilename, options);
+        jsonSchema.validateObject(jsonObject, jsonFilename, options);
+        return jsonObject;
+    }
+    /**
+     * An async version of {@link JsonFile.loadAndValidate}.
+     */
+    static async loadAndValidateAsync(jsonFilename, jsonSchema, options) {
+        const jsonObject = await JsonFile.loadAsync(jsonFilename, options);
+        jsonSchema.validateObject(jsonObject, jsonFilename, options);
+        return jsonObject;
+    }
+    /**
+     * Loads a JSON file and validate its schema, reporting errors using a callback
+     * @remarks
+     * See JsonSchema.validateObjectWithCallback() for more info.
+     */
+    static loadAndValidateWithCallback(jsonFilename, jsonSchema, errorCallback, options) {
+        const jsonObject = JsonFile.load(jsonFilename, options);
+        jsonSchema.validateObjectWithCallback(jsonObject, errorCallback);
+        return jsonObject;
+    }
+    /**
+     * An async version of {@link JsonFile.loadAndValidateWithCallback}.
+     */
+    static async loadAndValidateWithCallbackAsync(jsonFilename, jsonSchema, errorCallback, options) {
+        const jsonObject = await JsonFile.loadAsync(jsonFilename, options);
+        jsonSchema.validateObjectWithCallback(jsonObject, errorCallback);
+        return jsonObject;
+    }
+    /**
+     * Serializes the specified JSON object to a string buffer.
+     * @param jsonObject - the object to be serialized
+     * @param options - other settings that control serialization
+     * @returns a JSON string, with newlines, and indented with two spaces
+     */
+    static stringify(jsonObject, options) {
+        return JsonFile.updateString('', jsonObject, options);
+    }
+    /**
+     * Serializes the specified JSON object to a string buffer.
+     * @param previousJson - the previous JSON string, which will be updated
+     * @param newJsonObject - the object to be serialized
+     * @param options - other settings that control serialization
+     * @returns a JSON string, with newlines, and indented with two spaces
+     */
+    static updateString(previousJson, newJsonObject, options = {}) {
+        if (!options.ignoreUndefinedValues) {
+            // Standard handling of `undefined` in JSON stringification is to discard the key.
+            JsonFile.validateNoUndefinedMembers(newJsonObject);
+        }
+        let explicitMode = undefined;
+        switch (options.jsonSyntax) {
+            case JsonSyntax.Strict:
+                explicitMode = 'json';
+                break;
+            case JsonSyntax.JsonWithComments:
+                explicitMode = 'cjson';
+                break;
+            case JsonSyntax.Json5:
+                explicitMode = 'json5';
+                break;
+        }
+        let stringified;
+        if (previousJson !== '') {
+            // NOTE: We don't use mode=json here because comments aren't allowed by strict JSON
+            stringified = jju.update(previousJson, newJsonObject, {
+                mode: explicitMode !== null && explicitMode !== void 0 ? explicitMode : JsonSyntax.Json5,
+                indent: 2
+            });
+        }
+        else if (options.prettyFormatting) {
+            stringified = jju.stringify(newJsonObject, {
+                mode: explicitMode !== null && explicitMode !== void 0 ? explicitMode : 'json',
+                indent: 2
+            });
+            if (options.headerComment !== undefined) {
+                stringified = JsonFile._formatJsonHeaderComment(options.headerComment) + stringified;
+            }
+        }
+        else {
+            stringified = JSON.stringify(newJsonObject, undefined, 2);
+            if (options.headerComment !== undefined) {
+                stringified = JsonFile._formatJsonHeaderComment(options.headerComment) + stringified;
+            }
+        }
+        // Add the trailing newline
+        stringified = Text_1.Text.ensureTrailingNewline(stringified);
+        if (options.newlineConversion) {
+            stringified = Text_1.Text.convertTo(stringified, options.newlineConversion);
+        }
+        return stringified;
+    }
+    /**
+     * Saves the file to disk.  Returns false if nothing was written due to options.onlyIfChanged.
+     * @param jsonObject - the object to be saved
+     * @param jsonFilename - the file path to write
+     * @param options - other settings that control how the file is saved
+     * @returns false if ISaveJsonFileOptions.onlyIfChanged didn't save anything; true otherwise
+     */
+    static save(jsonObject, jsonFilename, options = {}) {
+        // Do we need to read the previous file contents?
+        let oldBuffer = undefined;
+        if (options.updateExistingFile || options.onlyIfChanged) {
+            try {
+                oldBuffer = FileSystem_1.FileSystem.readFileToBuffer(jsonFilename);
+            }
+            catch (error) {
+                if (!FileSystem_1.FileSystem.isNotExistError(error)) {
+                    throw error;
+                }
+            }
+        }
+        let jsonToUpdate = '';
+        if (options.updateExistingFile && oldBuffer) {
+            jsonToUpdate = oldBuffer.toString(DEFAULT_ENCODING);
+        }
+        const newJson = JsonFile.updateString(jsonToUpdate, jsonObject, options);
+        const newBuffer = Buffer.from(newJson, DEFAULT_ENCODING);
+        if (options.onlyIfChanged) {
+            // Has the file changed?
+            if (oldBuffer && Buffer.compare(newBuffer, oldBuffer) === 0) {
+                // Nothing has changed, so don't touch the file
+                return false;
+            }
+        }
+        FileSystem_1.FileSystem.writeFile(jsonFilename, newBuffer, {
+            ensureFolderExists: options.ensureFolderExists
+        });
+        // TEST CODE: Used to verify that onlyIfChanged isn't broken by a hidden transformation during saving.
+        /*
+        const oldBuffer2: Buffer = FileSystem.readFileToBuffer(jsonFilename);
+        if (Buffer.compare(buffer, oldBuffer2) !== 0) {
+          console.log('new:' + buffer.toString('hex'));
+          console.log('old:' + oldBuffer2.toString('hex'));
+    
+          throw new Error('onlyIfChanged logic is broken');
+        }
+        */
+        return true;
+    }
+    /**
+     * An async version of {@link JsonFile.save}.
+     */
+    static async saveAsync(jsonObject, jsonFilename, options = {}) {
+        // Do we need to read the previous file contents?
+        let oldBuffer = undefined;
+        if (options.updateExistingFile || options.onlyIfChanged) {
+            try {
+                oldBuffer = await FileSystem_1.FileSystem.readFileToBufferAsync(jsonFilename);
+            }
+            catch (error) {
+                if (!FileSystem_1.FileSystem.isNotExistError(error)) {
+                    throw error;
+                }
+            }
+        }
+        let jsonToUpdate = '';
+        if (options.updateExistingFile && oldBuffer) {
+            jsonToUpdate = oldBuffer.toString(DEFAULT_ENCODING);
+        }
+        const newJson = JsonFile.updateString(jsonToUpdate, jsonObject, options);
+        const newBuffer = Buffer.from(newJson, DEFAULT_ENCODING);
+        if (options.onlyIfChanged) {
+            // Has the file changed?
+            if (oldBuffer && Buffer.compare(newBuffer, oldBuffer) === 0) {
+                // Nothing has changed, so don't touch the file
+                return false;
+            }
+        }
+        await FileSystem_1.FileSystem.writeFileAsync(jsonFilename, newBuffer, {
+            ensureFolderExists: options.ensureFolderExists
+        });
+        // TEST CODE: Used to verify that onlyIfChanged isn't broken by a hidden transformation during saving.
+        /*
+        const oldBuffer2: Buffer = await FileSystem.readFileToBufferAsync(jsonFilename);
+        if (Buffer.compare(buffer, oldBuffer2) !== 0) {
+          console.log('new:' + buffer.toString('hex'));
+          console.log('old:' + oldBuffer2.toString('hex'));
+    
+          throw new Error('onlyIfChanged logic is broken');
+        }
+        */
+        return true;
+    }
+    /**
+     * Used to validate a data structure before writing.  Reports an error if there
+     * are any undefined members.
+     */
+    static validateNoUndefinedMembers(jsonObject) {
+        return JsonFile._validateNoUndefinedMembers(jsonObject, []);
+    }
+    // Private implementation of validateNoUndefinedMembers()
+    static _validateNoUndefinedMembers(jsonObject, keyPath) {
+        if (!jsonObject) {
+            return;
+        }
+        if (typeof jsonObject === 'object') {
+            for (const key of Object.keys(jsonObject)) {
+                keyPath.push(key);
+                // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                const value = jsonObject[key];
+                if (value === undefined) {
+                    const fullPath = JsonFile._formatKeyPath(keyPath);
+                    throw new Error(`The value for ${fullPath} is "undefined" and cannot be serialized as JSON`);
+                }
+                JsonFile._validateNoUndefinedMembers(value, keyPath);
+                keyPath.pop();
+            }
+        }
+    }
+    // Given this input:    ['items', '4', 'syntax', 'parameters', 'string "with" symbols", 'type']
+    // Return this string:  items[4].syntax.parameters["string \"with\" symbols"].type
+    static _formatKeyPath(keyPath) {
+        let result = '';
+        for (const key of keyPath) {
+            if (/^[0-9]+$/.test(key)) {
+                // It's an integer, so display like this:  parent[123]
+                result += `[${key}]`;
+            }
+            else if (/^[a-z_][a-z_0-9]*$/i.test(key)) {
+                // It's an alphanumeric identifier, so display like this:  parent.name
+                if (result) {
+                    result += '.';
+                }
+                result += `${key}`;
+            }
+            else {
+                // It's a freeform string, so display like this:  parent["A path: \"C:\\file\""]
+                // Convert this:     A path: "C:\file"
+                // To this:          A path: \"C:\\file\"
+                const escapedKey = key
+                    .replace(/[\\]/g, '\\\\') // escape backslashes
+                    .replace(/["]/g, '\\'); // escape quotes
+                result += `["${escapedKey}"]`;
+            }
+        }
+        return result;
+    }
+    static _formatJsonHeaderComment(headerComment) {
+        if (headerComment === '') {
+            return '';
+        }
+        const lines = headerComment.split('\n');
+        const result = [];
+        for (const line of lines) {
+            if (!/^\s*$/.test(line) && !/^\s*\/\//.test(line)) {
+                throw new Error('The headerComment lines must be blank or start with the "//" prefix.\n' +
+                    'Invalid line' +
+                    JSON.stringify(line));
+            }
+            result.push(Text_1.Text.replaceAll(line, '\r', ''));
+        }
+        return lines.join('\n') + '\n';
+    }
+    static _buildJjuParseOptions(options = {}) {
+        const parseOptions = {
+            reserved_keys: 'replace'
+        };
+        switch (options.jsonSyntax) {
+            case JsonSyntax.Strict:
+                parseOptions.mode = 'json';
+                break;
+            case JsonSyntax.JsonWithComments:
+                parseOptions.mode = 'cjson';
+                break;
+            case JsonSyntax.Json5:
+            default:
+                parseOptions.mode = 'json5';
+                break;
+        }
+        return parseOptions;
+    }
+}
+exports.JsonFile = JsonFile;
+/**
+ * @internal
+ */
+JsonFile._formatPathForError = (path) => path;
+//# sourceMappingURL=JsonFile.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"JsonFile.js","sourceRoot":"","sources":["../src/JsonFile.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAE3D,uCAAyB;AACzB,yCAA2B;AAG3B,iCAAgD;AAChD,6CAA0C;AAgC1C;;;;GAIG;AACH,IAAY,UAsDX;AAtDD,WAAY,UAAU;IACpB;;;;;;;;;;;;;;;;;OAiBG;IACH,+BAAiB,CAAA;IAEjB;;;;;;;;;;;;;;;OAeG;IACH,mDAAqC,CAAA;IAErC;;;;;;;;;;;;;OAaG;IACH,6BAAe,CAAA;AACjB,CAAC,EAtDW,UAAU,0BAAV,UAAU,QAsDrB;AAmGD,MAAM,gBAAgB,GAAW,MAAM,CAAC;AAExC;;;GAGG;AACH,MAAa,QAAQ;IAMnB;;OAEG;IACI,MAAM,CAAC,IAAI,CAAC,YAAoB,EAAE,OAA+B;QACtE,IAAI,CAAC;YACH,MAAM,QAAQ,GAAW,uBAAU,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;YAC3D,MAAM,YAAY,GAAqB,QAAQ,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC;YAC/E,OAAO,GAAG,CAAC,KAAK,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;QAC3C,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,uBAAU,CAAC,eAAe,CAAC,KAAc,CAAC,EAAE,CAAC;gBAC/C,MAAM,KAAK,CAAC;YACd,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,KAAK,CACb,kBAAkB,QAAQ,CAAC,mBAAmB,CAAC,YAAY,CAAC,IAAI;oBAC9D,EAAE,CAAC,GAAG;oBACN,KAAM,KAAe,CAAC,OAAO,EAAE,CAClC,CAAC;YACJ,CAAC;QACH,CAAC;IACH,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,YAAoB,EAAE,OAA+B;QACjF,IAAI,CAAC;YACH,MAAM,QAAQ,GAAW,MAAM,uBAAU,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;YACtE,MAAM,YAAY,GAAqB,QAAQ,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC;YAC/E,OAAO,GAAG,CAAC,KAAK,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;QAC3C,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,uBAAU,CAAC,eAAe,CAAC,KAAc,CAAC,EAAE,CAAC;gBAC/C,MAAM,KAAK,CAAC;YACd,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,KAAK,CACb,kBAAkB,QAAQ,CAAC,mBAAmB,CAAC,YAAY,CAAC,IAAI;oBAC9D,EAAE,CAAC,GAAG;oBACN,KAAM,KAAe,CAAC,OAAO,EAAE,CAClC,CAAC;YACJ,CAAC;QACH,CAAC;IACH,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,WAAW,CAAC,YAAoB,EAAE,OAA+B;QAC7E,MAAM,YAAY,GAAqB,QAAQ,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC;QAC/E,OAAO,GAAG,CAAC,KAAK,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC;IAC/C,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,eAAe,CAC3B,YAAoB,EACpB,UAAsB,EACtB,OAAyC;QAEzC,MAAM,UAAU,GAAe,QAAQ,CAAC,IAAI,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;QACpE,UAAU,CAAC,cAAc,CAAC,UAAU,EAAE,YAAY,EAAE,OAAO,CAAC,CAAC;QAE7D,OAAO,UAAU,CAAC;IACpB,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,KAAK,CAAC,oBAAoB,CACtC,YAAoB,EACpB,UAAsB,EACtB,OAAyC;QAEzC,MAAM,UAAU,GAAe,MAAM,QAAQ,CAAC,SAAS,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;QAC/E,UAAU,CAAC,cAAc,CAAC,UAAU,EAAE,YAAY,EAAE,OAAO,CAAC,CAAC;QAE7D,OAAO,UAAU,CAAC;IACpB,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,2BAA2B,CACvC,YAAoB,EACpB,UAAsB,EACtB,aAAwD,EACxD,OAAyC;QAEzC,MAAM,UAAU,GAAe,QAAQ,CAAC,IAAI,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;QACpE,UAAU,CAAC,0BAA0B,CAAC,UAAU,EAAE,aAAa,CAAC,CAAC;QAEjE,OAAO,UAAU,CAAC;IACpB,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,KAAK,CAAC,gCAAgC,CAClD,YAAoB,EACpB,UAAsB,EACtB,aAAwD,EACxD,OAAyC;QAEzC,MAAM,UAAU,GAAe,MAAM,QAAQ,CAAC,SAAS,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;QAC/E,UAAU,CAAC,0BAA0B,CAAC,UAAU,EAAE,aAAa,CAAC,CAAC;QAEjE,OAAO,UAAU,CAAC;IACpB,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,SAAS,CAAC,UAAsB,EAAE,OAAmC;QACjF,OAAO,QAAQ,CAAC,YAAY,CAAC,EAAE,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;IACxD,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,YAAY,CACxB,YAAoB,EACpB,aAAyB,EACzB,UAAqC,EAAE;QAEvC,IAAI,CAAC,OAAO,CAAC,qBAAqB,EAAE,CAAC;YACnC,kFAAkF;YAClF,QAAQ,CAAC,0BAA0B,CAAC,aAAa,CAAC,CAAC;QACrD,CAAC;QAED,IAAI,YAAY,GAA2C,SAAS,CAAC;QACrE,QAAQ,OAAO,CAAC,UAAU,EAAE,CAAC;YAC3B,KAAK,UAAU,CAAC,MAAM;gBACpB,YAAY,GAAG,MAAM,CAAC;gBACtB,MAAM;YACR,KAAK,UAAU,CAAC,gBAAgB;gBAC9B,YAAY,GAAG,OAAO,CAAC;gBACvB,MAAM;YACR,KAAK,UAAU,CAAC,KAAK;gBACnB,YAAY,GAAG,OAAO,CAAC;gBACvB,MAAM;QACV,CAAC;QAED,IAAI,WAAmB,CAAC;QAExB,IAAI,YAAY,KAAK,EAAE,EAAE,CAAC;YACxB,mFAAmF;YACnF,WAAW,GAAG,GAAG,CAAC,MAAM,CAAC,YAAY,EAAE,aAAa,EAAE;gBACpD,IAAI,EAAE,YAAY,aAAZ,YAAY,cAAZ,YAAY,GAAI,UAAU,CAAC,KAAK;gBACtC,MAAM,EAAE,CAAC;aACV,CAAC,CAAC;QACL,CAAC;aAAM,IAAI,OAAO,CAAC,gBAAgB,EAAE,CAAC;YACpC,WAAW,GAAG,GAAG,CAAC,SAAS,CAAC,aAAa,EAAE;gBACzC,IAAI,EAAE,YAAY,aAAZ,YAAY,cAAZ,YAAY,GAAI,MAAM;gBAC5B,MAAM,EAAE,CAAC;aACV,CAAC,CAAC;YAEH,IAAI,OAAO,CAAC,aAAa,KAAK,SAAS,EAAE,CAAC;gBACxC,WAAW,GAAG,QAAQ,CAAC,wBAAwB,CAAC,OAAO,CAAC,aAAa,CAAC,GAAG,WAAW,CAAC;YACvF,CAAC;QACH,CAAC;aAAM,CAAC;YACN,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC,aAAa,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC;YAE1D,IAAI,OAAO,CAAC,aAAa,KAAK,SAAS,EAAE,CAAC;gBACxC,WAAW,GAAG,QAAQ,CAAC,wBAAwB,CAAC,OAAO,CAAC,aAAa,CAAC,GAAG,WAAW,CAAC;YACvF,CAAC;QACH,CAAC;QAED,2BAA2B;QAC3B,WAAW,GAAG,WAAI,CAAC,qBAAqB,CAAC,WAAW,CAAC,CAAC;QAEtD,IAAI,OAAO,CAAC,iBAAiB,EAAE,CAAC;YAC9B,WAAW,GAAG,WAAI,CAAC,SAAS,CAAC,WAAW,EAAE,OAAO,CAAC,iBAAiB,CAAC,CAAC;QACvE,CAAC;QAED,OAAO,WAAW,CAAC;IACrB,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,IAAI,CAChB,UAAsB,EACtB,YAAoB,EACpB,UAAgC,EAAE;QAElC,iDAAiD;QACjD,IAAI,SAAS,GAAuB,SAAS,CAAC;QAC9C,IAAI,OAAO,CAAC,kBAAkB,IAAI,OAAO,CAAC,aAAa,EAAE,CAAC;YACxD,IAAI,CAAC;gBACH,SAAS,GAAG,uBAAU,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC;YACxD,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,IAAI,CAAC,uBAAU,CAAC,eAAe,CAAC,KAAc,CAAC,EAAE,CAAC;oBAChD,MAAM,KAAK,CAAC;gBACd,CAAC;YACH,CAAC;QACH,CAAC;QAED,IAAI,YAAY,GAAW,EAAE,CAAC;QAC9B,IAAI,OAAO,CAAC,kBAAkB,IAAI,SAAS,EAAE,CAAC;YAC5C,YAAY,GAAG,SAAS,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC;QACtD,CAAC;QAED,MAAM,OAAO,GAAW,QAAQ,CAAC,YAAY,CAAC,YAAY,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;QAEjF,MAAM,SAAS,GAAW,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAC;QAEjE,IAAI,OAAO,CAAC,aAAa,EAAE,CAAC;YAC1B,wBAAwB;YACxB,IAAI,SAAS,IAAI,MAAM,CAAC,OAAO,CAAC,SAAS,EAAE,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC5D,+CAA+C;gBAC/C,OAAO,KAAK,CAAC;YACf,CAAC;QACH,CAAC;QAED,uBAAU,CAAC,SAAS,CAAC,YAAY,EAAE,SAAS,EAAE;YAC5C,kBAAkB,EAAE,OAAO,CAAC,kBAAkB;SAC/C,CAAC,CAAC;QAEH,sGAAsG;QACtG;;;;;;;;UAQE;QACF,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,KAAK,CAAC,SAAS,CAC3B,UAAsB,EACtB,YAAoB,EACpB,UAAgC,EAAE;QAElC,iDAAiD;QACjD,IAAI,SAAS,GAAuB,SAAS,CAAC;QAC9C,IAAI,OAAO,CAAC,kBAAkB,IAAI,OAAO,CAAC,aAAa,EAAE,CAAC;YACxD,IAAI,CAAC;gBACH,SAAS,GAAG,MAAM,uBAAU,CAAC,qBAAqB,CAAC,YAAY,CAAC,CAAC;YACnE,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,IAAI,CAAC,uBAAU,CAAC,eAAe,CAAC,KAAc,CAAC,EAAE,CAAC;oBAChD,MAAM,KAAK,CAAC;gBACd,CAAC;YACH,CAAC;QACH,CAAC;QAED,IAAI,YAAY,GAAW,EAAE,CAAC;QAC9B,IAAI,OAAO,CAAC,kBAAkB,IAAI,SAAS,EAAE,CAAC;YAC5C,YAAY,GAAG,SAAS,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC;QACtD,CAAC;QAED,MAAM,OAAO,GAAW,QAAQ,CAAC,YAAY,CAAC,YAAY,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;QAEjF,MAAM,SAAS,GAAW,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAC;QAEjE,IAAI,OAAO,CAAC,aAAa,EAAE,CAAC;YAC1B,wBAAwB;YACxB,IAAI,SAAS,IAAI,MAAM,CAAC,OAAO,CAAC,SAAS,EAAE,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC5D,+CAA+C;gBAC/C,OAAO,KAAK,CAAC;YACf,CAAC;QACH,CAAC;QAED,MAAM,uBAAU,CAAC,cAAc,CAAC,YAAY,EAAE,SAAS,EAAE;YACvD,kBAAkB,EAAE,OAAO,CAAC,kBAAkB;SAC/C,CAAC,CAAC;QAEH,sGAAsG;QACtG;;;;;;;;UAQE;QACF,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,0BAA0B,CAAC,UAAsB;QAC7D,OAAO,QAAQ,CAAC,2BAA2B,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED,yDAAyD;IACjD,MAAM,CAAC,2BAA2B,CAAC,UAAsB,EAAE,OAAiB;QAClF,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,OAAO;QACT,CAAC;QACD,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE,CAAC;YACnC,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;gBAC1C,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBAElB,8DAA8D;gBAC9D,MAAM,KAAK,GAAQ,UAAU,CAAC,GAAG,CAAC,CAAC;gBACnC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;oBACxB,MAAM,QAAQ,GAAW,QAAQ,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;oBAC1D,MAAM,IAAI,KAAK,CAAC,iBAAiB,QAAQ,kDAAkD,CAAC,CAAC;gBAC/F,CAAC;gBAED,QAAQ,CAAC,2BAA2B,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;gBACrD,OAAO,CAAC,GAAG,EAAE,CAAC;YAChB,CAAC;QACH,CAAC;IACH,CAAC;IAED,+FAA+F;IAC/F,kFAAkF;IAC1E,MAAM,CAAC,cAAc,CAAC,OAAiB;QAC7C,IAAI,MAAM,GAAW,EAAE,CAAC;QAExB,KAAK,MAAM,GAAG,IAAI,OAAO,EAAE,CAAC;YAC1B,IAAI,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;gBACzB,sDAAsD;gBACtD,MAAM,IAAI,IAAI,GAAG,GAAG,CAAC;YACvB,CAAC;iBAAM,IAAI,qBAAqB,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC3C,sEAAsE;gBACtE,IAAI,MAAM,EAAE,CAAC;oBACX,MAAM,IAAI,GAAG,CAAC;gBAChB,CAAC;gBACD,MAAM,IAAI,GAAG,GAAG,EAAE,CAAC;YACrB,CAAC;iBAAM,CAAC;gBACN,gFAAgF;gBAEhF,sCAAsC;gBACtC,yCAAyC;gBACzC,MAAM,UAAU,GAAW,GAAG;qBAC3B,OAAO,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,qBAAqB;qBAC9C,OAAO,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,gBAAgB;gBAC1C,MAAM,IAAI,KAAK,UAAU,IAAI,CAAC;YAChC,CAAC;QACH,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAEO,MAAM,CAAC,wBAAwB,CAAC,aAAqB;QAC3D,IAAI,aAAa,KAAK,EAAE,EAAE,CAAC;YACzB,OAAO,EAAE,CAAC;QACZ,CAAC;QACD,MAAM,KAAK,GAAa,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAClD,MAAM,MAAM,GAAa,EAAE,CAAC;QAC5B,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;gBAClD,MAAM,IAAI,KAAK,CACb,wEAAwE;oBACtE,cAAc;oBACd,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CACvB,CAAC;YACJ,CAAC;YACD,MAAM,CAAC,IAAI,CAAC,WAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC;QAC/C,CAAC;QACD,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IACjC,CAAC;IAEO,MAAM,CAAC,qBAAqB,CAAC,UAAiC,EAAE;QACtE,MAAM,YAAY,GAAqB;YACrC,aAAa,EAAE,SAAS;SACzB,CAAC;QAEF,QAAQ,OAAO,CAAC,UAAU,EAAE,CAAC;YAC3B,KAAK,UAAU,CAAC,MAAM;gBACpB,YAAY,CAAC,IAAI,GAAG,MAAM,CAAC;gBAC3B,MAAM;YACR,KAAK,UAAU,CAAC,gBAAgB;gBAC9B,YAAY,CAAC,IAAI,GAAG,OAAO,CAAC;gBAC5B,MAAM;YACR,KAAK,UAAU,CAAC,KAAK,CAAC;YACtB;gBACE,YAAY,CAAC,IAAI,GAAG,OAAO,CAAC;gBAC5B,MAAM;QACV,CAAC;QAED,OAAO,YAAY,CAAC;IACtB,CAAC;;AAhZH,4BAiZC;AAhZC;;GAEG;AACW,4BAAmB,GAA6B,CAAC,IAAY,EAAE,EAAE,CAAC,IAAI,CAAC","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 os from 'os';\nimport * as jju from 'jju';\n\nimport type { JsonSchema, IJsonSchemaErrorInfo, IJsonSchemaValidateOptions } from './JsonSchema';\nimport { Text, type NewlineKind } from './Text';\nimport { FileSystem } from './FileSystem';\n\n/**\n * Represents a JSON-serializable object whose type has not been determined yet.\n *\n * @remarks\n *\n * This type is similar to `any`, except that it communicates that the object is serializable JSON.\n *\n * @public\n */\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport type JsonObject = any;\n\n/**\n * The Rush Stack lint rules discourage usage of `null`.  However, JSON parsers always return JavaScript's\n * `null` to keep the two syntaxes consistent.  When creating interfaces that describe JSON structures,\n * use `JsonNull` to avoid triggering the lint rule.  Do not use `JsonNull` for any other purpose.\n *\n * @remarks\n * If you are designing a new JSON file format, it's a good idea to avoid `null` entirely.  In most cases\n * there are better representations that convey more information about an item that is unknown, omitted, or disabled.\n *\n * To understand why `null` is deprecated, please see the `@rushstack/eslint-plugin` documentation here:\n *\n * {@link https://www.npmjs.com/package/@rushstack/eslint-plugin#rushstackno-null}\n *\n * @public\n */\n// eslint-disable-next-line @rushstack/no-new-null\nexport type JsonNull = null;\n\n/**\n * Specifies the variant of JSON syntax to be used.\n *\n * @public\n */\nexport enum JsonSyntax {\n  /**\n   * Specifies the exact RFC 8259 format as implemented by the `JSON.parse()` system API.\n   * This format was designed for machine generated inputs such as an HTTP payload.\n   * It is not a recommend choice for human-authored files, because it does not support\n   * code comments.\n   *\n   * @remarks\n   *\n   * A well-known quote from Douglas Crockford, the inventor of JSON:\n   *\n   * \"I removed comments from JSON because I saw people were using them to hold parsing directives,\n   * a practice which would have destroyed interoperability.  I know that the lack of comments makes\n   * some people sad, but it shouldn't.  Suppose you are using JSON to keep configuration files,\n   * which you would like to annotate.  Go ahead and insert all the comments you like.\n   * Then pipe it through JSMin before handing it to your JSON parser.\"\n   *\n   * @see {@link https://datatracker.ietf.org/doc/html/rfc8259 | RFC 8259}\n   */\n  Strict = 'strict',\n\n  /**\n   * `JsonSyntax.JsonWithComments` is the recommended format for human-authored config files.\n   * It is a minimal extension to `JsonSyntax.Strict` adding support for code comments\n   * using `//` and `/*`.\n   *\n   * @remarks\n   *\n   * VS Code calls this format `jsonc`, but it should not be confused with unrelated file formats\n   * and libraries that also use the name \"JSONC\".\n   *\n   * To fix VS Code syntax highlighting, add this setting:\n   * `\"files.associations\": { \"*.json\": \"jsonc\" }`\n   *\n   * To fix GitHub syntax highlighting, add this to your `.gitattributes`:\n   * `*.json linguist-language=JSON-with-Comments`\n   */\n  JsonWithComments = 'jsonWithComments',\n\n  /**\n   * JSON5 is a project that proposes a JSON-like format supplemented with ECMAScript 5.1\n   * notations for objects, numbers, comments, and more.\n   *\n   * @remarks\n   * Files using this format should use the `.json5` file extension instead of `.json`.\n   *\n   * JSON5 has substantial differences from JSON: object keys may be unquoted, trailing commas\n   * are allowed, and strings may span multiple lines.  Whereas {@link JsonSyntax.JsonWithComments} can\n   * be cheaply converted to standard JSON by stripping comments, parsing JSON5 requires a\n   * nontrivial algorithm that may not be easily available in some contexts or programming languages.\n   *\n   * @see {@link https://json5.org/ | JSON5 project website}\n   */\n  Json5 = 'json5'\n}\n\n/**\n * Options for {@link JsonFile.parseString}, {@link JsonFile.load}, and {@link JsonFile.loadAsync}.\n *\n * @public\n */\nexport interface IJsonFileParseOptions {\n  /**\n   * Specifies the variant of JSON syntax to be used.\n   *\n   * @defaultValue\n   * {@link JsonSyntax.Json5}\n   *\n   * NOTE: This default will be changed to `JsonSyntax.JsonWithComments` in a future release.\n   */\n  jsonSyntax?: JsonSyntax;\n}\n\n/**\n * Options for {@link JsonFile.loadAndValidate} and {@link JsonFile.loadAndValidateAsync}\n *\n * @public\n */\nexport interface IJsonFileLoadAndValidateOptions extends IJsonFileParseOptions, IJsonSchemaValidateOptions {}\n\n/**\n * Options for {@link JsonFile.stringify}\n *\n * @public\n */\nexport interface IJsonFileStringifyOptions extends IJsonFileParseOptions {\n  /**\n   * If provided, the specified newline type will be used instead of the default `\\r\\n`.\n   */\n  newlineConversion?: NewlineKind;\n\n  /**\n   * By default, {@link JsonFile.stringify} validates that the object does not contain any\n   * keys whose value is `undefined`.  To disable this validation, set\n   * {@link IJsonFileStringifyOptions.ignoreUndefinedValues} to `true`\n   * which causes such keys to be silently discarded, consistent with the system `JSON.stringify()`.\n   *\n   * @remarks\n   *\n   * The JSON file format can represent `null` values ({@link JsonNull}) but not `undefined` values.\n   * In ECMAScript code however, we generally avoid `null` and always represent empty states\n   * as `undefined`, because it is the default value of missing/uninitialized variables.\n   * (In practice, distinguishing \"null\" versus \"uninitialized\" has more drawbacks than benefits.)\n   * This poses a problem when serializing ECMAScript objects that contain `undefined` members.\n   * As a safeguard, {@link JsonFile} will report an error if any `undefined` values are encountered\n   * during serialization.  Set {@link IJsonFileStringifyOptions.ignoreUndefinedValues} to `true`\n   * to disable this safeguard.\n   */\n  ignoreUndefinedValues?: boolean;\n\n  /**\n   * If true, then the \"jju\" library will be used to improve the text formatting.\n   * Note that this is slightly slower than the native JSON.stringify() implementation.\n   */\n  prettyFormatting?: boolean;\n\n  /**\n   * If specified, this header will be prepended to the start of the file.  The header must consist\n   * of lines prefixed by \"//\" characters.\n   * @remarks\n   * When used with {@link IJsonFileSaveOptions.updateExistingFile}\n   * or {@link JsonFile.updateString}, the header will ONLY be added for a newly created file.\n   */\n  headerComment?: string;\n}\n\n/**\n * Options for {@link JsonFile.save} and {@link JsonFile.saveAsync}.\n *\n * @public\n */\nexport interface IJsonFileSaveOptions extends IJsonFileStringifyOptions {\n  /**\n   * If there is an existing file, and the contents have not changed, then\n   * don't write anything; this preserves the old timestamp.\n   */\n  onlyIfChanged?: boolean;\n\n  /**\n   * Creates the folder recursively using FileSystem.ensureFolder()\n   * Defaults to false.\n   */\n  ensureFolderExists?: boolean;\n\n  /**\n   * If true, use the \"jju\" library to preserve the existing JSON formatting:  The file will be loaded\n   * from the target filename, the new content will be merged in (preserving whitespace and comments),\n   * and then the file will be overwritten with the merged contents.  If the target file does not exist,\n   * then the file is saved normally.\n   */\n  updateExistingFile?: boolean;\n}\n\nconst DEFAULT_ENCODING: 'utf8' = 'utf8';\n\n/**\n * Utilities for reading/writing JSON files.\n * @public\n */\nexport class JsonFile {\n  /**\n   * @internal\n   */\n  public static _formatPathForError: (path: string) => string = (path: string) => path;\n\n  /**\n   * Loads a JSON file.\n   */\n  public static load(jsonFilename: string, options?: IJsonFileParseOptions): JsonObject {\n    try {\n      const contents: string = FileSystem.readFile(jsonFilename);\n      const parseOptions: jju.ParseOptions = JsonFile._buildJjuParseOptions(options);\n      return jju.parse(contents, parseOptions);\n    } catch (error) {\n      if (FileSystem.isNotExistError(error as Error)) {\n        throw error;\n      } else {\n        throw new Error(\n          `Error reading \"${JsonFile._formatPathForError(jsonFilename)}\":` +\n            os.EOL +\n            `  ${(error as Error).message}`\n        );\n      }\n    }\n  }\n\n  /**\n   * An async version of {@link JsonFile.load}.\n   */\n  public static async loadAsync(jsonFilename: string, options?: IJsonFileParseOptions): Promise<JsonObject> {\n    try {\n      const contents: string = await FileSystem.readFileAsync(jsonFilename);\n      const parseOptions: jju.ParseOptions = JsonFile._buildJjuParseOptions(options);\n      return jju.parse(contents, parseOptions);\n    } catch (error) {\n      if (FileSystem.isNotExistError(error as Error)) {\n        throw error;\n      } else {\n        throw new Error(\n          `Error reading \"${JsonFile._formatPathForError(jsonFilename)}\":` +\n            os.EOL +\n            `  ${(error as Error).message}`\n        );\n      }\n    }\n  }\n\n  /**\n   * Parses a JSON file's contents.\n   */\n  public static parseString(jsonContents: string, options?: IJsonFileParseOptions): JsonObject {\n    const parseOptions: jju.ParseOptions = JsonFile._buildJjuParseOptions(options);\n    return jju.parse(jsonContents, parseOptions);\n  }\n\n  /**\n   * Loads a JSON file and validate its schema.\n   */\n  public static loadAndValidate(\n    jsonFilename: string,\n    jsonSchema: JsonSchema,\n    options?: IJsonFileLoadAndValidateOptions\n  ): JsonObject {\n    const jsonObject: JsonObject = JsonFile.load(jsonFilename, options);\n    jsonSchema.validateObject(jsonObject, jsonFilename, options);\n\n    return jsonObject;\n  }\n\n  /**\n   * An async version of {@link JsonFile.loadAndValidate}.\n   */\n  public static async loadAndValidateAsync(\n    jsonFilename: string,\n    jsonSchema: JsonSchema,\n    options?: IJsonFileLoadAndValidateOptions\n  ): Promise<JsonObject> {\n    const jsonObject: JsonObject = await JsonFile.loadAsync(jsonFilename, options);\n    jsonSchema.validateObject(jsonObject, jsonFilename, options);\n\n    return jsonObject;\n  }\n\n  /**\n   * Loads a JSON file and validate its schema, reporting errors using a callback\n   * @remarks\n   * See JsonSchema.validateObjectWithCallback() for more info.\n   */\n  public static loadAndValidateWithCallback(\n    jsonFilename: string,\n    jsonSchema: JsonSchema,\n    errorCallback: (errorInfo: IJsonSchemaErrorInfo) => void,\n    options?: IJsonFileLoadAndValidateOptions\n  ): JsonObject {\n    const jsonObject: JsonObject = JsonFile.load(jsonFilename, options);\n    jsonSchema.validateObjectWithCallback(jsonObject, errorCallback);\n\n    return jsonObject;\n  }\n\n  /**\n   * An async version of {@link JsonFile.loadAndValidateWithCallback}.\n   */\n  public static async loadAndValidateWithCallbackAsync(\n    jsonFilename: string,\n    jsonSchema: JsonSchema,\n    errorCallback: (errorInfo: IJsonSchemaErrorInfo) => void,\n    options?: IJsonFileLoadAndValidateOptions\n  ): Promise<JsonObject> {\n    const jsonObject: JsonObject = await JsonFile.loadAsync(jsonFilename, options);\n    jsonSchema.validateObjectWithCallback(jsonObject, errorCallback);\n\n    return jsonObject;\n  }\n\n  /**\n   * Serializes the specified JSON object to a string buffer.\n   * @param jsonObject - the object to be serialized\n   * @param options - other settings that control serialization\n   * @returns a JSON string, with newlines, and indented with two spaces\n   */\n  public static stringify(jsonObject: JsonObject, options?: IJsonFileStringifyOptions): string {\n    return JsonFile.updateString('', jsonObject, options);\n  }\n\n  /**\n   * Serializes the specified JSON object to a string buffer.\n   * @param previousJson - the previous JSON string, which will be updated\n   * @param newJsonObject - the object to be serialized\n   * @param options - other settings that control serialization\n   * @returns a JSON string, with newlines, and indented with two spaces\n   */\n  public static updateString(\n    previousJson: string,\n    newJsonObject: JsonObject,\n    options: IJsonFileStringifyOptions = {}\n  ): string {\n    if (!options.ignoreUndefinedValues) {\n      // Standard handling of `undefined` in JSON stringification is to discard the key.\n      JsonFile.validateNoUndefinedMembers(newJsonObject);\n    }\n\n    let explicitMode: 'json5' | 'json' | 'cjson' | undefined = undefined;\n    switch (options.jsonSyntax) {\n      case JsonSyntax.Strict:\n        explicitMode = 'json';\n        break;\n      case JsonSyntax.JsonWithComments:\n        explicitMode = 'cjson';\n        break;\n      case JsonSyntax.Json5:\n        explicitMode = 'json5';\n        break;\n    }\n\n    let stringified: string;\n\n    if (previousJson !== '') {\n      // NOTE: We don't use mode=json here because comments aren't allowed by strict JSON\n      stringified = jju.update(previousJson, newJsonObject, {\n        mode: explicitMode ?? JsonSyntax.Json5,\n        indent: 2\n      });\n    } else if (options.prettyFormatting) {\n      stringified = jju.stringify(newJsonObject, {\n        mode: explicitMode ?? 'json',\n        indent: 2\n      });\n\n      if (options.headerComment !== undefined) {\n        stringified = JsonFile._formatJsonHeaderComment(options.headerComment) + stringified;\n      }\n    } else {\n      stringified = JSON.stringify(newJsonObject, undefined, 2);\n\n      if (options.headerComment !== undefined) {\n        stringified = JsonFile._formatJsonHeaderComment(options.headerComment) + stringified;\n      }\n    }\n\n    // Add the trailing newline\n    stringified = Text.ensureTrailingNewline(stringified);\n\n    if (options.newlineConversion) {\n      stringified = Text.convertTo(stringified, options.newlineConversion);\n    }\n\n    return stringified;\n  }\n\n  /**\n   * Saves the file to disk.  Returns false if nothing was written due to options.onlyIfChanged.\n   * @param jsonObject - the object to be saved\n   * @param jsonFilename - the file path to write\n   * @param options - other settings that control how the file is saved\n   * @returns false if ISaveJsonFileOptions.onlyIfChanged didn't save anything; true otherwise\n   */\n  public static save(\n    jsonObject: JsonObject,\n    jsonFilename: string,\n    options: IJsonFileSaveOptions = {}\n  ): boolean {\n    // Do we need to read the previous file contents?\n    let oldBuffer: Buffer | undefined = undefined;\n    if (options.updateExistingFile || options.onlyIfChanged) {\n      try {\n        oldBuffer = FileSystem.readFileToBuffer(jsonFilename);\n      } catch (error) {\n        if (!FileSystem.isNotExistError(error as Error)) {\n          throw error;\n        }\n      }\n    }\n\n    let jsonToUpdate: string = '';\n    if (options.updateExistingFile && oldBuffer) {\n      jsonToUpdate = oldBuffer.toString(DEFAULT_ENCODING);\n    }\n\n    const newJson: string = JsonFile.updateString(jsonToUpdate, jsonObject, options);\n\n    const newBuffer: Buffer = Buffer.from(newJson, DEFAULT_ENCODING);\n\n    if (options.onlyIfChanged) {\n      // Has the file changed?\n      if (oldBuffer && Buffer.compare(newBuffer, oldBuffer) === 0) {\n        // Nothing has changed, so don't touch the file\n        return false;\n      }\n    }\n\n    FileSystem.writeFile(jsonFilename, newBuffer, {\n      ensureFolderExists: options.ensureFolderExists\n    });\n\n    // TEST CODE: Used to verify that onlyIfChanged isn't broken by a hidden transformation during saving.\n    /*\n    const oldBuffer2: Buffer = FileSystem.readFileToBuffer(jsonFilename);\n    if (Buffer.compare(buffer, oldBuffer2) !== 0) {\n      console.log('new:' + buffer.toString('hex'));\n      console.log('old:' + oldBuffer2.toString('hex'));\n\n      throw new Error('onlyIfChanged logic is broken');\n    }\n    */\n    return true;\n  }\n\n  /**\n   * An async version of {@link JsonFile.save}.\n   */\n  public static async saveAsync(\n    jsonObject: JsonObject,\n    jsonFilename: string,\n    options: IJsonFileSaveOptions = {}\n  ): Promise<boolean> {\n    // Do we need to read the previous file contents?\n    let oldBuffer: Buffer | undefined = undefined;\n    if (options.updateExistingFile || options.onlyIfChanged) {\n      try {\n        oldBuffer = await FileSystem.readFileToBufferAsync(jsonFilename);\n      } catch (error) {\n        if (!FileSystem.isNotExistError(error as Error)) {\n          throw error;\n        }\n      }\n    }\n\n    let jsonToUpdate: string = '';\n    if (options.updateExistingFile && oldBuffer) {\n      jsonToUpdate = oldBuffer.toString(DEFAULT_ENCODING);\n    }\n\n    const newJson: string = JsonFile.updateString(jsonToUpdate, jsonObject, options);\n\n    const newBuffer: Buffer = Buffer.from(newJson, DEFAULT_ENCODING);\n\n    if (options.onlyIfChanged) {\n      // Has the file changed?\n      if (oldBuffer && Buffer.compare(newBuffer, oldBuffer) === 0) {\n        // Nothing has changed, so don't touch the file\n        return false;\n      }\n    }\n\n    await FileSystem.writeFileAsync(jsonFilename, newBuffer, {\n      ensureFolderExists: options.ensureFolderExists\n    });\n\n    // TEST CODE: Used to verify that onlyIfChanged isn't broken by a hidden transformation during saving.\n    /*\n    const oldBuffer2: Buffer = await FileSystem.readFileToBufferAsync(jsonFilename);\n    if (Buffer.compare(buffer, oldBuffer2) !== 0) {\n      console.log('new:' + buffer.toString('hex'));\n      console.log('old:' + oldBuffer2.toString('hex'));\n\n      throw new Error('onlyIfChanged logic is broken');\n    }\n    */\n    return true;\n  }\n\n  /**\n   * Used to validate a data structure before writing.  Reports an error if there\n   * are any undefined members.\n   */\n  public static validateNoUndefinedMembers(jsonObject: JsonObject): void {\n    return JsonFile._validateNoUndefinedMembers(jsonObject, []);\n  }\n\n  // Private implementation of validateNoUndefinedMembers()\n  private static _validateNoUndefinedMembers(jsonObject: JsonObject, keyPath: string[]): void {\n    if (!jsonObject) {\n      return;\n    }\n    if (typeof jsonObject === 'object') {\n      for (const key of Object.keys(jsonObject)) {\n        keyPath.push(key);\n\n        // eslint-disable-next-line @typescript-eslint/no-explicit-any\n        const value: any = jsonObject[key];\n        if (value === undefined) {\n          const fullPath: string = JsonFile._formatKeyPath(keyPath);\n          throw new Error(`The value for ${fullPath} is \"undefined\" and cannot be serialized as JSON`);\n        }\n\n        JsonFile._validateNoUndefinedMembers(value, keyPath);\n        keyPath.pop();\n      }\n    }\n  }\n\n  // Given this input:    ['items', '4', 'syntax', 'parameters', 'string \"with\" symbols\", 'type']\n  // Return this string:  items[4].syntax.parameters[\"string \\\"with\\\" symbols\"].type\n  private static _formatKeyPath(keyPath: string[]): string {\n    let result: string = '';\n\n    for (const key of keyPath) {\n      if (/^[0-9]+$/.test(key)) {\n        // It's an integer, so display like this:  parent[123]\n        result += `[${key}]`;\n      } else if (/^[a-z_][a-z_0-9]*$/i.test(key)) {\n        // It's an alphanumeric identifier, so display like this:  parent.name\n        if (result) {\n          result += '.';\n        }\n        result += `${key}`;\n      } else {\n        // It's a freeform string, so display like this:  parent[\"A path: \\\"C:\\\\file\\\"\"]\n\n        // Convert this:     A path: \"C:\\file\"\n        // To this:          A path: \\\"C:\\\\file\\\"\n        const escapedKey: string = key\n          .replace(/[\\\\]/g, '\\\\\\\\') // escape backslashes\n          .replace(/[\"]/g, '\\\\'); // escape quotes\n        result += `[\"${escapedKey}\"]`;\n      }\n    }\n    return result;\n  }\n\n  private static _formatJsonHeaderComment(headerComment: string): string {\n    if (headerComment === '') {\n      return '';\n    }\n    const lines: string[] = headerComment.split('\\n');\n    const result: string[] = [];\n    for (const line of lines) {\n      if (!/^\\s*$/.test(line) && !/^\\s*\\/\\//.test(line)) {\n        throw new Error(\n          'The headerComment lines must be blank or start with the \"//\" prefix.\\n' +\n            'Invalid line' +\n            JSON.stringify(line)\n        );\n      }\n      result.push(Text.replaceAll(line, '\\r', ''));\n    }\n    return lines.join('\\n') + '\\n';\n  }\n\n  private static _buildJjuParseOptions(options: IJsonFileParseOptions = {}): jju.ParseOptions {\n    const parseOptions: jju.ParseOptions = {\n      reserved_keys: 'replace'\n    };\n\n    switch (options.jsonSyntax) {\n      case JsonSyntax.Strict:\n        parseOptions.mode = 'json';\n        break;\n      case JsonSyntax.JsonWithComments:\n        parseOptions.mode = 'cjson';\n        break;\n      case JsonSyntax.Json5:\n      default:\n        parseOptions.mode = 'json5';\n        break;\n    }\n\n    return parseOptions;\n  }\n}\n"]}

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

@@ -0,0 +1,172 @@
+import { type JsonObject } from './JsonFile';
+/**
+ * Specifies the version of json-schema to be validated against.
+ * https://json-schema.org/specification
+ * @public
+ */
+export type JsonSchemaVersion = 'draft-04' | 'draft-07';
+/**
+ * A definition for a custom format to consider during validation.
+ * @public
+ */
+export interface IJsonSchemaCustomFormat<T extends string | number> {
+    /**
+     * The base JSON type.
+     */
+    type: T extends string ? 'string' : T extends number ? 'number' : never;
+    /**
+     * A validation function for the format.
+     * @param data - The raw field data to validate.
+     * @returns whether the data is valid according to the format.
+     */
+    validate: (data: T) => boolean;
+}
+/**
+ * Callback function arguments for {@link JsonSchema.validateObjectWithCallback}
+ * @public
+ */
+export interface IJsonSchemaErrorInfo {
+    /**
+     * The ajv error list, formatted as an indented text string.
+     */
+    details: string;
+}
+/**
+ * Options for {@link JsonSchema.validateObjectWithCallback}
+ * @public
+ */
+export interface IJsonSchemaValidateObjectWithOptions {
+    /**
+     * If true, the root-level `$schema` property in a JSON object being validated will be ignored during validation.
+     * If this is set to `true` and the schema requires a `$schema` property, validation will fail.
+     */
+    ignoreSchemaField?: boolean;
+}
+/**
+ * Options for {@link JsonSchema.validateObject}
+ * @public
+ */
+export interface IJsonSchemaValidateOptions extends IJsonSchemaValidateObjectWithOptions {
+    /**
+     * A custom header that will be used to report schema errors.
+     * @remarks
+     * If omitted, the default header is "JSON validation failed:".  The error message starts with
+     * the header, followed by the full input filename, followed by the ajv error list.
+     * If you wish to customize all aspects of the error message, use JsonFile.loadAndValidateWithCallback()
+     * or JsonSchema.validateObjectWithCallback().
+     */
+    customErrorHeader?: string;
+}
+/**
+ * Options for {@link JsonSchema.fromFile} and {@link JsonSchema.fromLoadedObject}
+ * @public
+ */
+export interface IJsonSchemaLoadOptions {
+    /**
+     * Other schemas that this schema references, e.g. via the "$ref" directive.
+     * @remarks
+     * The tree of dependent schemas may reference the same schema more than once.
+     * However, if the same schema "$id" is used by two different JsonSchema instances,
+     * an error will be reported.  This means you cannot load the same filename twice
+     * and use them both together, and you cannot have diamond dependencies on different
+     * versions of the same schema.  Although technically this would be possible to support,
+     * it normally indicates an error or design problem.
+     *
+     * JsonSchema also does not allow circular references between schema dependencies.
+     */
+    dependentSchemas?: JsonSchema[];
+    /**
+     * The json-schema version to target for validation.
+     *
+     * @defaultValue draft-07
+     *
+     * @remarks
+     * If the a version is not explicitly set, the schema object's `$schema` property
+     * will be inspected to determine the version. If a `$schema` property is not found
+     * or does not match an expected URL, the default version will be used.
+     */
+    schemaVersion?: JsonSchemaVersion;
+    /**
+     * Any custom formats to consider during validation. Some standard formats are supported
+     * out-of-the-box (e.g. emails, uris), but additional formats can be defined here. You could
+     * for example define generic numeric formats (e.g. uint8) or domain-specific formats.
+     */
+    customFormats?: Record<string, IJsonSchemaCustomFormat<string> | IJsonSchemaCustomFormat<number>>;
+}
+/**
+ * Options for {@link JsonSchema.fromFile}
+ * @public
+ */
+export type IJsonSchemaFromFileOptions = IJsonSchemaLoadOptions;
+/**
+ * Options for {@link JsonSchema.fromLoadedObject}
+ * @public
+ */
+export type IJsonSchemaFromObjectOptions = IJsonSchemaLoadOptions;
+/**
+ * Represents a JSON schema that can be used to validate JSON data files loaded by the JsonFile class.
+ * @remarks
+ * The schema itself is normally loaded and compiled later, only if it is actually required to validate
+ * an input.  To avoid schema errors at runtime, it's recommended to create a unit test that calls
+ * JsonSchema.ensureCompiled() for each of your schema objects.
+ *
+ * @public
+ */
+export declare class JsonSchema {
+    private _dependentSchemas;
+    private _filename;
+    private _validator;
+    private _schemaObject;
+    private _schemaVersion;
+    private _customFormats;
+    private constructor();
+    /**
+     * Registers a JsonSchema that will be loaded from a file on disk.
+     * @remarks
+     * NOTE: An error occurs if the file does not exist; however, the file itself is not loaded or validated
+     * until it the schema is actually used.
+     */
+    static fromFile(filename: string, options?: IJsonSchemaFromFileOptions): JsonSchema;
+    /**
+     * Registers a JsonSchema that will be loaded from an object.
+     */
+    static fromLoadedObject(schemaObject: JsonObject, options?: IJsonSchemaFromObjectOptions): JsonSchema;
+    private static _collectDependentSchemas;
+    /**
+     * Used to nicely format the ZSchema error tree.
+     */
+    private static _formatErrorDetails;
+    /**
+     * Used by _formatErrorDetails.
+     */
+    private static _formatErrorDetailsHelper;
+    /**
+     * Returns a short name for this schema, for use in error messages.
+     * @remarks
+     * If the schema was loaded from a file, then the base filename is used.  Otherwise, the "$id"
+     * field is used if available.
+     */
+    get shortName(): string;
+    /**
+     * If not already done, this loads the schema from disk and compiles it.
+     * @remarks
+     * Any dependencies will be compiled as well.
+     */
+    ensureCompiled(): void;
+    /**
+     * Validates the specified JSON object against this JSON schema.  If the validation fails,
+     * an exception will be thrown.
+     * @param jsonObject - The JSON data to be validated
+     * @param filenameForErrors - The filename that the JSON data was available, or an empty string
+     *    if not applicable
+     * @param options - Other options that control the validation
+     */
+    validateObject(jsonObject: JsonObject, filenameForErrors: string, options?: IJsonSchemaValidateOptions): void;
+    /**
+     * Validates the specified JSON object against this JSON schema.  If the validation fails,
+     * a callback is called for each validation error.
+     */
+    validateObjectWithCallback(jsonObject: JsonObject, errorCallback: (errorInfo: IJsonSchemaErrorInfo) => void, options?: IJsonSchemaValidateObjectWithOptions): void;
+    private _ensureLoaded;
+}
+//# sourceMappingURL=JsonSchema.d.ts.map