@eslint/json 0.2.0 → 0.3.0

package/README.md

@@ -28,12 +28,13 @@ deno add @eslint/json
 
 ## Usage
 
-This package exports two different languages:
+This package exports these languages:
 
 -   `"json/json"` is for regular JSON files
--   `"json/jsonc"` is for JSON files that support comments (JSON-C) such as those used for Visual Studio Code configuration files
+-   `"json/jsonc"` is for JSON files that support comments ([JSONC](https://github.com/microsoft/node-jsonc-parser)) such as those used for Visual Studio Code configuration files
+-   `"json/json5"` is for [JSON5](https://json5.org) files
 
-Depending on which types of JSON files you'd like to lint, you can set up your `eslint.config.js` file to include just the files you'd like. Here's an example that lints both JSON and JSON-C files:
+Depending on which types of JSON files you'd like to lint, you can set up your `eslint.config.js` file to include just the files you'd like. Here's an example that lints JSON, JSONC, and JSON5 files:
 
 ```js
 import json from "@eslint/json";
@@ -54,7 +55,7 @@ export default [
 		},
 	},
 
-	// lint JSON-C files
+	// lint JSONC files
 	{
 		files: ["**/*.jsonc", ".vscode/*.json"],
 		language: "json/jsonc",
@@ -62,6 +63,15 @@ export default [
 			"json/no-duplicate-keys": "error",
 		},
 	},
+
+	// lint JSON5 files
+	{
+		files: ["**/*.json5"],
+		language: "json/json5",
+		rules: {
+			"json/no-duplicate-keys": "error",
+		},
+	},
 ];
 ```
 
@@ -81,12 +91,19 @@ export default [
 		...json.configs.recommended,
 	},
 
-	// lint JSON-C files
+	// lint JSONC files
 	{
 		files: ["**/*.jsonc"],
 		language: "json/jsonc",
 		...json.configs.recommended,
 	},
+
+	// lint JSON5 files
+	{
+		files: ["**/*.json5"],
+		language: "json/json5",
+		...json.configs.recommended,
+	},
 ];
 ```
 

package/dist/cjs/index.cjs

@@ -300,7 +300,7 @@ class JSONLanguage {
 
 	/**
 	 * The parser mode.
-	 * @type {"json"|"jsonc"}
+	 * @type {"json"|"jsonc"|"json5"}
 	 */
 	#mode = "json";
 
@@ -313,7 +313,7 @@ class JSONLanguage {
 	/**
 	 * Creates a new instance.
 	 * @param {Object} options The options to use for this instance.
-	 * @param {"json"|"jsonc"} options.mode The parser mode to use.
+	 * @param {"json"|"jsonc"|"json5"} options.mode The parser mode to use.
 	 */
 	constructor({ mode }) {
 		this.#mode = mode;
@@ -397,7 +397,7 @@ class JSONLanguage {
  */
 
 //-----------------------------------------------------------------------------
-// Type Definitions
+// Rule Definition
 //-----------------------------------------------------------------------------
 
 var noDuplicateKeys = {
@@ -424,7 +424,10 @@ var noDuplicateKeys = {
 			},
 
 			Member(node) {
-				const key = node.name.value;
+				const key =
+					node.name.type === "String"
+						? node.name.value
+						: node.name.name;
 
 				if (keys.has(key)) {
 					context.report({
@@ -466,7 +469,10 @@ var noEmptyKeys = {
 	create(context) {
 		return {
 			Member(node) {
-				const key = node.name.value;
+				const key =
+					node.name.type === "String"
+						? node.name.value
+						: node.name.name;
 
 				if (key.trim() === "") {
 					context.report({
@@ -492,11 +498,12 @@ var noEmptyKeys = {
 const plugin = {
 	meta: {
 		name: "@eslint/json",
-		version: "0.2.0", // x-release-please-version
+		version: "0.3.0", // x-release-please-version
 	},
 	languages: {
 		json: new JSONLanguage({ mode: "json" }),
 		jsonc: new JSONLanguage({ mode: "jsonc" }),
+		json5: new JSONLanguage({ mode: "json5" }),
 	},
 	rules: {
 		"no-duplicate-keys": noDuplicateKeys,

package/dist/cjs/index.d.cts

@@ -19,6 +19,7 @@ declare namespace plugin {
     namespace languages {
         let json: JSONLanguage;
         let jsonc: JSONLanguage;
+        let json5: JSONLanguage;
     }
     let rules: {
         "no-duplicate-keys": {
@@ -69,10 +70,10 @@ declare class JSONLanguage implements Language {
     /**
      * Creates a new instance.
      * @param {Object} options The options to use for this instance.
-     * @param {"json"|"jsonc"} options.mode The parser mode to use.
+     * @param {"json"|"jsonc"|"json5"} options.mode The parser mode to use.
      */
     constructor({ mode }: {
-        mode: "json" | "jsonc";
+        mode: "json" | "jsonc" | "json5";
     });
     /**
      * The type of file to read.

package/dist/esm/index.d.ts

@@ -19,6 +19,7 @@ declare namespace plugin {
     namespace languages {
         let json: JSONLanguage;
         let jsonc: JSONLanguage;
+        let json5: JSONLanguage;
     }
     let rules: {
         "no-duplicate-keys": {
@@ -69,10 +70,10 @@ declare class JSONLanguage implements Language {
     /**
      * Creates a new instance.
      * @param {Object} options The options to use for this instance.
-     * @param {"json"|"jsonc"} options.mode The parser mode to use.
+     * @param {"json"|"jsonc"|"json5"} options.mode The parser mode to use.
      */
     constructor({ mode }: {
-        mode: "json" | "jsonc";
+        mode: "json" | "jsonc" | "json5";
     });
     /**
      * The type of file to read.

package/dist/esm/index.js

@@ -299,7 +299,7 @@ class JSONLanguage {
 
 	/**
 	 * The parser mode.
-	 * @type {"json"|"jsonc"}
+	 * @type {"json"|"jsonc"|"json5"}
 	 */
 	#mode = "json";
 
@@ -312,7 +312,7 @@ class JSONLanguage {
 	/**
 	 * Creates a new instance.
 	 * @param {Object} options The options to use for this instance.
-	 * @param {"json"|"jsonc"} options.mode The parser mode to use.
+	 * @param {"json"|"jsonc"|"json5"} options.mode The parser mode to use.
 	 */
 	constructor({ mode }) {
 		this.#mode = mode;
@@ -396,7 +396,7 @@ class JSONLanguage {
  */
 
 //-----------------------------------------------------------------------------
-// Type Definitions
+// Rule Definition
 //-----------------------------------------------------------------------------
 
 var noDuplicateKeys = {
@@ -423,7 +423,10 @@ var noDuplicateKeys = {
 			},
 
 			Member(node) {
-				const key = node.name.value;
+				const key =
+					node.name.type === "String"
+						? node.name.value
+						: node.name.name;
 
 				if (keys.has(key)) {
 					context.report({
@@ -465,7 +468,10 @@ var noEmptyKeys = {
 	create(context) {
 		return {
 			Member(node) {
-				const key = node.name.value;
+				const key =
+					node.name.type === "String"
+						? node.name.value
+						: node.name.name;
 
 				if (key.trim() === "") {
 					context.report({
@@ -491,11 +497,12 @@ var noEmptyKeys = {
 const plugin = {
 	meta: {
 		name: "@eslint/json",
-		version: "0.2.0", // x-release-please-version
+		version: "0.3.0", // x-release-please-version
 	},
 	languages: {
 		json: new JSONLanguage({ mode: "json" }),
 		jsonc: new JSONLanguage({ mode: "jsonc" }),
+		json5: new JSONLanguage({ mode: "json5" }),
 	},
 	rules: {
 		"no-duplicate-keys": noDuplicateKeys,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eslint/json",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "JSON linting plugin for ESLint",
   "author": "Nicholas C. Zakas",
   "type": "module",
@@ -61,7 +61,7 @@
   ],
   "license": "Apache-2.0",
   "dependencies": {
-    "@humanwhocodes/momoa": "^3.1.1"
+    "@humanwhocodes/momoa": "^3.2.0"
   },
   "devDependencies": {
     "@eslint/core": "^0.3.0",