@duro-app/eslint-config 5.32.0 → 5.33.0

package/README.md

@@ -94,3 +94,36 @@ Flat config is last-wins — scope an override after the preset:
   rules: {'no-restricted-imports': 'off'},
 }
 ```
+
+## adr-lint rules (opt-in)
+
+`adrLint` and `adrLintTyped` add the decided code rules a linter matches
+exactly (no `@ts-ignore`, no unexplained `eslint-disable`, no swallowed
+`catch`; the typed variant also checks `switch` exhaustiveness and needs
+`projectService`). They come from
+[`@aval-adr/eslint-config`](https://www.npmjs.com/package/@aval-adr/eslint-config)
+and are not part of `base`, `react`, `effect` or `tests`.
+
+Put them last and name the presets you use in `stack`: flat config keeps the
+last options of a rule, and adr-lint emits its own `no-restricted-imports`, so
+`stack` re-states the `react` / `effect` import bans inside that one rule.
+`restrictedImports` adds your own bans to it.
+
+```js
+import {react, adrLint} from '@duro-app/eslint-config'
+
+export default [
+  ...react,
+  ...adrLint({
+    stack: ['react'],
+    restrictedImports: [{patterns: [{group: ['**/infra/**']}]}],
+  }),
+]
+```
+
+The stack's bans are also copied into every `files`-scoped entry, because in a
+file two scopes cover only the later one's options apply.
+
+`restrictedImports` without `stack` throws, since a react repository would
+otherwise lose its UI bans in silence: pass `stack: []` when no preset applies.
+An unknown `stack` name throws too.

package/index.d.ts

@@ -5,10 +5,31 @@ export declare const react: Linter.Config[]
 export declare const effect: Linter.Config[]
 export declare const tests: Linter.Config[]
 
+export type AdrLintStack = 'react' | 'effect'
+
+export interface AdrLintRestrictedImport {
+  files?: string[]
+  paths?: (string | {name: string; message?: string; allowTypeImports?: boolean})[]
+  patterns?: (string | {group: string[]; message?: string; allowTypeImports?: boolean})[]
+}
+
+/**
+ * With `restrictedImports`, `stack` is required: it names the presets whose
+ * import bans the merged `no-restricted-imports` must keep (`[]` for none).
+ */
+export type AdrLintOptions =
+  | {stack?: AdrLintStack[]; restrictedImports?: never}
+  | {stack: AdrLintStack[]; restrictedImports: AdrLintRestrictedImport[]}
+
+export declare function adrLint(options?: AdrLintOptions): Linter.Config[]
+export declare function adrLintTyped(options?: AdrLintOptions): Linter.Config[]
+
 declare const presets: {
   base: Linter.Config[]
   react: Linter.Config[]
   effect: Linter.Config[]
   tests: Linter.Config[]
+  adrLint: typeof adrLint
+  adrLintTyped: typeof adrLintTyped
 }
 export default presets

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@duro-app/eslint-config",
-  "version": "5.32.0",
+  "version": "5.33.0",
   "type": "module",
   "license": "MIT",
   "description": "Shareable ESLint flat config for the Duro stack: base TS conventions, the design-system rules and UI-library policy for React apps, Effect server conventions, and accessibility-first test selectors.",
@@ -44,12 +44,13 @@
     "eslint": "^9.0.0 || ^10.0.0"
   },
   "dependencies": {
+    "@aval-adr/eslint-config": "^0.6.0",
     "@effect/eslint-plugin": "^0.3.2",
     "@eslint/js": "^9.20.0 || ^10.0.0",
     "eslint-config-prettier": "^10.1.8",
     "eslint-plugin-react-hooks": "^7.0.1",
     "typescript-eslint": "^8.56.0",
-    "@duro-app/eslint-plugin": "^5.32.0"
+    "@duro-app/eslint-plugin": "^5.33.0"
   },
   "devDependencies": {
     "eslint": "^9.20.0",

package/src/index.js

@@ -4,6 +4,7 @@ import reactHooks from 'eslint-plugin-react-hooks'
 import effectPlugin from '@effect/eslint-plugin'
 import prettier from 'eslint-config-prettier'
 import duro from '@duro-app/eslint-plugin'
+import {adrLint as aval, adrLintTyped as avalTyped} from '@aval-adr/eslint-config'
 
 /**
  * Shareable flat config for the Duro stack. Four presets, each a plain flat
@@ -49,6 +50,33 @@ const FOREIGN_UI_MESSAGE =
 const LEXICAL_MESSAGE =
   'Rich text goes through @fredericrous/lexical-multi at the app layer, never raw Lexical — the wrapper carries the multi-editor state, native support, and edit-state accessibility.'
 
+const FOREIGN_UI_PATTERN = {
+  allowTypeImports: true,
+  group: [
+    'react-aria',
+    'react-aria-components',
+    '@react-aria/*',
+    '@adobe/react-spectrum',
+    '@react-spectrum/*',
+    '@mui/*',
+    '@material-ui/*',
+    '@radix-ui/*',
+    '@chakra-ui/*',
+    '@headlessui/*',
+    'antd',
+    'antd/*',
+    '@frontjutsu/ui',
+    '@frontjutsu/ui/*',
+  ],
+  message: FOREIGN_UI_MESSAGE,
+}
+
+const LEXICAL_PATTERN = {
+  allowTypeImports: true,
+  group: ['lexical', '@lexical/*'],
+  message: LEXICAL_MESSAGE,
+}
+
 export const react = tseslint.config(
   ...base,
   // Classic hooks correctness only. react-hooks v7's flat.recommended also
@@ -78,33 +106,7 @@ export const react = tseslint.config(
       '@typescript-eslint/no-restricted-imports': [
         'error',
         {
-          patterns: [
-            {
-              allowTypeImports: true,
-              group: [
-                'react-aria',
-                'react-aria-components',
-                '@react-aria/*',
-                '@adobe/react-spectrum',
-                '@react-spectrum/*',
-                '@mui/*',
-                '@material-ui/*',
-                '@radix-ui/*',
-                '@chakra-ui/*',
-                '@headlessui/*',
-                'antd',
-                'antd/*',
-                '@frontjutsu/ui',
-                '@frontjutsu/ui/*',
-              ],
-              message: FOREIGN_UI_MESSAGE,
-            },
-            {
-              allowTypeImports: true,
-              group: ['lexical', '@lexical/*'],
-              message: LEXICAL_MESSAGE,
-            },
-          ],
+          patterns: [FOREIGN_UI_PATTERN, LEXICAL_PATTERN],
         },
       ],
     },
@@ -117,6 +119,18 @@ const KYSELY_MESSAGE =
 const OTEL_BARREL_MESSAGE =
   'Import the subpath you need (e.g. @effect/opentelemetry/NodeSdk) — the barrel re-exports WebSdk, which statically imports @opentelemetry/sdk-trace-web and crashes a Node service at module load.'
 
+const OTEL_BARREL_PATH = {
+  allowTypeImports: true,
+  name: '@effect/opentelemetry',
+  message: OTEL_BARREL_MESSAGE,
+}
+
+const KYSELY_PATTERN = {
+  allowTypeImports: true,
+  group: ['kysely', 'kysely-*', '@kysely/*'],
+  message: KYSELY_MESSAGE,
+}
+
 export const effect = tseslint.config(...base, {
   name: 'duro-config/effect-policy',
   plugins: {'@effect': effectPlugin},
@@ -129,20 +143,8 @@ export const effect = tseslint.config(...base, {
     '@typescript-eslint/no-restricted-imports': [
       'error',
       {
-        paths: [
-          {
-            allowTypeImports: true,
-            name: '@effect/opentelemetry',
-            message: OTEL_BARREL_MESSAGE,
-          },
-        ],
-        patterns: [
-          {
-            allowTypeImports: true,
-            group: ['kysely', 'kysely-*', '@kysely/*'],
-            message: KYSELY_MESSAGE,
-          },
-        ],
+        paths: [OTEL_BARREL_PATH],
+        patterns: [KYSELY_PATTERN],
       },
     ],
   },
@@ -184,4 +186,65 @@ export const tests = [
   },
 ]
 
-export default {base, react, effect, tests}
+const STACK_IMPORT_BANS = {
+  react: {patterns: [FOREIGN_UI_PATTERN, LEXICAL_PATTERN]},
+  effect: {paths: [OTEL_BARREL_PATH], patterns: [KYSELY_PATTERN]},
+}
+
+// The preset emits one `no-restricted-imports` per `files` scope, and in a
+// file several scopes cover flat config keeps only the last one's options. So
+// the stack's bans go on every entry: unscoped, and inside each scoped entry
+// too, or a layer contract over `src/**` would drop the UI bans there.
+function adrLintOptions({stack, restrictedImports = []}) {
+  if (stack === undefined && restrictedImports.length > 0) {
+    throw new Error(
+      '@duro-app/eslint-config: adrLint({restrictedImports}) needs `stack` — the presets whose import bans it must keep (["react"], ["effect"], or [] for none); without it a react repo would lose its UI bans',
+    )
+  }
+  const stackBans = (stack ?? []).map((name) => {
+    if (!Object.hasOwn(STACK_IMPORT_BANS, name)) {
+      throw new Error(
+        `@duro-app/eslint-config: unknown stack "${name}" — expected "react" and/or "effect"`,
+      )
+    }
+    return STACK_IMPORT_BANS[name]
+  })
+  const stackPaths = stackBans.flatMap((bans) => bans.paths ?? [])
+  const stackPatterns = stackBans.flatMap((bans) => bans.patterns ?? [])
+  // Once per scope: the preset merges entries that share `files`, and a ban
+  // listed twice there reports one import twice.
+  const scopesGiven = new Set()
+  const scoped = restrictedImports.map((entry) => {
+    if (entry.files === undefined) return entry
+    const scope = JSON.stringify(entry.files)
+    if (scopesGiven.has(scope)) return entry
+    scopesGiven.add(scope)
+    return {
+      ...entry,
+      paths: [...stackPaths, ...(entry.paths ?? [])],
+      patterns: [...stackPatterns, ...(entry.patterns ?? [])],
+    }
+  })
+  return {restrictedImports: [...stackBans, ...scoped]}
+}
+
+/**
+ * Opt-in: the decided code rules a linter matches exactly, from
+ * @aval-adr/eslint-config. Flat config keeps the last options of a rule, so
+ * `stack` re-states the named presets' import bans inside the one merged
+ * `no-restricted-imports` that adr-lint emits.
+ *
+ * @param {import('../index.d.ts').AdrLintOptions} [options]
+ * @returns {import('eslint').Linter.Config[]}
+ */
+export const adrLint = ({stack, restrictedImports} = {}) =>
+  aval(adrLintOptions({stack, restrictedImports}))
+
+/**
+ * @param {import('../index.d.ts').AdrLintOptions} [options]
+ * @returns {import('eslint').Linter.Config[]}
+ */
+export const adrLintTyped = ({stack, restrictedImports} = {}) =>
+  avalTyped(adrLintOptions({stack, restrictedImports}))
+
+export default {base, react, effect, tests, adrLint, adrLintTyped}