exadev-eslint-config 2.12.3 → 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 |
@@ -170,6 +178,7 @@ Trailing arguments are arbitrary flat-config objects, appended in order after ev
 | `no-non-barrel-reexport` | ✓ | Re-exports belong only in a barrel. Catches the split form across two statements (`import { x } from './y'; export { x };` or `export default x;`) which no AST selector alone can match. Autofix deletes the export and the now-pointless import when it was the import's only use. Self-scopes away from any index file. |
 | `no-side-effects-in-index` | | A barrel file may contain only re-export statements -- nothing that could execute at import time. Self-scopes to any index file. |
 | `barrel-direct-siblings-only` | | A barrel may re-export only from a direct sibling (`./module`), never a nested path, parent, or bare package specifier (mode 3). |
+| `no-control-flow` | | Bans `if`/`switch`/`for`/`for-in`/`for-of`/`while`/`do-while`/the ternary operator outright. Not part of `recommended` or `barrel` -- ordinary code legitimately needs control flow, so this is opt-in, wired via a consumer's own `files` glob for the specific packages that want it (a composition-root package selecting an adapter/strategy by a validated key, say): a lookup table replaces a branch, a declarative array method (`map`/`filter`/`some`/`every`/...) replaces a loop. Requires no type information. |
 | `no-pointless-reassignment` | ✓ | `const foo = bar` where both sides are plain identifiers and the alias adds no transformation. Autofix rewrites every read to the original name and deletes the declaration (including its `export` keyword, when exported). Still reported but deliberately not auto-fixable where collapsing the alias would change meaning: an explicit type annotation (`const exhaustive: never = item` -- the annotation is the point), a read where the original name is shadowed, a read as a shorthand object property, more than one declarator in the statement, or a source that is written to anywhere. |
 | `no-object-assign` | ✓/suggestion | `Object.assign` does not check a source object's properties against the target's declared types, unlike object spread. A fresh object-literal target autofixes to `{ ...target, ...source }`; mutating an existing reassignable binding offers a suggestion only (changes the object's identity); a `const` binding or a non-statement call site gets a plain report with no fix. |
 | `no-mutable-union-array-param` | ✓ | A function parameter typed as an array of a union (`(string \| number)[]`) accepts a narrower caller array (`number[]`) by covariance; calling `push`/`unshift`/`splice`/`fill`/`copyWithin` on it can then insert a value the caller's own array was never declared to hold. Autofix marks the parameter `readonly`, turning the mutating call into a real compile error to resolve deliberately. Requires no type information. |

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.12.3";
+var version = "2.14.0";
 //#endregion
 //#region src/rules/barrel-helpers.ts
 const INDEX_BASENAME$1 = /^index\.[cm]?[tj]sx?$/;
@@ -516,6 +534,76 @@ const noArrayIsArrayMutation = createRule$7({
 	}
 });
 //#endregion
