@mittwald/flow-react-components 1.6.0-next.0 → 1.6.0-next.10

package/AGENTS.md

@@ -217,16 +217,19 @@ Remote generation details:
   `pnpm nx build:remote-components components` and **commit** the results
   (view.ts, `src/views/*`, `remote-*/src/auto-generated/**`).
 - Props of these components are consumed by mStudio extension developers — no
-  breaking changes; deprecate instead (see
+  breaking changes on a `stable` component; deprecate instead (see
   [Deprecating an API](#deprecating-an-api)). Why this matters:
   [docs/remote-ui.md](https://github.com/mittwald/flow/blob/main/docs/remote-ui.md).
 
 ## Deprecating an API
 
-Never break a shipped API — keep the old path working and warn at runtime with
-`useWarnDeprecation` (from `DeprecationWarningProvider`). This covers every kind
-of deprecated entry point: a prop, a whole component, a hook, or an integration
-export (`nextjs`, `mittwald-password-tools-js`).
+Never break a shipped API of a `stable` component — a `beta` one is exempt (see
+the root
+[Hard rules](https://github.com/mittwald/flow/blob/main/AGENTS.md#hard-rules)).
+Keep the old path working and warn at runtime with `useWarnDeprecation` (from
+`DeprecationWarningProvider`). This covers every kind of deprecated entry point:
+a prop, a whole component, a hook, or an integration export (`nextjs`,
+`mittwald-password-tools-js`).
 
 ```tsx
 const warnDeprecation = useWarnDeprecation();
@@ -330,6 +333,28 @@ if ("action" in props) {
 | `*.test.ts(x)` (unit)                      | Pure logic in `src/lib/` or component utility functions.                                                                                                                                 |
 | `*.test-types.tsx`                         | Generic/typed public APIs — `expectTypeOf` plus `@ts-expect-error` negative assertions.                                                                                                  |
 
+A bug fix gets a regression test when it changes behavior this table covers, or
+rendered output the visual suite covers
+(`packages/remote-react-components/src/tests/visual`, see Definition of Done
+item 4 in the
+[root AGENTS.md](https://github.com/mittwald/flow/blob/main/AGENTS.md#definition-of-done--component-work))
+— not by default. Leave out:
+
+- **Wiring of a single prop** — "the consumer `className` reaches the root",
+  "`aria-label` is forwarded". A test for one prop is arbitrary: every other
+  prop would need the same. A whole class of wiring bugs (`className` merge
+  order, a props spread) belongs in a lint rule or a shared contract helper like
+  `testFormFieldContract`.
+- **A spy on a function prop the component consumes** — `sortBy`, `filterBy`, a
+  formatter. Assert the result it produces, not that it ran. `on*` event props
+  are the exception: the call is what the consumer observes, so a spy is the
+  assertion.
+- **Tests that pass without the fix.** Revert the fix and watch the test fail
+  before committing it. If it cannot fail, it guards nothing; say in the PR how
+  you verified the fix instead. The `optimizeDeps` entry under
+  [Common failures](https://github.com/mittwald/flow/blob/main/AGENTS.md#common-failures)
+  in the root AGENTS.md shows one way a test passes in both directions.
+
 Run: `pnpm nx test:unit components`,
 `pnpm nx test:browser components --browser.name=webkit`. The browser targets
 install the Playwright browsers for you **locally**; `pnpm test:browser:prepare`