@eslint/json 0.9.0 → 0.10.0

package/README.md

@@ -161,6 +161,7 @@ export default [
   like integers but are too large, and
   [subnormal numbers](https://en.wikipedia.org/wiki/Subnormal_number).
 - `no-unnormalized-keys` - warns on keys containing [unnormalized characters](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/normalize#description). You can optionally specify the normalization form via `{ form: "form_name" }`, where `form_name` can be any of `"NFC"`, `"NFD"`, `"NFKC"`, or `"NFKD"`.
+- `sort-keys` - warns when keys are not in the specified order. Based on the ESLint [`sort-keys`](https://eslint.org/docs/latest/rules/sort-keys) rule.
 - `top-level-interop` - warns when the top-level item in the document is neither an array nor an object. This can be enabled to ensure maximal interoperability with the oldest JSON parsers.
 
 ## Configuration Comments
@@ -256,8 +257,8 @@ 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://syntax.fm"><img src="https://github.com/syntaxfm.png" alt="Syntax" 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://opensource.mercedes-benz.com/"><img src="https://avatars.githubusercontent.com/u/34240465?v=4" alt="Mercedes-Benz Group" height="32"></a> <a href="https://herocoders.com"><img src="https://avatars.githubusercontent.com/u/37549774?v=4" alt="HeroCoders" height="32"></a></p>
+<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" alt="American Express" 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.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://nolebase.ayaka.io"><img src="https://avatars.githubusercontent.com/u/11081491" alt="Neko" 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></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/cjs/index.cjs

@@ -4,6 +4,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var momoa = require('@humanwhocodes/momoa');
 var pluginKit = require('@eslint/plugin-kit');
+var naturalCompare = require('natural-compare');
 
 /**
  * @fileoverview The JSONSourceCode class.
@@ -718,6 +719,184 @@ var noUnnormalizedKeys = {
 	},
 };
 
+/**
+ * @fileoverview Rule to require JSON object keys to be sorted. Copied largely from https://github.com/eslint/eslint/blob/main/lib/rules/sort-keys.js
+ * @author Robin Thomas
+ */
+
+
+const hasNonWhitespace = /\S/u;
+
+const comparators = {
+	ascending: {
+		alphanumeric: {
+			sensitive: (a, b) => a <= b,
+			insensitive: (a, b) => a.toLowerCase() <= b.toLowerCase(),
+		},
+		natural: {
+			sensitive: (a, b) => naturalCompare(a, b) <= 0,
+			insensitive: (a, b) =>
+				naturalCompare(a.toLowerCase(), b.toLowerCase()) <= 0,
+		},
+	},
+	descending: {
+		alphanumeric: {
+			sensitive: (a, b) =>
+				comparators.ascending.alphanumeric.sensitive(b, a),
+			insensitive: (a, b) =>
+				comparators.ascending.alphanumeric.insensitive(b, a),
+		},
+		natural: {
+			sensitive: (a, b) => comparators.ascending.natural.sensitive(b, a),
+			insensitive: (a, b) =>
+				comparators.ascending.natural.insensitive(b, a),
+		},
+	},
+};
+
+function getKey(member) {
+	return member.name.type === `Identifier`
+		? member.name.name
+		: member.name.value;
+}
+
+var sortKeys = {
+	meta: {
+		type: /** @type {const} */ ("suggestion"),
+
+		defaultOptions: [
+			"asc",
+			{
+				allowLineSeparatedGroups: false,
+				caseSensitive: true,
+				minKeys: 2,
+				natural: false,
+			},
+		],
+
+		docs: {
+			description: `Require JSON object keys to be sorted`,
+		},
+
+		messages: {
+			sortKeys:
+				"Expected object keys to be in {{sortName}} case-{{sensitivity}} {{direction}} order. '{{thisName}}' should be before '{{prevName}}'.",
+		},
+
+		schema: [
+			{
+				enum: ["asc", "desc"],
+			},
+			{
+				type: "object",
+				properties: {
+					caseSensitive: {
+						type: "boolean",
+					},
+					natural: {
+						type: "boolean",
+					},
+					minKeys: {
+						type: "integer",
+						minimum: 2,
+					},
+					allowLineSeparatedGroups: {
+						type: "boolean",
+					},
+				},
+				additionalProperties: false,
+			},
+		],
+	},
+
+	create(context) {
+		const [
+			directionShort,
+			{ allowLineSeparatedGroups, caseSensitive, natural, minKeys },
+		] = context.options;
+
+		const direction = directionShort === "asc" ? "ascending" : "descending";
+		const sortName = natural ? "natural" : "alphanumeric";
+		const sensitivity = caseSensitive ? "sensitive" : "insensitive";
+		const isValidOrder = comparators[direction][sortName][sensitivity];
+
+		// Note that @humanwhocodes/momoa doesn't include comments in the object.members tree, so we can't just see if a member is preceded by a comment
+		const commentLineNums = new Set();
+		for (const comment of context.sourceCode.comments) {
+			for (
+				let lineNum = comment.loc.start.line;
+				lineNum <= comment.loc.end.line;
+				lineNum += 1
+			) {
+				commentLineNums.add(lineNum);
+			}
+		}
+
+		// Note that there can be comments *inside* members, e.g. `{"foo: /* comment *\/ "bar"}`, but these are ignored when calculating line-separated groups
+		function isLineSeparated(prevMember, member) {
+			const prevMemberEndLine = prevMember.loc.end.line;
+			const thisStartLine = member.loc.start.line;
+			if (thisStartLine - prevMemberEndLine < 2) {
+				return false;
+			}
+
+			for (
+				let lineNum = prevMemberEndLine + 1;
+				lineNum < thisStartLine;
+				lineNum += 1
+			) {
+				if (
+					!commentLineNums.has(lineNum) &&
+					!hasNonWhitespace.test(
+						context.sourceCode.lines[lineNum - 1],
+					)
+				) {
+					return true;
+				}
+			}
+
+			return false;
+		}
+
+		return {
+			Object(node) {
+				let prevMember;
+				let prevName;
+
+				if (node.members.length < minKeys) {
+					return;
+				}
+
+				for (const member of node.members) {
+					const thisName = getKey(member);
+
+					if (
+						prevMember &&
+						!isValidOrder(prevName, thisName) &&
+						(!allowLineSeparatedGroups ||
+							!isLineSeparated(prevMember, member))
+					) {
+						context.report({
+							loc: member.name.loc,
+							messageId: "sortKeys",
+							data: {
+								thisName,
+								prevName,
+								direction,
+								sensitivity,
+								sortName,
+							},
+						});
+					}
+
+					prevMember = member;
+					prevName = thisName;
+				}
+			},
+		};
+	},
+};
+
 /**
  * @fileoverview Rule to ensure top-level items are either an array or ojbect.
  * @author Joe Hildebrand
@@ -767,7 +946,7 @@ var topLevelInterop = {
 const plugin = {
 	meta: {
 		name: "@eslint/json",
-		version: "0.9.0", // x-release-please-version
+		version: "0.10.0", // x-release-please-version
 	},
 	languages: {
 		json: new JSONLanguage({ mode: "json" }),
@@ -779,6 +958,7 @@ const plugin = {
 		"no-empty-keys": noEmptyKeys,
 		"no-unsafe-values": noUnsafeValues,
 		"no-unnormalized-keys": noUnnormalizedKeys,
+		"sort-keys": sortKeys,
 		"top-level-interop": topLevelInterop,
 	},
 	configs: {

package/dist/cjs/index.d.cts

@@ -244,6 +244,51 @@ declare namespace plugin {
                 Member(node: any): void;
             };
         };
+        "sort-keys": {
+            meta: {
+                type: "suggestion";
+                defaultOptions: (string | {
+                    allowLineSeparatedGroups: boolean;
+                    caseSensitive: boolean;
+                    minKeys: number;
+                    natural: boolean;
+                })[];
+                docs: {
+                    description: string;
+                };
+                messages: {
+                    sortKeys: string;
+                };
+                schema: ({
+                    enum: string[];
+                    type?: undefined;
+                    properties?: undefined;
+                    additionalProperties?: undefined;
+                } | {
+                    type: string;
+                    properties: {
+                        caseSensitive: {
+                            type: string;
+                        };
+                        natural: {
+                            type: string;
+                        };
+                        minKeys: {
+                            type: string;
+                            minimum: number;
+                        };
+                        allowLineSeparatedGroups: {
+                            type: string;
+                        };
+                    };
+                    additionalProperties: boolean;
+                    enum?: undefined;
+                })[];
+            };
+            create(context: any): {
+                Object(node: any): void;
+            };
+        };
         "top-level-interop": {
             meta: {
                 type: "problem";

package/dist/esm/index.d.ts

@@ -244,6 +244,51 @@ declare namespace plugin {
                 Member(node: any): void;
             };
         };
+        "sort-keys": {
+            meta: {
+                type: "suggestion";
+                defaultOptions: (string | {
+                    allowLineSeparatedGroups: boolean;
+                    caseSensitive: boolean;
+                    minKeys: number;
+                    natural: boolean;
+                })[];
+                docs: {
+                    description: string;
+                };
+                messages: {
+                    sortKeys: string;
+                };
+                schema: ({
+                    enum: string[];
+                    type?: undefined;
+                    properties?: undefined;
+                    additionalProperties?: undefined;
+                } | {
+                    type: string;
+                    properties: {
+                        caseSensitive: {
+                            type: string;
+                        };
+                        natural: {
+                            type: string;
+                        };
+                        minKeys: {
+                            type: string;
+                            minimum: number;
+                        };
+                        allowLineSeparatedGroups: {
+                            type: string;
+                        };
+                    };
+                    additionalProperties: boolean;
+                    enum?: undefined;
+                })[];
+            };
+            create(context: any): {
+                Object(node: any): void;
+            };
+        };
         "top-level-interop": {
             meta: {
                 type: "problem";

package/dist/esm/index.js

@@ -1,6 +1,7 @@
 // @ts-self-types="./index.d.ts"
 import { iterator, visitorKeys, parse } from '@humanwhocodes/momoa';
 import { ConfigCommentParser, TextSourceCodeBase, Directive, VisitNodeStep } from '@eslint/plugin-kit';
+import naturalCompare from 'natural-compare';
 
 /**
  * @fileoverview The JSONSourceCode class.
@@ -715,6 +716,184 @@ var noUnnormalizedKeys = {
 	},
 };
 
+/**
+ * @fileoverview Rule to require JSON object keys to be sorted. Copied largely from https://github.com/eslint/eslint/blob/main/lib/rules/sort-keys.js
+ * @author Robin Thomas
+ */
+
+
+const hasNonWhitespace = /\S/u;
+
+const comparators = {
+	ascending: {
+		alphanumeric: {
+			sensitive: (a, b) => a <= b,
+			insensitive: (a, b) => a.toLowerCase() <= b.toLowerCase(),
+		},
+		natural: {
+			sensitive: (a, b) => naturalCompare(a, b) <= 0,
+			insensitive: (a, b) =>
+				naturalCompare(a.toLowerCase(), b.toLowerCase()) <= 0,
+		},
+	},
+	descending: {
+		alphanumeric: {
+			sensitive: (a, b) =>
+				comparators.ascending.alphanumeric.sensitive(b, a),
+			insensitive: (a, b) =>
+				comparators.ascending.alphanumeric.insensitive(b, a),
+		},
+		natural: {
+			sensitive: (a, b) => comparators.ascending.natural.sensitive(b, a),
+			insensitive: (a, b) =>
+				comparators.ascending.natural.insensitive(b, a),
+		},
+	},
+};
+
+function getKey(member) {
+	return member.name.type === `Identifier`
+		? member.name.name
+		: member.name.value;
+}
+
+var sortKeys = {
+	meta: {
+		type: /** @type {const} */ ("suggestion"),
+
+		defaultOptions: [
+			"asc",
+			{
+				allowLineSeparatedGroups: false,
+				caseSensitive: true,
+				minKeys: 2,
+				natural: false,
+			},
+		],
+
+		docs: {
+			description: `Require JSON object keys to be sorted`,
+		},
+
+		messages: {
+			sortKeys:
+				"Expected object keys to be in {{sortName}} case-{{sensitivity}} {{direction}} order. '{{thisName}}' should be before '{{prevName}}'.",
+		},
+
+		schema: [
+			{
+				enum: ["asc", "desc"],
+			},
+			{
+				type: "object",
+				properties: {
+					caseSensitive: {
+						type: "boolean",
+					},
+					natural: {
+						type: "boolean",
+					},
+					minKeys: {
+						type: "integer",
+						minimum: 2,
+					},
+					allowLineSeparatedGroups: {
+						type: "boolean",
+					},
+				},
+				additionalProperties: false,
+			},
+		],
+	},
+
+	create(context) {
+		const [
+			directionShort,
+			{ allowLineSeparatedGroups, caseSensitive, natural, minKeys },
+		] = context.options;
+
+		const direction = directionShort === "asc" ? "ascending" : "descending";
+		const sortName = natural ? "natural" : "alphanumeric";
+		const sensitivity = caseSensitive ? "sensitive" : "insensitive";
+		const isValidOrder = comparators[direction][sortName][sensitivity];
+
+		// Note that @humanwhocodes/momoa doesn't include comments in the object.members tree, so we can't just see if a member is preceded by a comment
+		const commentLineNums = new Set();
+		for (const comment of context.sourceCode.comments) {
+			for (
+				let lineNum = comment.loc.start.line;
+				lineNum <= comment.loc.end.line;
+				lineNum += 1
+			) {
+				commentLineNums.add(lineNum);
+			}
+		}
+
+		// Note that there can be comments *inside* members, e.g. `{"foo: /* comment *\/ "bar"}`, but these are ignored when calculating line-separated groups
+		function isLineSeparated(prevMember, member) {
+			const prevMemberEndLine = prevMember.loc.end.line;
+			const thisStartLine = member.loc.start.line;
+			if (thisStartLine - prevMemberEndLine < 2) {
+				return false;
+			}
+
+			for (
+				let lineNum = prevMemberEndLine + 1;
+				lineNum < thisStartLine;
+				lineNum += 1
+			) {
+				if (
+					!commentLineNums.has(lineNum) &&
+					!hasNonWhitespace.test(
+						context.sourceCode.lines[lineNum - 1],
+					)
+				) {
+					return true;
+				}
+			}
+
+			return false;
+		}
+
+		return {
+			Object(node) {
+				let prevMember;
+				let prevName;
+
+				if (node.members.length < minKeys) {
+					return;
+				}
+
+				for (const member of node.members) {
+					const thisName = getKey(member);
+
+					if (
+						prevMember &&
+						!isValidOrder(prevName, thisName) &&
+						(!allowLineSeparatedGroups ||
+							!isLineSeparated(prevMember, member))
+					) {
+						context.report({
+							loc: member.name.loc,
+							messageId: "sortKeys",
+							data: {
+								thisName,
+								prevName,
+								direction,
+								sensitivity,
+								sortName,
+							},
+						});
+					}
+
+					prevMember = member;
+					prevName = thisName;
+				}
+			},
+		};
+	},
+};
+
 /**
  * @fileoverview Rule to ensure top-level items are either an array or ojbect.
  * @author Joe Hildebrand
@@ -764,7 +943,7 @@ var topLevelInterop = {
 const plugin = {
 	meta: {
 		name: "@eslint/json",
-		version: "0.9.0", // x-release-please-version
+		version: "0.10.0", // x-release-please-version
 	},
 	languages: {
 		json: new JSONLanguage({ mode: "json" }),
@@ -776,6 +955,7 @@ const plugin = {
 		"no-empty-keys": noEmptyKeys,
 		"no-unsafe-values": noUnsafeValues,
 		"no-unnormalized-keys": noUnnormalizedKeys,
+		"sort-keys": sortKeys,
 		"top-level-interop": topLevelInterop,
 	},
 	configs: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eslint/json",
-  "version": "0.9.0",
+  "version": "0.10.0",
   "description": "JSON linting plugin for ESLint",
   "author": "Nicholas C. Zakas",
   "type": "module",
@@ -63,11 +63,12 @@
   ],
   "license": "Apache-2.0",
   "dependencies": {
-    "@eslint/plugin-kit": "^0.2.3",
-    "@humanwhocodes/momoa": "^3.3.4"
+    "@eslint/core": "^0.10.0",
+    "@eslint/plugin-kit": "^0.2.5",
+    "@humanwhocodes/momoa": "^3.3.4",
+    "natural-compare": "^1.4.0"
   },
   "devDependencies": {
-    "@eslint/core": "^0.6.0",
     "@types/eslint": "^8.56.10",
     "c8": "^9.1.0",
     "dedent": "^1.5.3",