@eslint/json 0.5.0 → 0.6.0

package/README.md

@@ -185,6 +185,35 @@ In JSONC and JSON5 files, you can also use [rule configurations comments](https:
 
 Both line and block comments can be used for all kinds of configuration comments.
 
+## Allowing trailing commas in JSONC
+
+The Microsoft implementation of JSONC optionally allows for trailing commas in objects and arrays (files like `tsconfig.json` have this option enabled by default in Visual Studio Code). To enable trailing commas in JSONC files, use the `allowTrailingCommas` language option, as in this example:
+
+```js
+import json from "@eslint/json";
+
+export default [
+	// lint JSONC files
+	{
+		files: ["**/*.jsonc"],
+		language: "json/jsonc",
+		...json.configs.recommended,
+	},
+
+	// lint JSONC files and allow trailing commas
+	{
+		files: ["**/tsconfig.json", ".vscode/*.json"],
+		language: "json/jsonc",
+		languageOptions: {
+			allowTrailingCommas: true,
+		},
+		...json.configs.recommended,
+	},
+];
+```
+
+**Note:** The `allowTrailingCommas` option is only valid for the `json/jsonc` language.
+
 ## Frequently Asked Questions
 
 ### How does this relate to `eslint-plugin-json` and `eslint-plugin-jsonc`?
@@ -208,11 +237,20 @@ Any other rules that catch potential problems in JSON are welcome to be implemen
 
 Apache 2.0
 
-## Sponsors
-
 <!-- NOTE: This section is autogenerated. Do not manually edit.-->
 <!--sponsorsstart-->
-<!--sponsorsend-->
 
-<!--techsponsorsstart-->
-<!--techsponsorsend-->
+## Sponsors
+
+The following companies, organizations, and individuals support ESLint's ongoing maintenance and development. [Become a Sponsor](https://eslint.org/donate)
+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://trunk.io/"><img src="https://images.opencollective.com/trunkio/fb92d60/avatar.png" alt="trunk.io" height="96"></a></p><h3>Silver Sponsors</h3>
+<p><a href="https://www.serptriumph.com/"><img src="https://images.opencollective.com/serp-triumph5/fea3074/logo.png" alt="SERP Triumph" height="64"></a> <a href="https://www.jetbrains.com/"><img src="https://images.opencollective.com/jetbrains/fe76f99/logo.png" alt="JetBrains" 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?v=4" alt="American Express" height="64"></a> <a href="https://www.workleap.com"><img src="https://avatars.githubusercontent.com/u/53535748?u=d1e55d7661d724bf2281c1bfd33cb8f99fe2465f&v=4" alt="Workleap" 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://www.wordhint.net/"><img src="https://images.opencollective.com/wordhint/be86813/avatar.png" alt="WordHint" 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?v=4" alt="GitBook" height="32"></a> <a href="https://nx.dev"><img src="https://avatars.githubusercontent.com/u/23692104?v=4" alt="Nx" height="32"></a> <a href="https://herocoders.com"><img src="https://avatars.githubusercontent.com/u/37549774?v=4" alt="HeroCoders" 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>
+<!--sponsorsend-->

package/dist/cjs/index.cjs

@@ -296,6 +296,10 @@ class JSONSourceCode extends pluginKit.TextSourceCodeBase {
 /** @typedef {import("@eslint/core").Language} Language */
 /** @typedef {import("@eslint/core").OkParseResult<DocumentNode>} OkParseResult */
 /** @typedef {import("@eslint/core").ParseResult<DocumentNode>} ParseResult */
+/**
+ * @typedef {Object} JSONLanguageOptions
+ * @property {boolean} [allowTrailingCommas] Whether to allow trailing commas.
+ */
 
 //-----------------------------------------------------------------------------
 // Exports
@@ -351,26 +355,42 @@ class JSONLanguage {
 		this.#mode = mode;
 	}
 
-	/* eslint-disable class-methods-use-this, no-unused-vars -- Required to complete interface. */
 	/**
 	 * Validates the language options.
-	 * @param {Object} languageOptions The language options to validate.
+	 * @param {JSONLanguageOptions} languageOptions The language options to validate.
 	 * @returns {void}
 	 * @throws {Error} When the language options are invalid.
 	 */
 	validateLanguageOptions(languageOptions) {
-		// no-op
+		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.",
+				);
+			}
+		}
 	}