+//#region src/rules/no-control-flow.ts
+const noControlFlow = {
+	meta: {
+		type: "problem",
+		schema: [],
+		messages: {
+			ifStatement: "Use a lookup table, not an if/else branch.",
+			switchStatement: "Use a lookup table, not a switch branch.",
+			forStatement: "Use a lookup table or a declarative array method, not a for loop.",
+			forInStatement: "Use a lookup table or Object.entries, not a for-in loop.",
+			forOfStatement: "Use a declarative array method, not a for-of loop.",
+			whileStatement: "Use a lookup table or a declarative array method, not a while loop.",
+			doWhileStatement: "Use a lookup table or a declarative array method, not a do-while loop.",
+			conditionalExpression: "Use a lookup table, not a ternary."
+		}
+	},
+	create(context) {
+		return {
+			IfStatement(node) {
+				context.report({
+					node,
+					messageId: "ifStatement"
+				});
+			},
+			SwitchStatement(node) {
+				context.report({
+					node,
+					messageId: "switchStatement"
+				});
+			},
+			ForStatement(node) {
+				context.report({
+					node,
+					messageId: "forStatement"
+				});
+			},
+			ForInStatement(node) {
+				context.report({
+					node,
+					messageId: "forInStatement"
+				});
+			},
+			ForOfStatement(node) {
+				context.report({
+					node,
+					messageId: "forOfStatement"
+				});
+			},
+			WhileStatement(node) {
+				context.report({
+					node,
+					messageId: "whileStatement"
+				});
+			},
+			DoWhileStatement(node) {
+				context.report({
+					node,
+					messageId: "doWhileStatement"
+				});
+			},
+			ConditionalExpression(node) {
+				context.report({
+					node,
+					messageId: "conditionalExpression"
+				});
+			}
+		};
+	}
+};
+//#endregion
 //#region src/rules/no-enum-number-widening.ts
 const noEnumNumberWidening = _typescript_eslint_utils.ESLintUtils.RuleCreator((name) => `https://github.com/ExaDev/eslint-config/blob/main/src/rules/${name}.ts`)({
 	name: "no-enum-number-widening",
@@ -1356,6 +1444,7 @@ const plugin = {
 		"barrel-direct-siblings-only": barrelDirectSiblingsOnly,
 		"barrel-policy": barrelPolicy,
 		"no-array-isarray-mutation": noArrayIsArrayMutation,
+		"no-control-flow": noControlFlow,
 		"no-enum-number-widening": noEnumNumberWidening,
 		"no-enum-reverse-lookup-widening": noEnumReverseLookupWidening,
 		"no-index-files": noIndexFiles,
@@ -1491,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.12.3";
+var version = "2.14.0";
 //#endregion
 //#region src/rules/barrel-helpers.ts
 const INDEX_BASENAME$1 = /^index\.[cm]?[tj]sx?$/;
@@ -485,6 +502,76 @@ const noArrayIsArrayMutation = createRule$7({
 	}
 });
 //#endregion
+//#region src/rules/no-control-flow.ts
+const noControlFlow = {
+	meta: {
+		type: "problem",
+		schema: [],
+		messages: {
+			ifStatement: "Use a lookup table, not an if/else branch.",
+			switchStatement: "Use a lookup table, not a switch branch.",
+			forStatement: "Use a lookup table or a declarative array method, not a for loop.",
+			forInStatement: "Use a lookup table or Object.entries, not a for-in loop.",
+			forOfStatement: "Use a declarative array method, not a for-of loop.",
+			whileStatement: "Use a lookup table or a declarative array method, not a while loop.",
+			doWhileStatement: "Use a lookup table or a declarative array method, not a do-while loop.",
+			conditionalExpression: "Use a lookup table, not a ternary."
+		}
+	},
+	create(context) {
+		return {
+			IfStatement(node) {
+				context.report({
+					node,
+					messageId: "ifStatement"
+				});
+			},
+			SwitchStatement(node) {
+				context.report({
+					node,
+					messageId: "switchStatement"
+				});
+			},
+			ForStatement(node) {
+				context.report({
+					node,
+					messageId: "forStatement"
+				});
+			},
+			ForInStatement(node) {
+				context.report({
+					node,
+					messageId: "forInStatement"
+				});
+			},
+			ForOfStatement(node) {
+				context.report({
+					node,
+					messageId: "forOfStatement"
+				});
+			},
+			WhileStatement(node) {
+				context.report({
+					node,
+					messageId: "whileStatement"
+				});
+			},
+			DoWhileStatement(node) {
+				context.report({
+					node,
+					messageId: "doWhileStatement"
+				});
+			},
+			ConditionalExpression(node) {
+				context.report({
+					node,
+					messageId: "conditionalExpression"
+				});
+			}
+		};
+	}
+};
+//#endregion
 //#region src/rules/no-enum-number-widening.ts
 const noEnumNumberWidening = ESLintUtils.RuleCreator((name) => `https://github.com/ExaDev/eslint-config/blob/main/src/rules/${name}.ts`)({
 	name: "no-enum-number-widening",
@@ -1325,6 +1412,7 @@ const plugin = {
 		"barrel-direct-siblings-only": barrelDirectSiblingsOnly,
 		"barrel-policy": barrelPolicy,
 		"no-array-isarray-mutation": noArrayIsArrayMutation,
+		"no-control-flow": noControlFlow,
 		"no-enum-number-widening": noEnumNumberWidening,
 		"no-enum-reverse-lookup-widening": noEnumReverseLookupWidening,
 		"no-index-files": noIndexFiles,
@@ -1460,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.12.3",
+  "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"
   },