exadev-eslint-config 2.13.0 → 2.14.0

package/README.md

@@ -160,6 +160,14 @@ export default tseslint.config(
 
 Trailing arguments are arbitrary flat-config objects, appended in order after everything else -- `exadevConfig({}, { rules: { 'no-console': 'warn' } })` is equivalent to spreading the default export plus one more config object.
 
+## RFC 8785 canonical JSON formatting
+
+Every JSON file (`**/*.json`, excluding `**/tsconfig*.json`, `**/turbo.json`, and `**/package.json`) is linted against [`eslint-plugin-json-canonical`](https://github.com/ExaDev/eslint-plugin-json-canonical)'s `configs.recommended` -- plain UTF-16 code-unit key ordering, canonical number formatting, and canonical string escaping, per [RFC 8785](https://www.rfc-editor.org/rfc/rfc8785). This is bundled unconditionally, the same way jsdoc/tsdoc support is: `eslint-plugin-json-canonical` is a plain dependency of this package, so every consumer already has it. There is no option to turn it off.
+
+The plugin's own whitespace-collapsing rule (`no-insignificant-whitespace`, which reformats a document to a single compacted line) is deliberately not part of `configs.recommended` and is not enabled here either -- it stays available for a consumer to opt into directly for their own genuine canonicalization pass.
+
+`**/tsconfig*.json` and `**/turbo.json` are excluded because they genuinely carry comments (TypeScript and turbo both accept them), which `@eslint/json`'s `json/json` language -- what this plugin's recommended config hard-codes -- has no concept of and fails to parse. `**/package.json` is excluded because its key order is a distinct, separately-optional concern (syncpack-style field-priority pinning, not RFC 8785's plain alphabetical order); a project wanting that instead reaches for `eslint-plugin-json-canonical` directly on its own terms, not through this package.
+
 ## Rules
 
 | Rule | Fixable | Description |

package/dist/index.cjs

@@ -28,6 +28,8 @@ let eslint_plugin_jsdoc = require("eslint-plugin-jsdoc");
 eslint_plugin_jsdoc = __toESM(eslint_plugin_jsdoc, 1);
 let eslint_plugin_tsdoc = require("eslint-plugin-tsdoc");
 eslint_plugin_tsdoc = __toESM(eslint_plugin_tsdoc, 1);
+let eslint_plugin_json_canonical = require("eslint-plugin-json-canonical");
+eslint_plugin_json_canonical = __toESM(eslint_plugin_json_canonical, 1);
 let node_module = require("node:module");
 let _eslint_js = require("@eslint/js");
 _eslint_js = __toESM(_eslint_js, 1);
@@ -74,6 +76,22 @@ const jsdocAndTsdoc = [{
 	rules: { "tsdoc/syntax": "error" }
 }];
 //#endregion
+//#region src/json-canonical.ts
+function isSingleFlatConfig(value) {
+	return typeof value === "object" && value !== null && !Array.isArray(value) && "language" in value;
+}
+const recommended = eslint_plugin_json_canonical.default.configs?.["recommended"];
+if (!isSingleFlatConfig(recommended)) throw new Error("eslint-plugin-json-canonical: expected configs.recommended to be a single flat config object, got an array or undefined");
+const jsonCanonicalConfig = [{
+	files: ["**/*.json"],
+	ignores: [
+		"**/tsconfig*.json",
+		"**/turbo.json",
+		"**/package.json"
+	],
+	...recommended
+}];
+//#endregion
 //#region src/optional-plugin.ts
 const nodeRequire = (0, node_module.createRequire)(require("url").pathToFileURL(__filename).href);
 function tryRequire(specifier, requireFn = nodeRequire) {
@@ -159,7 +177,7 @@ function buildReactConfig(options = {}) {
 }
 //#endregion
 //#region package.json
-var version = "2.13.0";
+var version = "2.14.0";
 //#endregion
 //#region src/rules/barrel-helpers.ts
 const INDEX_BASENAME$1 = /^index\.[cm]?[tj]sx?$/;
@@ -1562,6 +1580,7 @@ function exadevConfig(options = {}, ...userConfigs) {
 	return toPublicConfigArray([
 		...recommendedTypeChecked,
 		...jsdocAndTsdoc,
+		...jsonCanonicalConfig,
 		...buildReactConfig({ enabled: options.react }),
 		...buildNextjsConfig({ enabled: options.nextjs }),
 		...userConfigs

package/dist/index.js

@@ -1,5 +1,6 @@
 import jsdoc from "eslint-plugin-jsdoc";
 import tsdoc from "eslint-plugin-tsdoc";
+import jsonCanonical from "eslint-plugin-json-canonical";
 import { createRequire } from "node:module";
 import js from "@eslint/js";
 import tseslint from "typescript-eslint";
@@ -43,6 +44,22 @@ const jsdocAndTsdoc = [{
 	rules: { "tsdoc/syntax": "error" }
 }];
 //#endregion
+//#region src/json-canonical.ts
+function isSingleFlatConfig(value) {
+	return typeof value === "object" && value !== null && !Array.isArray(value) && "language" in value;
+}
+const recommended = jsonCanonical.configs?.["recommended"];
+if (!isSingleFlatConfig(recommended)) throw new Error("eslint-plugin-json-canonical: expected configs.recommended to be a single flat config object, got an array or undefined");
+const jsonCanonicalConfig = [{
+	files: ["**/*.json"],
+	ignores: [
+		"**/tsconfig*.json",
+		"**/turbo.json",
+		"**/package.json"
+	],
+	...recommended
+}];
+//#endregion
 //#region src/optional-plugin.ts
 const nodeRequire = createRequire(import.meta.url);
 function tryRequire(specifier, requireFn = nodeRequire) {
@@ -128,7 +145,7 @@ function buildReactConfig(options = {}) {
 }
 //#endregion
 //#region package.json
-var version = "2.13.0";
+var version = "2.14.0";
 //#endregion
 //#region src/rules/barrel-helpers.ts
 const INDEX_BASENAME$1 = /^index\.[cm]?[tj]sx?$/;
@@ -1531,6 +1548,7 @@ function exadevConfig(options = {}, ...userConfigs) {
 	return toPublicConfigArray([
 		...recommendedTypeChecked,
 		...jsdocAndTsdoc,
+		...jsonCanonicalConfig,
 		...buildReactConfig({ enabled: options.react }),
 		...buildNextjsConfig({ enabled: options.nextjs }),
 		...userConfigs

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "exadev-eslint-config",
-  "version": "2.13.0",
+  "version": "2.14.0",
   "description": "Shared custom ESLint rules and plugin for ExaDev projects",
   "type": "module",
   "sideEffects": false,
@@ -88,6 +88,7 @@
     "@eslint/js": "^10.0.1",
     "@typescript-eslint/utils": "8.67.0",
     "eslint-plugin-jsdoc": "64.3.6",
+    "eslint-plugin-json-canonical": "1.0.0",
     "eslint-plugin-tsdoc": "^0.5.2",
     "ts-api-utils": "^2.5.0"
   },