-	/* eslint-enable class-methods-use-this, no-unused-vars -- Required to complete interface. */
 
 	/**
 	 * 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 {ParseResult} The result of parsing.
 	 */
-	parse(file) {
+	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
@@ -383,6 +403,7 @@ class JSONLanguage {
 				mode: this.#mode,
 				ranges: true,
 				tokens: true,
+				allowTrailingCommas,
 			});
 
 			return {
@@ -530,7 +551,7 @@ var noEmptyKeys = {
 const plugin = {
 	meta: {
 		name: "@eslint/json",
-		version: "0.5.0", // x-release-please-version
+		version: "0.6.0", // x-release-please-version
 	},
 	languages: {
 		json: new JSONLanguage({ mode: "json" }),

package/dist/cjs/index.d.cts

@@ -13,6 +13,12 @@ export type RulesConfig = import("@eslint/core").RulesConfig;
 export type Language = import("@eslint/core").Language;
 export type OkParseResult = import("@eslint/core").OkParseResult<DocumentNode>;
 export type ParseResult = import("@eslint/core").ParseResult<DocumentNode>;
+export type JSONLanguageOptions = {
+    /**
+     * Whether to allow trailing commas.
+     */
+    allowTrailingCommas?: boolean;
+};
 /**
  * @filedescription Functions to fix up rules to provide missing methods on the `context` object.
  * @author Nicholas C. Zakas
@@ -20,6 +26,10 @@ export type ParseResult = import("@eslint/core").ParseResult<DocumentNode>;
 /** @typedef {import("@eslint/core").Language} Language */
 /** @typedef {import("@eslint/core").OkParseResult<DocumentNode>} OkParseResult */
 /** @typedef {import("@eslint/core").ParseResult<DocumentNode>} ParseResult */
+/**
+ * @typedef {Object} JSONLanguageOptions
+ * @property {boolean} [allowTrailingCommas] Whether to allow trailing commas.
+ */
 /**
  * JSON Language Object
  * @implements {Language}
@@ -60,17 +70,20 @@ export class JSONLanguage implements Language {
     visitorKeys: Record<string, string[]>;
     /**
      * Validates the language options.
-     * @param {Object} languageOptions The language options to validate.
+     * @param {JSONLanguageOptions} languageOptions The language options to validate.
      * @returns {void}
      * @throws {Error} When the language options are invalid.
      */
-    validateLanguageOptions(languageOptions: any): void;
+    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 {ParseResult} The result of parsing.
      */
-    parse(file: File): ParseResult;
+    parse(file: File, context: {
+        languageOptions: JSONLanguageOptions;
+    }): ParseResult;
     /**
      * Creates a new `JSONSourceCode` object from the given information.
      * @param {File} file The virtual file to create a `JSONSourceCode` object from.

package/dist/esm/index.d.ts

@@ -13,6 +13,12 @@ export type RulesConfig = import("@eslint/core").RulesConfig;
 export type Language = import("@eslint/core").Language;
 export type OkParseResult = import("@eslint/core").OkParseResult<DocumentNode>;
 export type ParseResult = import("@eslint/core").ParseResult<DocumentNode>;
+export type JSONLanguageOptions = {
+    /**
+     * Whether to allow trailing commas.
+     */
+    allowTrailingCommas?: boolean;
+};
 /**
  * @filedescription Functions to fix up rules to provide missing methods on the `context` object.
  * @author Nicholas C. Zakas
@@ -20,6 +26,10 @@ export type ParseResult = import("@eslint/core").ParseResult<DocumentNode>;
 /** @typedef {import("@eslint/core").Language} Language */
 /** @typedef {import("@eslint/core").OkParseResult<DocumentNode>} OkParseResult */
 /** @typedef {import("@eslint/core").ParseResult<DocumentNode>} ParseResult */
+/**
+ * @typedef {Object} JSONLanguageOptions
+ * @property {boolean} [allowTrailingCommas] Whether to allow trailing commas.
+ */
 /**
  * JSON Language Object
  * @implements {Language}
@@ -60,17 +70,20 @@ export class JSONLanguage implements Language {
     visitorKeys: Record<string, string[]>;
     /**
      * Validates the language options.
-     * @param {Object} languageOptions The language options to validate.
+     * @param {JSONLanguageOptions} languageOptions The language options to validate.
      * @returns {void}
      * @throws {Error} When the language options are invalid.
      */
-    validateLanguageOptions(languageOptions: any): void;
+    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 {ParseResult} The result of parsing.
      */
-    parse(file: File): ParseResult;
+    parse(file: File, context: {
+        languageOptions: JSONLanguageOptions;
+    }): ParseResult;
     /**
      * Creates a new `JSONSourceCode` object from the given information.
      * @param {File} file The virtual file to create a `JSONSourceCode` object from.

package/dist/esm/index.js

@@ -293,6 +293,10 @@ class JSONSourceCode extends TextSourceCodeBase {
 /** @typedef {import("@eslint/core").Language} Language */
 /** @typedef {import("@eslint/core").OkParseResult<DocumentNode>} OkParseResult */
 /** @typedef {import("@eslint/core").ParseResult<DocumentNode>} ParseResult */
+/**
+ * @typedef {Object} JSONLanguageOptions
+ * @property {boolean} [allowTrailingCommas] Whether to allow trailing commas.
+ */
 
 //-----------------------------------------------------------------------------
 // Exports
@@ -348,26 +352,42 @@ class JSONLanguage {
 		this.#mode = mode;
 	}
 
-	/* eslint-disable class-methods-use-this, no-unused-vars -- Required to complete interface. */
 	/**
 	 * Validates the language options.
-	 * @param {Object} languageOptions The language options to validate.
+	 * @param {JSONLanguageOptions} languageOptions The language options to validate.
 	 * @returns {void}
 	 * @throws {Error} When the language options are invalid.
 	 */
 	validateLanguageOptions(languageOptions) {
-		// no-op
+		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.",
+				);
+			}
+		}
 	}
