mirror of
https://github.com/github/awesome-copilot.git
synced 2026-04-13 19:55:56 +00:00
chore: publish from staged
This commit is contained in:
github-actions[bot]
@@ -0,0 +1,102 @@
|
||||
---
|
||||
name: react18-dep-compatibility
|
||||
description: 'React 18.3.1 and React 19 dependency compatibility matrix.'
|
||||
---
|
||||
|
||||
# React Dependency Compatibility Matrix
|
||||
|
||||
Minimum versions required for React 18.3.1 and React 19 compatibility.
|
||||
|
||||
Use this skill whenever checking whether a dependency supports a target React version, resolving peer dependency conflicts, deciding whether to upgrade or use `legacy-peer-deps`, or assessing the risk of a `react-router` v5 to v6 migration.
|
||||
|
||||
Review this matrix before running `npm install` during a React upgrade and before accepting an npm dependency conflict resolution, especially where concurrent mode compatibility may be affected.
|
||||
## Core Upgrade Targets
|
||||
|
||||
| Package | React 17 (current) | React 18.3.1 (min) | React 19 (min) | Notes |
|
||||
|---|---|---|---|---|
|
||||
| `react` | 17.x | **18.3.1** | **19.0.0** | Pin exactly to 18.3.1 for the R18 orchestra |
|
||||
| `react-dom` | 17.x | **18.3.1** | **19.0.0** | Must match react version exactly |
|
||||
|
||||
## Testing Libraries
|
||||
|
||||
| Package | React 18 Min | React 19 Min | Notes |
|
||||
|---|---|---|---|
|
||||
| `@testing-library/react` | **14.0.0** | **16.0.0** | RTL 13 uses ReactDOM.render internally - broken in R18 |
|
||||
| `@testing-library/jest-dom` | **6.0.0** | **6.0.0** | v5 works but v6 has React 18 matcher updates |
|
||||
| `@testing-library/user-event` | **14.0.0** | **14.0.0** | v13 is sync, v14 is async - API change required |
|
||||
| `jest` | **27.x** | **27.x** | jest 27+ with jsdom 16+ for React 18 |
|
||||
| `jest-environment-jsdom` | **27.x** | **27.x** | Must match jest version |
|
||||
|
||||
## Apollo Client
|
||||
|
||||
| Package | React 18 Min | React 19 Min | Notes |
|
||||
|---|---|---|---|
|
||||
| `@apollo/client` | **3.8.0** | **3.11.0** | 3.8 adds `useSyncExternalStore` for concurrent mode |
|
||||
| `graphql` | **15.x** | **16.x** | Apollo 3.8+ peer requires graphql 15 or 16 |
|
||||
|
||||
Read **`references/apollo-details.md`** for concurrent mode issues and MockedProvider changes.
|
||||
|
||||
## Emotion
|
||||
|
||||
| Package | React 18 Min | React 19 Min | Notes |
|
||||
|---|---|---|---|
|
||||
| `@emotion/react` | **11.10.0** | **11.13.0** | 11.10 adds React 18 concurrent mode support |
|
||||
| `@emotion/styled` | **11.10.0** | **11.13.0** | Must match @emotion/react version |
|
||||
| `@emotion/cache` | **11.10.0** | **11.13.0** | If used directly |
|
||||
|
||||
## React Router
|
||||
|
||||
| Package | React 18 Min | React 19 Min | Notes |
|
||||
|---|---|---|---|
|
||||
| `react-router-dom` | **v6.0.0** | **v6.8.0** | v5 → v6 is a breaking migration - see details below |
|
||||
| `react-router-dom` v5 | 5.3.4 (workaround) | ❌ Not supported | See legacy peer deps note |
|
||||
|
||||
**react-router v5 → v6 is a SEPARATE migration sprint.** Read `references/router-migration.md`.
|
||||
|
||||
## Redux
|
||||
|
||||
| Package | React 18 Min | React 19 Min | Notes |
|
||||
|---|---|---|---|
|
||||
| `react-redux` | **8.0.0** | **9.0.0** | v7 works on R18 legacy root only - breaks on concurrent mode |
|
||||
| `redux` | **4.x** | **5.x** | Redux itself is framework-agnostic - react-redux version matters |
|
||||
| `@reduxjs/toolkit` | **1.9.0** | **2.0.0** | RTK 1.9 tested against React 18 |
|
||||
|
||||
## Other Common Packages
|
||||
|
||||
| Package | React 18 Min | React 19 Min | Notes |
|
||||
|---|---|---|---|
|
||||
| `react-query` / `@tanstack/react-query` | **4.0.0** | **5.0.0** | v3 doesn't support concurrent mode |
|
||||
| `react-hook-form` | **7.0.0** | **7.43.0** | v6 has concurrent mode issues |
|
||||
| `formik` | **2.2.9** | **2.4.0** | v2.2.9 patched for React 18 |
|
||||
| `react-select` | **5.0.0** | **5.8.0** | v4 has peer dep conflicts with R18 |
|
||||
| `react-datepicker` | **4.8.0** | **6.0.0** | v4.8+ added React 18 support |
|
||||
| `react-dnd` | **16.0.0** | **16.0.0** | v15 and below have R18 concurrent mode issues |
|
||||
| `prop-types` | any | any | Standalone - unaffected by React version |
|
||||
|
||||
---
|
||||
|
||||
## Conflict Resolution Decision Tree
|
||||
|
||||
```
|
||||
npm ls shows peer conflict for package X
|
||||
│
|
||||
▼
|
||||
Does package X have a version that supports React 18?
|
||||
YES → npm install X@[min-compatible-version]
|
||||
NO ↓
|
||||
│
|
||||
Is the package critical to the app?
|
||||
YES → check GitHub issues for React 18 branch/fork
|
||||
→ check if maintainer has a PR open
|
||||
→ last resort: --legacy-peer-deps (document why)
|
||||
NO → consider removing the package
|
||||
```
|
||||
|
||||
## --legacy-peer-deps Rules
|
||||
|
||||
Only use `--legacy-peer-deps` when:
|
||||
- The package has no React 18 compatible release
|
||||
- The package is actively maintained (not abandoned)
|
||||
- The conflict is only a peer dep declaration mismatch (not actual API incompatibility)
|
||||
|
||||
**Document every `--legacy-peer-deps` usage** in a comment at the top of package.json or in a MIGRATION.md file explaining why it was necessary.
|
||||
@@ -0,0 +1,68 @@
|
||||
# Apollo Client - React 18 Compatibility Details
|
||||
|
||||
## Why Apollo 3.8+ is Required
|
||||
|
||||
Apollo Client 3.7 and below use an internal subscription model that is not compatible with React 18's concurrent rendering. In concurrent mode, React can interrupt and replay renders, which causes Apollo's store subscriptions to fire at incorrect times - producing stale data or missed updates.
|
||||
|
||||
Apollo 3.8 was the first version to adopt `useSyncExternalStore`, which React 18 requires for external stores to work correctly under concurrent rendering.
|
||||
|
||||
## Version Summary
|
||||
|
||||
| Apollo Version | React 18 Support | React 19 Support | Notes |
|
||||
|---|---|---|---|
|
||||
| < 3.7 | ❌ | ❌ | Concurrent mode data tearing |
|
||||
| 3.7.x | ⚠️ | ⚠️ | Works with legacy root only (ReactDOM.render) |
|
||||
| **3.8.x** | ✅ | ✅ | First fully compatible version |
|
||||
| 3.9+ | ✅ | ✅ | Recommended |
|
||||
| 3.11+ | ✅ | ✅ (confirmed) | Explicit React 19 testing added |
|
||||
|
||||
## If You're on Apollo 3.7 Using Legacy Root
|
||||
|
||||
If the app still uses `ReactDOM.render` (legacy root) and hasn't migrated to `createRoot` yet, Apollo 3.7 will technically work - but this means you're not getting any React 18 concurrent features (including automatic batching). This is a partial upgrade only.
|
||||
|
||||
As soon as `createRoot` is used, upgrade Apollo to 3.8+.
|
||||
|
||||
## MockedProvider in Tests - React 18
|
||||
|
||||
Apollo's `MockedProvider` works with React 18 but async behavior changed:
|
||||
|
||||
```jsx
|
||||
// Old pattern - flushing with setTimeout:
|
||||
await new Promise(resolve => setTimeout(resolve, 0));
|
||||
wrapper.update();
|
||||
|
||||
// React 18 pattern - use waitFor or findBy:
|
||||
await waitFor(() => {
|
||||
expect(screen.getByText('Alice')).toBeInTheDocument();
|
||||
});
|
||||
// OR:
|
||||
expect(await screen.findByText('Alice')).toBeInTheDocument();
|
||||
```
|
||||
|
||||
## Upgrading Apollo
|
||||
|
||||
```bash
|
||||
npm install @apollo/client@latest graphql@latest
|
||||
```
|
||||
|
||||
If graphql peer dep conflicts with other packages:
|
||||
|
||||
```bash
|
||||
npm ls graphql # check what version is being used
|
||||
npm info @apollo/client peerDependencies # check what apollo requires
|
||||
```
|
||||
|
||||
Apollo 3.8+ supports both `graphql@15` and `graphql@16`.
|
||||
|
||||
## InMemoryCache - No Changes Required
|
||||
|
||||
`InMemoryCache` configuration is unaffected by the React 18 upgrade. No migration needed for:
|
||||
|
||||
- `typePolicies`
|
||||
- `fragmentMatcher`
|
||||
- `possibleTypes`
|
||||
- Custom field policies
|
||||
|
||||
## useQuery / useMutation / useSubscription - No Changes
|
||||
|
||||
Apollo hooks are unchanged in their API. The upgrade is entirely internal to how Apollo integrates with React's rendering model.
|
||||
@@ -0,0 +1,87 @@
|
||||
# React Router v5 → v6 - Scope Assessment
|
||||
|
||||
## Why This Is a Separate Sprint
|
||||
|
||||
React Router v5 → v6 is a complete API rewrite. Unlike most React 18 upgrade steps which touch individual patterns, the router migration affects:
|
||||
|
||||
- Every `<Route>` component
|
||||
- Every `<Switch>` (replaced by `<Routes>`)
|
||||
- Every `useHistory()` (replaced by `useNavigate()`)
|
||||
- Every `useRouteMatch()` (replaced by `useMatch()`)
|
||||
- Every `<Redirect>` (replaced by `<Navigate>`)
|
||||
- Nested route definitions (entirely new model)
|
||||
- Route parameters access
|
||||
- Query string handling
|
||||
|
||||
Attempting this as part of the React 18 upgrade sprint will scope-creep the migration significantly.
|
||||
|
||||
## Recommended Approach
|
||||
|
||||
### Option A - Defer Router Migration (Recommended)
|
||||
|
||||
Use `react-router-dom@5.3.4` with `--legacy-peer-deps` during the React 18 upgrade. This is explicitly documented as a supported workaround by the react-router team for React 18 compatibility on legacy root.
|
||||
|
||||
```bash
|
||||
# In the React 18 dep surgeon:
|
||||
npm install react-router-dom@5.3.4 --legacy-peer-deps
|
||||
```
|
||||
|
||||
Document in package.json:
|
||||
|
||||
```json
|
||||
"_legacyPeerDepsReason": {
|
||||
"react-router-dom@5.3.4": "Router v5→v6 migration deferred to separate sprint. React 18 peer dep mismatch only - no API incompatibility on legacy root."
|
||||
}
|
||||
```
|
||||
|
||||
Then schedule the v5 → v6 migration as its own sprint after the React 18 upgrade is stable.
|
||||
|
||||
### Option B - Migrate Router as Part of React 18 Sprint
|
||||
|
||||
Only choose this if:
|
||||
|
||||
- The app has minimal routing (< 10 routes, no nested routes, no complex navigation logic)
|
||||
- The team has bandwidth and the sprint timeline allows it
|
||||
|
||||
### Scope Assessment Scan
|
||||
|
||||
Run this to understand the router migration scope before deciding:
|
||||
|
||||
```bash
|
||||
echo "=== Route definitions ==="
|
||||
grep -rn "<Route\|<Switch\|<Redirect" src/ --include="*.js" --include="*.jsx" | grep -v "\.test\." | wc -l
|
||||
|
||||
echo "=== useHistory calls ==="
|
||||
grep -rn "useHistory()" src/ --include="*.js" --include="*.jsx" | grep -v "\.test\." | wc -l
|
||||
|
||||
echo "=== useRouteMatch calls ==="
|
||||
grep -rn "useRouteMatch()" src/ --include="*.js" --include="*.jsx" | grep -v "\.test\." | wc -l
|
||||
|
||||
echo "=== withRouter HOC ==="
|
||||
grep -rn "withRouter" src/ --include="*.js" --include="*.jsx" | grep -v "\.test\." | wc -l
|
||||
|
||||
echo "=== history.push / history.replace ==="
|
||||
grep -rn "history\.push\|history\.replace\|history\.go" src/ --include="*.js" --include="*.jsx" | grep -v "\.test\." | wc -l
|
||||
```
|
||||
|
||||
**Decision guide:**
|
||||
|
||||
- Total hits < 30 → router migration is feasible in this sprint
|
||||
- Total hits 30–100 → strongly recommend deferring
|
||||
- Total hits > 100 → must defer - separate sprint required
|
||||
|
||||
## v5 → v6 API Changes Summary
|
||||
|
||||
| v5 | v6 | Notes |
|
||||
|---|---|---|
|
||||
| `<Switch>` | `<Routes>` | Direct replacement |
|
||||
| `<Route path="/" component={C}>` | `<Route path="/" element={<C />}>` | element prop, not component |
|
||||
| `<Route exact path="/">` | `<Route path="/">` | exact is default in v6 |
|
||||
| `<Redirect to="/new">` | `<Navigate to="/new" />` | Component rename |
|
||||
| `useHistory()` | `useNavigate()` | Returns a function, not an object |
|
||||
| `history.push('/path')` | `navigate('/path')` | Direct call |
|
||||
| `history.replace('/path')` | `navigate('/path', { replace: true })` | Options object |
|
||||
| `useRouteMatch()` | `useMatch()` | Different return shape |
|
||||
| `match.params` | `useParams()` | Hook instead of prop |
|
||||
| Nested routes inline | Nested routes in config | Layout routes concept |
|
||||
| `withRouter` HOC | `useNavigate` / `useParams` hooks | HOC removed |
|
||||
Reference in New Issue
Block a user