exadev-eslint-config 3.0.0 → 3.0.1

package/README.md

@@ -42,6 +42,10 @@ export default defineConfig(
 
 **Remove your own `plugins: { '@stylistic': ... }` registration too.** The default export bundles [`@stylistic/eslint-plugin`](https://eslint.style) (see [Stylistic comment, class-member and JSX rules](#stylistic-comment-class-member-and-jsx-rules)) and registers it under the `@stylistic` namespace itself, so a consumer block registering its own copy of the plugin (a different version resolved from elsewhere in the lockfile, or a duplicated install) makes ESLint throw `Config: Key "plugins": Cannot redefine plugin "@stylistic".` at config load, the identical flat-config restriction as the typescript-eslint case above. Registering the very same instance is harmless, but the robust migration is to drop the registration entirely: configure any further `@stylistic/*` rules directly in your own `rules` block, since this package's block already registers the plugin for every JS/TS and JSX file.
 
+**Your own blocks need no `plugins: { exadev }` and no `files`.** `exadevConfig()` registers the `exadev` plugin for every file it lints, so a block placed after it that sets an `exadev/*` rule written for JavaScript and TypeScript, such as `{ rules: { 'exadev/barrel-policy': ['error', { mode: 'siblings' }] } }`, loads even though it also applies to `tsconfig.json`, other JSON files and Markdown, and a rule that inspects JavaScript or TypeScript syntax leaves those files alone. The JSON and Markdown rules (`package-json-key-order`, `markdown-required-heading`, the [workspace architecture](#workspace-architecture) and [Turbo](#turbo) rules) are the exception: ESLint refuses to enable a rule for a language it does not declare, so a block that sets one needs the `files` of the kind of file it reads, which its preset already supplies.
+
+**Rules from other plugins are different.** `@typescript-eslint/*`, `@stylistic/*`, `jsdoc/*`, `unicorn/*` and the rest are registered only for JavaScript and TypeScript files, so a block of your own that sets one needs `files: ['**/*.{ts,tsx,mts,cts,js,jsx,mjs,cjs}']`; without it ESLint fails at config load with `could not find plugin` as soon as the block also applies to a JSON or Markdown file.
+
 ### What the default export includes
 
 **typescript-eslint presets:**
@@ -1747,6 +1751,7 @@ pnpm build
   - `tryResolveJsonPlugin` and `requireJsonPlugin` are the silent and the throwing resolution paths, the second naming the feature that needs the peer and the install command.
   - `buildJsonLanguageBlock` assembles the `exadev` and `json` plugin registration for a `files` list under `json/json` or `json/jsonc`; the `json/jsonc` form also admits trailing commas, matching the JSONC config in [`src/json-canonical.ts`](src/json-canonical.ts). `JSONC_FILE_GLOBS` (`tsconfig*.json`, `turbo.json`, `*.jsonc`) lists the files that carry comments, so a rule targeting them must be wired under `json/jsonc`, and a rule meant for both languages declares both in `meta.languages`.
   - `buildPackageJsonKeyOrderConfig` and `buildWorkspaceArchitectureConfig` are built on it; a new JSON rule family follows the same shape, taking its tri-state `enabled` option from `exadevConfig` and choosing `requireJsonPlugin` (forced on) or `tryResolveJsonPlugin` (auto-detected).
+- [`src/rules/estree-source.ts`](src/rules/estree-source.ts) holds `isEstreeSource`, the first check of every rule that reads JavaScript or TypeScript syntax (scope analysis, parser services, JSX): such a rule returns no listeners for a JSON, JSONC or Markdown file, which an unscoped block of a consumer's own can hand it. A rule that reads only the filename needs no such check.
 - [`src/rules/file-scope.ts`](src/rules/file-scope.ts) lets a rule scope itself by filename, so it still behaves when a consumer wires it onto a wider `files` list.
   - `createFileScope(globs)` returns a `(filename, cwd) => boolean` matching the file relative to `cwd` with minimatch (a leading `!` excludes, wildcards never matching dot-prefixed names). A file outside `cwd` (its relative path starts with `..`) is never in scope, whatever the patterns. Build it once per `create()`.
   - `fileGlobsSchema` and `readFileGlobs` are the option schema and runtime validator for a glob list; a list needs at least one include, may not repeat a glob, and every glob must compile in minimatch.
@@ -1769,7 +1774,7 @@ pnpm build
 - [`src/rules/run-tracker.ts`](src/rules/run-tracker.ts) decides which lint carries a finding that belongs to a set of files rather than to one, so `require-compiler-options` reports once per run; it reads run boundaries from the order of the lints, as [Compiler options](#compiler-options) describes.
 - [`src/rules/tsconfig-attribution.ts`](src/rules/tsconfig-attribution.ts) works out which tsconfig governs a linted file, attributing a program with no tsconfig to the one the file was last linted under while that tsconfig still lists it.
 - [`src/create-config.ts`](src/create-config.ts) is config assembly's single source of truth.
-  - `exadevConfig(options)` concatenates, in order: `buildGitignoreConfig`, `recommendedTypeChecked`, `jsdocAndTsdoc`, `jsonCanonicalConfig`, `stylisticCommentsConfig`, `buildReactConfig`, `buildNextjsConfig`, `buildPackageJsonKeyOrderConfig` (each tri-state builder fed its matching option), `buildWorkspaceArchitectureConfig` (only when `workspaceArchitecture` is given; there is no auto-detected default), `buildTurboConfig` (only when `turbo` is given, likewise), `buildImportPolicyConfig` (only when `importPolicies` is given, likewise), `buildPureModulesConfig` (only when `pureModules` is given, likewise), `buildTestHygieneConfig` (only when `testHygiene` is given, likewise), `buildMarkdownHeadingsConfig` (only when `markdownHeadings` is given, likewise), `buildAgentSkillsConfig` (tri-state, placed after the headings block so that a SKILL.md stays YAML whatever format `markdownHeadings` sets), and `buildToolingWiringConfig` (only when `toolingWiring` is given, likewise).
+  - `exadevConfig(options)` concatenates, in order: `buildGitignoreConfig`, a block that registers the `exadev` plugin with no `files`, `ignores` or `rules` (so a consumer's unscoped `exadev/*` rule resolves in every language the later blocks lint), `recommendedTypeChecked`, `jsdocAndTsdoc`, `jsonCanonicalConfig`, `stylisticCommentsConfig`, `buildReactConfig`, `buildNextjsConfig`, `buildPackageJsonKeyOrderConfig` (each tri-state builder fed its matching option), `buildWorkspaceArchitectureConfig` (only when `workspaceArchitecture` is given; there is no auto-detected default), `buildTurboConfig` (only when `turbo` is given, likewise), `buildImportPolicyConfig` (only when `importPolicies` is given, likewise), `buildPureModulesConfig` (only when `pureModules` is given, likewise), `buildTestHygieneConfig` (only when `testHygiene` is given, likewise), `buildMarkdownHeadingsConfig` (only when `markdownHeadings` is given, likewise), `buildAgentSkillsConfig` (tri-state, placed after the headings block so that a SKILL.md stays YAML whatever format `markdownHeadings` sets), and `buildToolingWiringConfig` (only when `toolingWiring` is given, likewise).
   - `defaultConfig` is `exadevConfig()` evaluated once, eagerly, at module load.
 - [`src/robustness-rules.ts`](src/robustness-rules.ts) holds `UNTYPED_ROBUSTNESS_RULES`, the core ESLint rules that need no type information, spread into both `plugin.configs.recommended` and the type-checked block so the two cannot drift apart.
 - [`src/stylistic-comments.ts`](src/stylistic-comments.ts) builds `stylisticCommentsConfig`: the hand-picked `@stylistic/eslint-plugin` rules plus this package's own `exadev/multiline-comment-style` and `exadev/prefer-doc-comment`, in two blocks (one scoped to every JS/TS file, one scoped to JSX files only for the three JSX-specific rules). See [Stylistic comment, class-member and JSX rules](#stylistic-comment-class-member-and-jsx-rules).

package/dist/index.cjs

@@ -485,7 +485,7 @@ function buildOptionalPluginConfig(preset, options = {}) {
 }
 //#endregion
 //#region package.json
-var version = "3.0.0";
+var version = "3.0.1";
 //#endregion
 //#region src/react.ts
 /**
@@ -4086,6 +4086,14 @@ function asIdentifierName(name) {
 	return name;
 }
 //#endregion
+//#region src/rules/estree-source.ts
+/**
+* Whether the file under lint was parsed to an ESTree `Program`, the tree every rule that reads JavaScript or TypeScript syntax is written against. A rule that is wired onto a block with no `files` (the documented unscoped override placed after the shared config) is also handed the JSON, JSONC and Markdown files the shared config lints, whose source code objects have a different root and no scope manager or parser services; such a rule starts with `if (!isEstreeSource(context.sourceCode)) return {};` after reading its options, so a file of another language is left alone instead of crashing the run.
+*/
+function isEstreeSource(sourceCode) {
+	return sourceCode.ast.type === "Program";
+}
+//#endregion
 //#region src/rules/no-array-isarray-mutation.ts
 const MUTATING_INSERT_METHODS$1 = /* @__PURE__ */ new Set([
 	"push",
@@ -4116,6 +4124,7 @@ const noArrayIsArrayMutation = createRule$18({
 	},
 	defaultOptions: [],
 	create(context) {
+		if (!isEstreeSource(context.sourceCode)) return {};
 		const services = _typescript_eslint_utils.ESLintUtils.getParserServices(context);
 		const checker = services.program.getTypeChecker();
 		function declarationHasReadonlyArrayConstituent(declarationNode) {
@@ -4810,6 +4819,7 @@ const noEnumNumberWidening = _typescript_eslint_utils.ESLintUtils.RuleCreator((n
 		defaultOptions: []
 	},
 	create(context) {
+		if (!isEstreeSource(context.sourceCode)) return {};
 		const services = _typescript_eslint_utils.ESLintUtils.getParserServices(context);
 		const checker = services.program.getTypeChecker();
 		function checkNode(expression) {
@@ -4858,6 +4868,7 @@ const noEnumReverseLookupWidening = _typescript_eslint_utils.ESLintUtils.RuleCre
 		defaultOptions: []
 	},
 	create(context) {
+		if (!isEstreeSource(context.sourceCode)) return {};
 		const services = _typescript_eslint_utils.ESLintUtils.getParserServices(context);
 		const checker = services.program.getTypeChecker();
 		return { MemberExpression(node) {
@@ -4981,7 +4992,7 @@ const noExternalMemberJsxTag = _typescript_eslint_utils.ESLintUtils.RuleCreator(
 	create(context, [options]) {
 		const { allowSource, allowTags } = readNoExternalMemberJsxTagOptions(options);
 		const { sourceCode } = context;
-		if (hasUseClientDirective(sourceCode.ast)) return {};
+		if (!isEstreeSource(sourceCode) || hasUseClientDirective(sourceCode.ast)) return {};
 		return { JSXOpeningElement(node) {
 			if (node.name.type !== _typescript_eslint_utils.AST_NODE_TYPES.JSXMemberExpression) return;
 			const tag = sourceCode.getText(node.name);
@@ -5605,6 +5616,7 @@ const noMapInstanceofMutation = createRule$16({
 	},
 	defaultOptions: [],
 	create(context) {
+		if (!isEstreeSource(context.sourceCode)) return {};
 		const services = _typescript_eslint_utils.ESLintUtils.getParserServices(context);
 		const checker = services.program.getTypeChecker();
 		function declarationHasReadonlyMapConstituent(declarationNode) {
@@ -6107,7 +6119,7 @@ const noNonSerialisableServerProp = createRule$14({
 	create(context, [options]) {
 		const { names, allowElements } = readNoNonSerialisableServerPropOptions(options);
 		const { sourceCode } = context;
-		if (hasUseClientDirective(sourceCode.ast)) return {};
+		if (!isEstreeSource(sourceCode) || hasUseClientDirective(sourceCode.ast)) return {};
 		return { JSXAttribute(node) {
 			if (node.name.type !== _typescript_eslint_utils.AST_NODE_TYPES.JSXIdentifier || !names.has(node.name.name)) return;
 			if (node.value?.type !== _typescript_eslint_utils.AST_NODE_TYPES.JSXExpressionContainer || node.value.expression.type === _typescript_eslint_utils.AST_NODE_TYPES.JSXEmptyExpression) return;
@@ -6484,6 +6496,7 @@ const noPointlessReassignment = {
 		messages: { pointlessReassignment: "Pointless reassignment: '{{ name }}' is just an alias for '{{ value }}'. Use the original directly." }
 	},
 	create(context) {
+		if (!isEstreeSource(context.sourceCode)) return {};
 		const moduleScope = findTopLevelScope(context.sourceCode.getScope(context.sourceCode.ast));
 		return { VariableDeclarator(node) {
 			if (node.id.type !== "Identifier" || node.init?.type !== "Identifier" || node.id.name.startsWith("_")) return;
@@ -6550,6 +6563,7 @@ const noSetInstanceofMutation = createRule$11({
 	},
 	defaultOptions: [],
 	create(context) {
+		if (!isEstreeSource(context.sourceCode)) return {};
 		const services = _typescript_eslint_utils.ESLintUtils.getParserServices(context);
 		const checker = services.program.getTypeChecker();
 		function declarationHasReadonlySetConstituent(declarationNode) {
@@ -7500,6 +7514,7 @@ const preferNumericSortCompare = createRule$10({
 		defaultOptions: []
 	},
 	create(context) {
+		if (!isEstreeSource(context.sourceCode)) return {};
 		const services = _typescript_eslint_utils.ESLintUtils.getParserServices(context);
 		const checker = services.program.getTypeChecker();
 		return { CallExpression(node) {
@@ -7655,6 +7670,7 @@ const preferReadonlyObjectParam = createRule$8({
 		defaultOptions: []
 	},
 	create(context) {
+		if (!isEstreeSource(context.sourceCode)) return {};
 		const services = _typescript_eslint_utils.ESLintUtils.getParserServices(context);
 		const checker = services.program.getTypeChecker();
 		function checkParam(param) {
@@ -8566,6 +8582,7 @@ const requireCompilerOptions = createRule$5({
 	create(context, [options]) {
 		const requirements = readCompilerOptionRequirements(options);
 		if (requirements.length === 0) return {};
+		if (!isEstreeSource(context.sourceCode)) return {};
 		const { program } = _typescript_eslint_utils.ESLintUtils.getParserServices(context);
 		const signature = JSON.stringify(requirements.map((requirement) => [requirement.name, requirement.spelled]));
 		return { Program(node) {
@@ -9023,6 +9040,7 @@ const scopedFirstParameter = _typescript_eslint_utils.ESLintUtils.RuleCreator((n
 	create(context, [options]) {
 		const { interfaces, name: requiredName, type: requiredType } = readScopedFirstParameterOptions(options);
 		const { sourceCode } = context;
+		if (!isEstreeSource(context.sourceCode)) return {};
 		const services = _typescript_eslint_utils.ESLintUtils.getParserServices(context);
 		const checker = services.program.getTypeChecker();
 		const checkMembers = (owner, members) => {
@@ -12182,6 +12200,7 @@ function exadevConfig(options = {}) {
 	const gitignore = buildGitignoreConfig({ enabled: options.gitignore });
 	return toPublicConfigArray([
 		...gitignore,
+		{ plugins: { exadev: plugin } },
 		...recommendedTypeChecked,
 		...jsdocAndTsdoc,
 		...jsonCanonicalConfig,

package/dist/index.js

@@ -450,7 +450,7 @@ function buildOptionalPluginConfig(preset, options = {}) {
 }
 //#endregion
 //#region package.json
-var version = "3.0.0";
+var version = "3.0.1";
 //#endregion
 //#region src/react.ts
 /**
@@ -4051,6 +4051,14 @@ function asIdentifierName(name) {
 	return name;
 }
 //#endregion
+//#region src/rules/estree-source.ts
+/**
+* Whether the file under lint was parsed to an ESTree `Program`, the tree every rule that reads JavaScript or TypeScript syntax is written against. A rule that is wired onto a block with no `files` (the documented unscoped override placed after the shared config) is also handed the JSON, JSONC and Markdown files the shared config lints, whose source code objects have a different root and no scope manager or parser services; such a rule starts with `if (!isEstreeSource(context.sourceCode)) return {};` after reading its options, so a file of another language is left alone instead of crashing the run.
+*/
+function isEstreeSource(sourceCode) {
+	return sourceCode.ast.type === "Program";
+}
+//#endregion
 //#region src/rules/no-array-isarray-mutation.ts
 const MUTATING_INSERT_METHODS$1 = /* @__PURE__ */ new Set([
 	"push",
@@ -4081,6 +4089,7 @@ const noArrayIsArrayMutation = createRule$18({
 	},
 	defaultOptions: [],
 	create(context) {
+		if (!isEstreeSource(context.sourceCode)) return {};
 		const services = ESLintUtils.getParserServices(context);
 		const checker = services.program.getTypeChecker();
 		function declarationHasReadonlyArrayConstituent(declarationNode) {
@@ -4775,6 +4784,7 @@ const noEnumNumberWidening = ESLintUtils.RuleCreator((name) => `https://github.c
 		defaultOptions: []
 	},
 	create(context) {
+		if (!isEstreeSource(context.sourceCode)) return {};
 		const services = ESLintUtils.getParserServices(context);
 		const checker = services.program.getTypeChecker();
 		function checkNode(expression) {
@@ -4823,6 +4833,7 @@ const noEnumReverseLookupWidening = ESLintUtils.RuleCreator((name) => `https://g
 		defaultOptions: []
 	},
 	create(context) {
+		if (!isEstreeSource(context.sourceCode)) return {};
 		const services = ESLintUtils.getParserServices(context);
 		const checker = services.program.getTypeChecker();
 		return { MemberExpression(node) {
@@ -4946,7 +4957,7 @@ const noExternalMemberJsxTag = ESLintUtils.RuleCreator((name) => `https://github
 	create(context, [options]) {
 		const { allowSource, allowTags } = readNoExternalMemberJsxTagOptions(options);
 		const { sourceCode } = context;
-		if (hasUseClientDirective(sourceCode.ast)) return {};
+		if (!isEstreeSource(sourceCode) || hasUseClientDirective(sourceCode.ast)) return {};
 		return { JSXOpeningElement(node) {
 			if (node.name.type !== AST_NODE_TYPES.JSXMemberExpression) return;
 			const tag = sourceCode.getText(node.name);
@@ -5570,6 +5581,7 @@ const noMapInstanceofMutation = createRule$16({
 	},
 	defaultOptions: [],
 	create(context) {
+		if (!isEstreeSource(context.sourceCode)) return {};
 		const services = ESLintUtils.getParserServices(context);
 		const checker = services.program.getTypeChecker();
 		function declarationHasReadonlyMapConstituent(declarationNode) {
@@ -6072,7 +6084,7 @@ const noNonSerialisableServerProp = createRule$14({
 	create(context, [options]) {
 		const { names, allowElements } = readNoNonSerialisableServerPropOptions(options);
 		const { sourceCode } = context;
-		if (hasUseClientDirective(sourceCode.ast)) return {};
+		if (!isEstreeSource(sourceCode) || hasUseClientDirective(sourceCode.ast)) return {};
 		return { JSXAttribute(node) {
 			if (node.name.type !== AST_NODE_TYPES.JSXIdentifier || !names.has(node.name.name)) return;
 			if (node.value?.type !== AST_NODE_TYPES.JSXExpressionContainer || node.value.expression.type === AST_NODE_TYPES.JSXEmptyExpression) return;
@@ -6449,6 +6461,7 @@ const noPointlessReassignment = {
 		messages: { pointlessReassignment: "Pointless reassignment: '{{ name }}' is just an alias for '{{ value }}'. Use the original directly." }
 	},
 	create(context) {
+		if (!isEstreeSource(context.sourceCode)) return {};
 		const moduleScope = findTopLevelScope(context.sourceCode.getScope(context.sourceCode.ast));
 		return { VariableDeclarator(node) {
 			if (node.id.type !== "Identifier" || node.init?.type !== "Identifier" || node.id.name.startsWith("_")) return;
@@ -6515,6 +6528,7 @@ const noSetInstanceofMutation = createRule$11({
 	},
 	defaultOptions: [],
 	create(context) {
+		if (!isEstreeSource(context.sourceCode)) return {};
 		const services = ESLintUtils.getParserServices(context);
 		const checker = services.program.getTypeChecker();
 		function declarationHasReadonlySetConstituent(declarationNode) {
@@ -7465,6 +7479,7 @@ const preferNumericSortCompare = createRule$10({
 		defaultOptions: []
 	},
 	create(context) {
+		if (!isEstreeSource(context.sourceCode)) return {};
 		const services = ESLintUtils.getParserServices(context);
 		const checker = services.program.getTypeChecker();
 		return { CallExpression(node) {
@@ -7620,6 +7635,7 @@ const preferReadonlyObjectParam = createRule$8({
 		defaultOptions: []
 	},
 	create(context) {
+		if (!isEstreeSource(context.sourceCode)) return {};
 		const services = ESLintUtils.getParserServices(context);
 		const checker = services.program.getTypeChecker();
 		function checkParam(param) {
@@ -8531,6 +8547,7 @@ const requireCompilerOptions = createRule$5({
 	create(context, [options]) {
 		const requirements = readCompilerOptionRequirements(options);
 		if (requirements.length === 0) return {};
+		if (!isEstreeSource(context.sourceCode)) return {};
 		const { program } = ESLintUtils.getParserServices(context);
 		const signature = JSON.stringify(requirements.map((requirement) => [requirement.name, requirement.spelled]));
 		return { Program(node) {
@@ -8988,6 +9005,7 @@ const scopedFirstParameter = ESLintUtils.RuleCreator((name) => `https://github.c
 	create(context, [options]) {
 		const { interfaces, name: requiredName, type: requiredType } = readScopedFirstParameterOptions(options);
 		const { sourceCode } = context;
+		if (!isEstreeSource(context.sourceCode)) return {};
 		const services = ESLintUtils.getParserServices(context);
 		const checker = services.program.getTypeChecker();
 		const checkMembers = (owner, members) => {
@@ -12147,6 +12165,7 @@ function exadevConfig(options = {}) {
 	const gitignore = buildGitignoreConfig({ enabled: options.gitignore });
 	return toPublicConfigArray([
 		...gitignore,
+		{ plugins: { exadev: plugin } },
 		...recommendedTypeChecked,
 		...jsdocAndTsdoc,
 		...jsonCanonicalConfig,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "exadev-eslint-config",
   "description": "Shared custom ESLint rules and plugin for ExaDev projects",
-  "version": "3.0.0",
+  "version": "3.0.1",
   "dependencies": {
     "@eslint/js": "^10.0.1",
     "@microsoft/tsdoc": "0.17.1",