@ama-pt/agora-design-system 3.6.0 → 3.6.1

package/README.jest.md

@@ -0,0 +1,42 @@
+# Jest — Local Configuration
+
+The Jest test suite runs 107 test suites and can consume significant memory depending on the machine.
+Use a local `jest.config.local.ts` to tune settings without affecting the shared config.
+
+## Setup
+
+### 1. Create `jest.config.local.ts` at the project root
+
+```ts
+import baseConfig from './jest.config';
+
+export default {
+  ...baseConfig,
+  maxWorkers: 2,
+  workerIdleMemoryLimit: '512MB'
+};
+```
+
+### 2. Run with the local config
+
+```bash
+npm run local-jest-tests
+npm run local-jest-tests-no-coverage
+```
+
+## Recommended values by machine
+
+| RAM   | `maxWorkers` | `workerIdleMemoryLimit` |
+| ----- | ------------ | ----------------------- |
+| 8 GB  | 2            | 512MB                   |
+| 16 GB | 4            | 1024MB                  |
+| 32 GB | 8            | 2048MB                  |
+
+## Notes
+
+- `workerIdleMemoryLimit` causes Jest to recycle a worker process once it exceeds the threshold,
+  preventing memory accumulation across test suites.
+- Reducing `maxWorkers` also reduces the likelihood of flaky tests caused by resource contention
+  (e.g. tests that use `waitFor` with tight timeouts).
+- The `npm run jest-tests` and `npm run jest-tests-no-coverage` scripts in `package.json` are
+  unchanged — these settings are purely local overrides.