mirror of
https://github.com/zebrajr/react.git
synced 2026-01-15 12:15:22 +00:00
## Summary
When upgrading to `babel-plugin-react-compiler@1.0.0` in a project that
uses `zod@3` we are running into TypeScript errors like:
```
node_modules/babel-plugin-react-compiler/dist/index.d.ts:435:10 - error TS2694: Namespace '"/REDACTED/node_modules/zod/v3/external"' has no exported member 'core'.
435 }, z.core.$strip>>>;
~~~~
```
This problem seems to be related to
d6eb735938, which introduced zod v3/v4
compatibility. Since `zod` is bundled into the compiler source this does
not cause runtime issues and only manifests as TypeScript errors. My
proposed solution is this PR is to use zod's [subpath versioning
strategy](https://zod.dev/v4/versioning?id=versioning-in-zod-4) which
allows you to support v3 and v4 APIs on both major versions.
Changes in this PR include:
- Updated `zod` import paths to `zod/v4`
- Bumped min `zod` version to `^3.25.0` for zod which guarantees the
`zod/v4` subpath is available.
- Updated `zod-validation-error` import paths to
`zod-validation-error/v4`
- Bumped min `zod-validation-error ` version to `^3.5.0`
- Updated `externals` tsup configuration where appropriate.
Once the compiler drops zod v3 support we could optionally remove the
`/v4` subpath from the imports.
## How did you test this change?
Not totally sure the best way to test. I ran `NODE_ENV=production yarn
workspace babel-plugin-react-compiler run build --dts` and diffed the
`dist/` folder between my change and `v1.0.0` and it looks correct. We
have a `patch-package` patch to workaround this for now and it works as
expected.
```diff
diff --git a/node_modules/babel-plugin-react-compiler/dist/index.d.ts b/node_modules/babel-plugin-react-compiler/dist/index.d.ts
index 81c3f3d..daafc2c 100644
--- a/node_modules/babel-plugin-react-compiler/dist/index.d.ts
+++ b/node_modules/babel-plugin-react-compiler/dist/index.d.ts
@@ -1,7 +1,7 @@
import * as BabelCore from '@babel/core';
import { NodePath as NodePath$1 } from '@babel/core';
import * as t from '@babel/types';
-import { z } from 'zod';
+import { z } from 'zod/v4';
import { NodePath, Scope } from '@babel/traverse';
interface Result<T, E> {
```
Co-authored-by: Henry Q. Dineen <henryqdineen@gmail.com>
47 lines
1.2 KiB
JSON
47 lines
1.2 KiB
JSON
{
|
|
"name": "eslint-plugin-react-compiler",
|
|
"version": "0.0.0-experimental-9ed098e-20240725",
|
|
"description": "ESLint plugin to display errors found by the React compiler.",
|
|
"main": "dist/index.js",
|
|
"scripts": {
|
|
"build": "rimraf dist && tsup",
|
|
"test": "jest",
|
|
"watch": "yarn build --watch"
|
|
},
|
|
"files": [
|
|
"dist"
|
|
],
|
|
"dependencies": {
|
|
"@babel/core": "^7.24.4",
|
|
"@babel/parser": "^7.24.4",
|
|
"hermes-parser": "^0.25.1",
|
|
"zod": "^3.25.0 || ^4.0.0",
|
|
"zod-validation-error": "^3.5.0 || ^4.0.0"
|
|
},
|
|
"devDependencies": {
|
|
"@babel/preset-env": "^7.22.4",
|
|
"@babel/preset-typescript": "^7.18.6",
|
|
"@babel/types": "^7.26.0",
|
|
"@types/eslint": "^8.56.12",
|
|
"@types/jest": "^30.0.0",
|
|
"@types/node": "^20.2.5",
|
|
"babel-jest": "^29.0.3",
|
|
"eslint": "8.57.0",
|
|
"hermes-eslint": "^0.25.1",
|
|
"jest": "^29.5.0",
|
|
"regexp.escape": "^2.0.1"
|
|
},
|
|
"engines": {
|
|
"node": "^14.17.0 || ^16.0.0 || >= 18.0.0"
|
|
},
|
|
"peerDependencies": {
|
|
"eslint": ">=7"
|
|
},
|
|
"repository": {
|
|
"type": "git",
|
|
"url": "git+https://github.com/facebook/react.git",
|
|
"directory": "compiler/packages/eslint-plugin-react-compiler"
|
|
},
|
|
"license": "MIT"
|
|
}
|