@eslint/json 0.13.2 → 1.0.0

package/README.md

@@ -4,7 +4,7 @@
 
 This package contains a plugin that allows you to natively lint JSON, JSONC, and JSON5 files using ESLint.
 
-**Important:** This plugin requires ESLint v9.6.0 or higher and you must be using the [new configuration system](https://eslint.org/docs/latest/use/configure/configuration-files).
+**Important:** This plugin requires ESLint v9.15.0 or higher and you must be using the [new configuration system](https://eslint.org/docs/latest/use/configure/configuration-files).
 
 ## Installation
 
@@ -293,10 +293,10 @@ The following companies, organizations, and individuals support ESLint's ongoing
 to get your logo on our READMEs and [website](https://eslint.org/sponsors).
 
 <h3>Platinum Sponsors</h3>
-<p><a href="https://automattic.com"><img src="https://images.opencollective.com/automattic/d0ef3e1/logo.png" alt="Automattic" height="128"></a> <a href="https://www.airbnb.com/"><img src="https://images.opencollective.com/airbnb/d327d66/logo.png" alt="Airbnb" height="128"></a></p><h3>Gold Sponsors</h3>
-<p><a href="https://qlty.sh/"><img src="https://images.opencollective.com/qltysh/33d157d/logo.png" alt="Qlty Software" height="96"></a> <a href="https://trunk.io/"><img src="https://images.opencollective.com/trunkio/fb92d60/avatar.png" alt="trunk.io" height="96"></a> <a href="https://shopify.engineering/"><img src="https://avatars.githubusercontent.com/u/8085" alt="Shopify" height="96"></a></p><h3>Silver Sponsors</h3>
-<p><a href="https://vite.dev/"><img src="https://images.opencollective.com/vite/e6d15e1/logo.png" alt="Vite" height="64"></a> <a href="https://liftoff.io/"><img src="https://images.opencollective.com/liftoff/5c4fa84/logo.png" alt="Liftoff" height="64"></a> <a href="https://americanexpress.io"><img src="https://avatars.githubusercontent.com/u/3853301" alt="American Express" height="64"></a> <a href="https://stackblitz.com"><img src="https://avatars.githubusercontent.com/u/28635252" alt="StackBlitz" height="64"></a></p><h3>Bronze Sponsors</h3>
-<p><a href="https://cybozu.co.jp/"><img src="https://images.opencollective.com/cybozu/933e46d/logo.png" alt="Cybozu" height="32"></a> <a href="https://sentry.io"><img src="https://github.com/getsentry.png" alt="Sentry" height="32"></a> <a href="https://www.crosswordsolver.org/anagram-solver/"><img src="https://images.opencollective.com/anagram-solver/2666271/logo.png" alt="Anagram Solver" height="32"></a> <a href="https://icons8.com/"><img src="https://images.opencollective.com/icons8/7fa1641/logo.png" alt="Icons8" height="32"></a> <a href="https://discord.com"><img src="https://images.opencollective.com/discordapp/f9645d9/logo.png" alt="Discord" height="32"></a> <a href="https://www.gitbook.com"><img src="https://avatars.githubusercontent.com/u/7111340" alt="GitBook" height="32"></a> <a href="https://nx.dev"><img src="https://avatars.githubusercontent.com/u/23692104" alt="Nx" height="32"></a> <a href="https://opensource.mercedes-benz.com/"><img src="https://avatars.githubusercontent.com/u/34240465" alt="Mercedes-Benz Group" height="32"></a> <a href="https://herocoders.com"><img src="https://avatars.githubusercontent.com/u/37549774" alt="HeroCoders" height="32"></a> <a href="https://www.lambdatest.com"><img src="https://avatars.githubusercontent.com/u/171592363" alt="LambdaTest" height="32"></a></p>
+<p><a href="https://automattic.com"><img src="https://images.opencollective.com/automattic/d0ef3e1/logo.png" alt="Automattic" height="128"></a></p><h3>Gold Sponsors</h3>
+<p><a href="https://qlty.sh/"><img src="https://images.opencollective.com/qltysh/33d157d/logo.png" alt="Qlty Software" height="96"></a> <a href="https://shopify.engineering/"><img src="https://avatars.githubusercontent.com/u/8085" alt="Shopify" height="96"></a></p><h3>Silver Sponsors</h3>
+<p><a href="https://vite.dev/"><img src="https://images.opencollective.com/vite/d472863/logo.png" alt="Vite" height="64"></a> <a href="https://liftoff.io/"><img src="https://images.opencollective.com/liftoff/2d6c3b6/logo.png" alt="Liftoff" height="64"></a> <a href="https://americanexpress.io"><img src="https://avatars.githubusercontent.com/u/3853301" alt="American Express" height="64"></a> <a href="https://stackblitz.com"><img src="https://avatars.githubusercontent.com/u/28635252" alt="StackBlitz" height="64"></a></p><h3>Bronze Sponsors</h3>
+<p><a href="https://cybozu.co.jp/"><img src="https://images.opencollective.com/cybozu/933e46d/logo.png" alt="Cybozu" height="32"></a> <a href="https://opensource.sap.com"><img src="https://avatars.githubusercontent.com/u/2531208" alt="SAP" height="32"></a> <a href="https://www.crawljobs.com/"><img src="https://images.opencollective.com/crawljobs-poland/fa43a17/logo.png" alt="CrawlJobs" height="32"></a> <a href="https://syntax.fm"><img src="https://github.com/syntaxfm.png" alt="Syntax" height="32"></a> <a href="https://www.n-ix.com/"><img src="https://images.opencollective.com/n-ix-ltd/575a7a5/logo.png" alt="N-iX Ltd" height="32"></a> <a href="https://icons8.com/"><img src="https://images.opencollective.com/icons8/7fa1641/logo.png" alt="Icons8" height="32"></a> <a href="https://discord.com"><img src="https://images.opencollective.com/discordapp/f9645d9/logo.png" alt="Discord" height="32"></a> <a href="https://www.gitbook.com"><img src="https://avatars.githubusercontent.com/u/7111340" alt="GitBook" height="32"></a> <a href="https://nx.dev"><img src="https://avatars.githubusercontent.com/u/23692104" alt="Nx" height="32"></a> <a href="https://herocoders.com"><img src="https://avatars.githubusercontent.com/u/37549774" alt="HeroCoders" height="32"></a> <a href="https://www.lambdatest.com"><img src="https://avatars.githubusercontent.com/u/171592363" alt="LambdaTest" height="32"></a></p>
 <h3>Technology Sponsors</h3>
 Technology sponsors allow us to use their products and services for free as part of a contribution to the open source ecosystem and our work.
 <p><a href="https://netlify.com"><img src="https://raw.githubusercontent.com/eslint/eslint.org/main/src/assets/images/techsponsors/netlify-icon.svg" alt="Netlify" height="32"></a> <a href="https://algolia.com"><img src="https://raw.githubusercontent.com/eslint/eslint.org/main/src/assets/images/techsponsors/algolia-icon.svg" alt="Algolia" height="32"></a> <a href="https://1password.com"><img src="https://raw.githubusercontent.com/eslint/eslint.org/main/src/assets/images/techsponsors/1password-icon.svg" alt="1Password" height="32"></a></p>

package/dist/build/recommended-config.d.ts

@@ -0,0 +1,7 @@
+export default rules;
+declare const rules: {
+    readonly "json/no-duplicate-keys": "error";
+    readonly "json/no-empty-keys": "error";
+    readonly "json/no-unnormalized-keys": "error";
+    readonly "json/no-unsafe-values": "error";
+};

package/dist/build/recommended-config.js

@@ -0,0 +1,7 @@
+const rules = /** @type {const} */ ({
+    "json/no-duplicate-keys": "error",
+    "json/no-empty-keys": "error",
+    "json/no-unnormalized-keys": "error",
+    "json/no-unsafe-values": "error"
+});
+export default rules;

package/dist/build/rules.d.ts

@@ -0,0 +1,9 @@
+declare const _default: {
+    "no-duplicate-keys": import("../rules/no-duplicate-keys.js").NoDuplicateKeysRuleDefinition;
+    "no-empty-keys": import("../rules/no-empty-keys.js").NoEmptyKeysRuleDefinition;
+    "no-unnormalized-keys": import("../rules/no-unnormalized-keys.js").NoUnnormalizedKeysRuleDefinition;
+    "no-unsafe-values": import("../rules/no-unsafe-values.js").NoUnsafeValuesRuleDefinition;
+    "sort-keys": import("../rules/sort-keys.js").SortKeysRuleDefinition;
+    "top-level-interop": import("../rules/top-level-interop.js").TopLevelInteropRuleDefinition;
+};
+export default _default;

package/dist/build/rules.js

@@ -0,0 +1,14 @@
+import rule0 from "../rules/no-duplicate-keys.js";
+import rule1 from "../rules/no-empty-keys.js";
+import rule2 from "../rules/no-unnormalized-keys.js";
+import rule3 from "../rules/no-unsafe-values.js";
+import rule4 from "../rules/sort-keys.js";
+import rule5 from "../rules/top-level-interop.js";
+export default {
+    "no-duplicate-keys": rule0,
+    "no-empty-keys": rule1,
+    "no-unnormalized-keys": rule2,
+    "no-unsafe-values": rule3,
+    "sort-keys": rule4,
+    "top-level-interop": rule5,
+};

package/dist/index.d.ts

@@ -0,0 +1,28 @@
+export default plugin;
+export { JSONSourceCode };
+export * from "./languages/json-language.js";
+export * from "./types.js";
+declare namespace plugin {
+    export namespace meta {
+        let name: string;
+        let version: string;
+    }
+    export namespace languages {
+        let json: JSONLanguage;
+        let jsonc: JSONLanguage;
+        let json5: JSONLanguage;
+    }
+    export { rules };
+    export namespace configs {
+        namespace recommended {
+            let name_1: string;
+            export { name_1 as name };
+            export let plugins: {};
+            export { recommendedRules as rules };
+        }
+    }
+}
+import { JSONSourceCode } from "./languages/json-source-code.js";
+import { JSONLanguage } from "./languages/json-language.js";
+import rules from "./build/rules.js";
+import recommendedRules from "./build/recommended-config.js";

package/dist/index.js

@@ -0,0 +1,41 @@
+/**
+ * @fileoverview JSON plugin.
+ * @author Nicholas C. Zakas
+ */
+//-----------------------------------------------------------------------------
+// Imports
+//-----------------------------------------------------------------------------
+import { JSONLanguage } from "./languages/json-language.js";
+import { JSONSourceCode } from "./languages/json-source-code.js";
+import recommendedRules from "./build/recommended-config.js";
+import rules from "./build/rules.js";
+//-----------------------------------------------------------------------------
+// Plugin
+//-----------------------------------------------------------------------------
+const plugin = {
+    meta: {
+        name: "@eslint/json",
+        version: "1.0.0", // x-release-please-version
+    },
+    languages: {
+        json: new JSONLanguage({ mode: "json" }),
+        jsonc: new JSONLanguage({ mode: "jsonc" }),
+        json5: new JSONLanguage({ mode: "json5" }),
+    },
+    rules,
+    configs: {
+        recommended: {
+            name: "@eslint/json/recommended",
+            plugins: {},
+            rules: recommendedRules,
+        },
+    },
+};
+// eslint-disable-next-line no-lone-blocks -- The block syntax { ... } ensures that TypeScript does not get confused about the type of `plugin`.
+{
+    plugin.configs.recommended.plugins.json = plugin;
+}
+export default plugin;
+export { JSONSourceCode };
+export * from "./languages/json-language.js";
+export * from "./types.js";

package/dist/languages/json-language.d.ts

@@ -0,0 +1,85 @@
+/**
+ * @import { DocumentNode, AnyNode } from "@humanwhocodes/momoa";
+ * @import { Language, OkParseResult, ParseResult, File } from "@eslint/core";
+ * @typedef {OkParseResult<DocumentNode>} JSONOkParseResult
+ * @typedef {ParseResult<DocumentNode>} JSONParseResult
+ * @typedef {Object} JSONLanguageOptions
+ * @property {boolean} [allowTrailingCommas] Whether to allow trailing commas in JSONC mode.
+ */
+/**
+ * JSON Language Object
+ * @implements {Language<{ LangOptions: JSONLanguageOptions; Code: JSONSourceCode; RootNode: DocumentNode; Node: AnyNode }>}
+ */
+export class JSONLanguage implements Language {
+    /**
+     * Creates a new instance.
+     * @param {Object} options The options to use for this instance.
+     * @param {"json"|"jsonc"|"json5"} options.mode The parser mode to use.
+     */
+    constructor({ mode }: {
+        mode: "json" | "jsonc" | "json5";
+    });
+    /**
+     * The type of file to read.
+     * @type {"text"}
+     */
+    fileType: "text";
+    /**
+     * The line number at which the parser starts counting.
+     * @type {0|1}
+     */
+    lineStart: 0 | 1;
+    /**
+     * The column number at which the parser starts counting.
+     * @type {0|1}
+     */
+    columnStart: 0 | 1;
+    /**
+     * The name of the key that holds the type of the node.
+     * @type {string}
+     */
+    nodeTypeKey: string;
+    /**
+     * The visitor keys.
+     * @type {Record<string, string[]>}
+     */
+    visitorKeys: Record<string, string[]>;
+    /**
+     * Validates the language options.
+     * @param {JSONLanguageOptions} languageOptions The language options to validate.
+     * @returns {void}
+     * @throws {Error} When the language options are invalid.
+     */
+    validateLanguageOptions(languageOptions: JSONLanguageOptions): void;
+    /**
+     * Parses the given file into an AST.
+     * @param {File} file The virtual file to parse.
+     * @param {{languageOptions: JSONLanguageOptions}} context The options to use for parsing.
+     * @returns {JSONParseResult} The result of parsing.
+     */
+    parse(file: File, context: {
+        languageOptions: JSONLanguageOptions;
+    }): JSONParseResult;
+    /**
+     * Creates a new `JSONSourceCode` object from the given information.
+     * @param {File} file The virtual file to create a `JSONSourceCode` object from.
+     * @param {JSONOkParseResult} parseResult The result returned from `parse()`.
+     * @returns {JSONSourceCode} The new `JSONSourceCode` object.
+     */
+    createSourceCode(file: File, parseResult: JSONOkParseResult): JSONSourceCode;
+    #private;
+}
+export type JSONOkParseResult = OkParseResult<DocumentNode>;
+export type JSONParseResult = ParseResult<DocumentNode>;
+export type JSONLanguageOptions = {
+    /**
+     * Whether to allow trailing commas in JSONC mode.
+     */
+    allowTrailingCommas?: boolean;
+};
+import type { Language } from "@eslint/core";
+import type { File } from "@eslint/core";
+import { JSONSourceCode } from "./json-source-code.js";
+import type { DocumentNode } from "@humanwhocodes/momoa";
+import type { OkParseResult } from "@eslint/core";
+import type { ParseResult } from "@eslint/core";

package/dist/languages/json-language.js

@@ -0,0 +1,143 @@
+/**
+ * @fileoverview The JSONLanguage class.
+ * @author Nicholas C. Zakas
+ */
+//------------------------------------------------------------------------------
+// Imports
+//------------------------------------------------------------------------------
+import { parse } from "@humanwhocodes/momoa";
+import { JSONSourceCode } from "./json-source-code.js";
+import { visitorKeys } from "@humanwhocodes/momoa";
+//-----------------------------------------------------------------------------
+// Types
+//-----------------------------------------------------------------------------
+/**
+ * @import { DocumentNode, AnyNode } from "@humanwhocodes/momoa";
+ * @import { Language, OkParseResult, ParseResult, File } from "@eslint/core";
+ * @typedef {OkParseResult<DocumentNode>} JSONOkParseResult
+ * @typedef {ParseResult<DocumentNode>} JSONParseResult
+ * @typedef {Object} JSONLanguageOptions
+ * @property {boolean} [allowTrailingCommas] Whether to allow trailing commas in JSONC mode.
+ */
+//-----------------------------------------------------------------------------
+// Exports
+//-----------------------------------------------------------------------------
+/**
+ * JSON Language Object
+ * @implements {Language<{ LangOptions: JSONLanguageOptions; Code: JSONSourceCode; RootNode: DocumentNode; Node: AnyNode }>}
+ */
+export class JSONLanguage {
+    /**
+     * The type of file to read.
+     * @type {"text"}
+     */
+    fileType = "text";
+    /**
+     * The line number at which the parser starts counting.
+     * @type {0|1}
+     */
+    lineStart = 1;
+    /**
+     * The column number at which the parser starts counting.
+     * @type {0|1}
+     */
+    columnStart = 1;
+    /**
+     * The name of the key that holds the type of the node.
+     * @type {string}
+     */
+    nodeTypeKey = "type";
+    /**
+     * The parser mode.
+     * @type {"json"|"jsonc"|"json5"}
+     */
+    #mode = "json";
+    /**
+     * The visitor keys.
+     * @type {Record<string, string[]>}
+     */
+    visitorKeys = Object.fromEntries([...visitorKeys]);
+    /**
+     * Creates a new instance.
+     * @param {Object} options The options to use for this instance.
+     * @param {"json"|"jsonc"|"json5"} options.mode The parser mode to use.
+     */
+    constructor({ mode }) {
+        this.#mode = mode;
+    }
+    /**
+     * Validates the language options.
+     * @param {JSONLanguageOptions} languageOptions The language options to validate.
+     * @returns {void}
+     * @throws {Error} When the language options are invalid.
+     */
+    validateLanguageOptions(languageOptions) {
+        if (languageOptions.allowTrailingCommas !== undefined) {
+            if (typeof languageOptions.allowTrailingCommas !== "boolean") {
+                throw new Error("allowTrailingCommas must be a boolean if provided.");
+            }
+            // we know that allowTrailingCommas is a boolean here
+            // only allowed in JSONC mode
+            if (this.#mode !== "jsonc") {
+                throw new Error("allowTrailingCommas option is only available in JSONC.");
+            }
+        }
+    }
+    /**
+     * Parses the given file into an AST.
+     * @param {File} file The virtual file to parse.
+     * @param {{languageOptions: JSONLanguageOptions}} context The options to use for parsing.
+     * @returns {JSONParseResult} The result of parsing.
+     */
+    parse(file, context) {
+        // Note: BOM already removed
+        const text = /** @type {string} */ (file.body);
+        const allowTrailingCommas = context?.languageOptions?.allowTrailingCommas;
+        /*
+         * Check for parsing errors first. If there's a parsing error, nothing
+         * else can happen. However, a parsing error does not throw an error
+         * from this method - it's just considered a fatal error message, a
+         * problem that ESLint identified just like any other.
+         */
+        try {
+            const root = parse(text, {
+                mode: this.#mode,
+                ranges: true,
+                tokens: true,
+                allowTrailingCommas,
+            });
+            return {
+                ok: true,
+                ast: root,
+            };
+        }
+        catch (ex) {
+            // error messages end with (line:column) so we strip that off for ESLint
+            const message = ex.message
+                .slice(0, ex.message.lastIndexOf("("))
+                .trim();
+            return {
+                ok: false,
+                errors: [
+                    {
+                        ...ex,
+                        message,
+                    },
+                ],
+            };
+        }
+    }
+    /* eslint-disable class-methods-use-this -- Required to complete interface. */
+    /**
+     * Creates a new `JSONSourceCode` object from the given information.
+     * @param {File} file The virtual file to create a `JSONSourceCode` object from.
+     * @param {JSONOkParseResult} parseResult The result returned from `parse()`.
+     * @returns {JSONSourceCode} The new `JSONSourceCode` object.
+     */
+    createSourceCode(file, parseResult) {
+        return new JSONSourceCode({
+            text: /** @type {string} */ (file.body),
+            ast: parseResult.ast,
+        });
+    }
+}

package/dist/languages/json-source-code.d.ts

@@ -0,0 +1,123 @@
+/**
+ * JSON Source Code Object
+ * @extends {TextSourceCodeBase<{LangOptions: JSONLanguageOptions, RootNode: DocumentNode, SyntaxElementWithLoc: JSONSyntaxElement, ConfigNode: Token}>}
+ */
+export class JSONSourceCode extends TextSourceCodeBase<{
+    LangOptions: JSONLanguageOptions;
+    RootNode: DocumentNode;
+    SyntaxElementWithLoc: JSONSyntaxElement;
+    ConfigNode: Token;
+}> {
+    /**
+     * Creates a new instance.
+     * @param {Object} options The options for the instance.
+     * @param {string} options.text The source code text.
+     * @param {DocumentNode} options.ast The root AST node.
+     */
+    constructor({ text, ast }: {
+        text: string;
+        ast: DocumentNode;
+    });
+    /**
+     * The comment tokens in the source code.
+     * @type {Array<Token>|undefined}
+     */
+    comments: Array<Token> | undefined;
+    /**
+     * Returns an array of all inline configuration nodes found in the
+     * source code.
+     * @returns {Array<Token>} An array of all inline configuration nodes.
+     */
+    getInlineConfigNodes(): Array<Token>;
+    /**
+     * Returns directives that enable or disable rules along with any problems
+     * encountered while parsing the directives.
+     * @returns {{problems:Array<FileProblem>,directives:Array<Directive>}} Information
+     *      that ESLint needs to further process the directives.
+     */
+    getDisableDirectives(): {
+        problems: Array<FileProblem>;
+        directives: Array<Directive>;
+    };
+    /**
+     * Returns inline rule configurations along with any problems
+     * encountered while parsing the configurations.
+     * @returns {{problems:Array<FileProblem>,configs:Array<{config:{rules:RulesConfig},loc:LocationRange}>}} Information
+     *      that ESLint needs to further process the rule configurations.
+     */
+    applyInlineConfig(): {
+        problems: Array<FileProblem>;
+        configs: Array<{
+            config: {
+                rules: RulesConfig;
+            };
+            loc: LocationRange;
+        }>;
+    };
+    /**
+     * Returns the parent of the given node.
+     * @param {AnyNode} node The node to get the parent of.
+     * @returns {AnyNode|undefined} The parent of the node.
+     */
+    getParent(node: AnyNode): AnyNode | undefined;
+    /**
+     * Traverse the source code and return the steps that were taken.
+     * @returns {Iterable<JSONTraversalStep>} The steps that were taken while traversing the source code.
+     */
+    traverse(): Iterable<JSONTraversalStep>;
+    /**
+     * Gets the token before the given node or token, optionally including comments.
+     * @param {AnyNode|Token} nodeOrToken The node or token to get the previous token for.
+     * @param {Object} [options] Options object.
+     * @param {boolean} [options.includeComments] If true, return comments when they are present.
+     * @returns {Token|null} The previous token or comment, or null if there is none.
+     */
+    getTokenBefore(nodeOrToken: AnyNode | Token, { includeComments }?: {
+        includeComments?: boolean;
+    }): Token | null;
+    /**
+     * Gets the token after the given node or token, skipping any comments unless includeComments is true.
+     * @param {AnyNode|Token} nodeOrToken The node or token to get the next token for.
+     * @param {Object} [options] Options object.
+     * @param {boolean} [options.includeComments=false] If true, return comments when they are present.
+     * @returns {Token|null} The next token or comment, or null if there is none.
+     */
+    getTokenAfter(nodeOrToken: AnyNode | Token, { includeComments }?: {
+        includeComments?: boolean;
+    }): Token | null;
+    #private;
+}
+import type { JSONLanguageOptions } from "./json-language.js";
+import type { DocumentNode } from "@humanwhocodes/momoa";
+import type { JSONSyntaxElement } from "../types.js";
+import type { Token } from "@humanwhocodes/momoa";
+import { TextSourceCodeBase } from "@eslint/plugin-kit";
+import type { FileProblem } from "@eslint/core";
+import { Directive } from "@eslint/plugin-kit";
+import type { RulesConfig } from "@eslint/core";
+import type { LocationRange } from "@humanwhocodes/momoa";
+import type { AnyNode } from "@humanwhocodes/momoa";
+/**
+ * A class to represent a step in the traversal process.
+ */
+declare class JSONTraversalStep extends VisitNodeStep {
+    /**
+     * Creates a new instance.
+     * @param {Object} options The options for the step.
+     * @param {AnyNode} options.target The target of the step.
+     * @param {1|2} options.phase The phase of the step.
+     * @param {Array<any>} options.args The arguments of the step.
+     */
+    constructor({ target, phase, args }: {
+        target: AnyNode;
+        phase: 1 | 2;
+        args: Array<any>;
+    });
+    /**
+     * The target of the step.
+     * @type {AnyNode}
+     */
+    target: AnyNode;
+}
+import { VisitNodeStep } from "@eslint/plugin-kit";
+export {};