Skip to content

Commit b456754

Browse files
no-mistakes(document): trim duplicated exemption rationale from AGENTS.md type-surface section
1 parent 714cb1c commit b456754

1 file changed

Lines changed: 6 additions & 13 deletions

File tree

‎AGENTS.md‎

Lines changed: 6 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -91,19 +91,12 @@ that one is broken by a _runtime_ import, this one by a _type_ re-export.
9191
[`src/__testing__/publishedTypeSurfaceDependencies.test.ts`](src/__testing__/publishedTypeSurfaceDependencies.test.ts)
9292
is the guard. It reads the built `dist/index.d.ts` (CI's `node-checks.yml` runs `make build` before
9393
`make tests`, so it is present; a local `jest` with no build skips, and skipping is itself a failure
94-
when `CI` is set). It also owns the exemption list: `@reduxjs/toolkit` and `redux` still leak from
95-
`src/actors/*` and `src/redux-persist/*`, and today resolve for consumers only because
96-
`@meshery/schemas` declares `@reduxjs/toolkit` and `react-redux` as required peers - transitive luck,
97-
not a contract. Neither a plain dependency nor a required peer is right for them (see the rationale
98-
in that file); the remedy is a separate opt-in entry point for the redux-facing surface.
99-
100-
It owns a second, separate list for the optional-peer case, which needs a different remedy: the
101-
package _is_ declared, just optional. `@mui/x-date-pickers` is on it because the barrel does
102-
`export { DateTimePickerProps } from '@mui/x-date-pickers/DateTimePicker'`, so a consumer who skips
103-
that optional peer silently gets `any` for the props type. Exempted on the record; the fix is to
104-
stop re-exporting it, tracked in [#1749](https://github.com/layer5io/sistent/issues/1749). `react`
105-
is on it too, for the same reason it is exempted in the runtime guard - it is optional in name only
106-
for a React component library.
94+
when `CI` is set). It is also the source of truth for the two exemption lists and the per-package
95+
rationale behind each: packages that leak _undeclared_ (today the redux-facing surface reached
96+
through `src/actors/*` and `src/redux-persist/*`, whose remedy is its own opt-in entry point, not a
97+
dependency), and packages that _are_ declared but only as optional peers, whose remedy is to stop
98+
naming them in the public type surface. Every entry is asserted to still be needed, so it cannot
99+
outlive its problem - read that file, not a copy here, before touching either list.
107100

108101
## Permission keys are owned by `meshery/schemas`, not by sistent
109102

0 commit comments

Comments
 (0)