@cratis/eslint-config 7.18.2 → 7.18.4

package/README.md

@@ -17,7 +17,25 @@ The license header is a Cratis *authoring* concern, so it lives only in `interna
 yarn add -D @cratis/eslint-config eslint
 ```
 
-`eslint` is a peer dependency; everything else (typescript-eslint, eslint-plugin-react, …) ships transitively.
+`eslint` and the TypeScript programmatic API are peer dependencies. The parser, TypeScript rules, and other plugins used by these presets ship transitively.
+
+### TypeScript 7
+
+TypeScript 7.0 supplies the native `tsc` compiler but not the JavaScript compiler API required by typescript-eslint. Use [TypeScript's supported side-by-side setup](https://devblogs.microsoft.com/typescript/announcing-typescript-7-0/#running-side-by-side-with-typescript-6.0):
+
+```sh
+npm install -D @cratis/eslint-config eslint@latest \
+  '@typescript/native@npm:typescript@latest' \
+  'typescript@npm:@typescript/typescript6@latest'
+```
+
+The build still runs TypeScript 7's `tsc`; the separate compatibility package supplies the API used by lint tools and names its older compiler executable `tsc6`.
+
+### React rules
+
+JSX syntax and references are handled by the TypeScript parser and rules. These presets do not enable any `react/*` rules, and no longer install or register `eslint-plugin-react` implicitly. This avoids its incompatible ESLint 10 peer dependency.
+
+If a custom configuration enables additional React-specific rules, register a compatible plugin explicitly in that configuration. The legacy `react/display-name` and `react/react-in-jsx-scope` entries remain disabled, and `settings.react.version` remains `detect`, so consumers that supply their own React plugin keep those defaults.
 
 ## Use — a project built on Cratis
 
@@ -58,3 +76,13 @@ export default cratis.configs.internal;
 ## Building blocks
 
 `configs.base` (hygiene + ignores) and `configs.specs` (`for_*` relaxations) are exported too, so you can compose your own preset. Named exports `base`, `specs`, `consumer`, `internal`, and `ignores` are also available.
+
+## Verify the published peer graph
+
+From the repository root, run:
+
+```sh
+node Source/ESLintConfig/scripts/verify-peer-graph.mjs
+```
+
+The check packs this workspace and installs the tarball into an isolated consumer under `.ai-work/`, using the latest ESLint and TypeScript/compiler-API packages. It requires strict peer resolution and a clean complete dependency tree, then verifies the packed presets against JSX and representative consumer/internal rules. CI runs this in addition to the preset specs; workspace hoisting must not hide a broken published dependency graph.

package/base.js

@@ -1,7 +1,9 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
 import tseslintPlugin from '@typescript-eslint/eslint-plugin';
 import tsParser from '@typescript-eslint/parser';
 import noNull from 'eslint-plugin-no-null';
-import react from 'eslint-plugin-react';
 import globals from 'globals';
 import { coreRules } from './lib/coreRules.js';
 
@@ -31,7 +33,6 @@ const base = [
         files: ['**/*.ts', '**/*.tsx'],
         plugins: {
             '@typescript-eslint': tseslintPlugin,
-            react,
             'no-null': noNull,
         },
         languageOptions: {
@@ -39,6 +40,7 @@ const base = [
             parser: tsParser,
             sourceType: 'module',
         },
+        // Preserve version detection for consumers that explicitly provide a React plugin.
         settings: {
             react: { version: 'detect' },
         },

package/lib/coreRules.js

@@ -1,3 +1,6 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
 import eslintJs from '@eslint/js';
 import tseslint from 'typescript-eslint';
 
@@ -19,6 +22,7 @@ export const coreRules = {
 
     'no-irregular-whitespace': 0,
     semi: [2, 'always'],
+    // Keep these disabled for consumers that register their own React plugin; no React plugin is required here.
     'react/display-name': 0,
     'react/react-in-jsx-scope': 0,
     'no-prototype-builtins': 0,

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@cratis/eslint-config",
-    "version": "7.18.2",
+    "version": "7.18.4",
     "description": "Shared Cratis ESLint flat-config presets. `consumer` is for projects that build on Cratis; `internal` adds the Cratis-authoring rules (MIT license header) used inside the Cratis product repos.",
     "author": "Cratis",
     "license": "MIT",
@@ -41,12 +41,15 @@
         "@typescript-eslint/eslint-plugin": "^8.67.0",
         "@typescript-eslint/parser": "^8.67.0",
         "eslint-plugin-no-null": "^1.0.2",
-        "eslint-plugin-react": "^7.37.5",
         "globals": "^17.11.0",
         "typescript-eslint": "^8.67.0"
     },
     "peerDependencies": {
         "eslint": ">=9",
         "typescript": ">=4.8.4"
+    },
+    "devDependencies": {
+        "eslint": "^10.10.0",
+        "typescript": "npm:@typescript/typescript6@^6.0.2"
     }
 }