-	/* eslint-enable class-methods-use-this, no-unused-vars -- Required to complete interface. */
 
 	/**
 	 * 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 {ParseResult} The result of parsing.
 	 */
-	parse(file) {
+	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
@@ -380,6 +400,7 @@ class JSONLanguage {
 				mode: this.#mode,
 				ranges: true,
 				tokens: true,
+				allowTrailingCommas,
 			});
 
 			return {
@@ -527,7 +548,7 @@ var noEmptyKeys = {
 const plugin = {
 	meta: {
 		name: "@eslint/json",
-		version: "0.5.0", // x-release-please-version
+		version: "0.6.0", // x-release-please-version
 	},
 	languages: {
 		json: new JSONLanguage({ mode: "json" }),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eslint/json",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "description": "JSON linting plugin for ESLint",
   "author": "Nicholas C. Zakas",
   "type": "module",
@@ -44,6 +44,7 @@
     "build:dedupe-types": "node tools/dedupe-types.js dist/cjs/index.cjs dist/esm/index.js",
     "build:cts": "node -e \"fs.copyFileSync('dist/esm/index.d.ts', 'dist/cjs/index.d.cts')\"",
     "build": "rollup -c && npm run build:dedupe-types && tsc -p tsconfig.esm.json && npm run build:cts",
+    "build:readme": "node tools/update-readme.js",
     "test:jsr": "npx jsr@latest publish --dry-run",
     "pretest": "npm run build",
     "lint": "eslint",
@@ -62,7 +63,7 @@
   "license": "Apache-2.0",
   "dependencies": {
     "@eslint/plugin-kit": "^0.2.0",
-    "@humanwhocodes/momoa": "^3.2.1"
+    "@humanwhocodes/momoa": "^3.3.0"
   },
   "devDependencies": {
     "@eslint/core": "^0.6.0",
@@ -71,6 +72,7 @@
     "dedent": "^1.5.3",
     "eslint": "^9.11.1",
     "eslint-config-eslint": "^11.0.0",
+    "got": "^14.4.2",
     "lint-staged": "^15.2.7",
     "mocha": "^10.4.0",
     "prettier": "^3.3.2",