zzos/react-native
1
0
Fork 0
mirror of https://github.com/react/react-native.git synced 2026-09-28 13:23:09 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs(ios-prebuild): correct how SwiftPM consumes the prebuilt React headers (#58007)

Browse Source 
Summary:
`ios-prebuild/__docs__/README.md` said `React.framework`'s headers-spec layout
"is what both CocoaPods and SwiftPM consume". That is right for CocoaPods and
misleading for SwiftPM: `React.xcframework` is not a member of the Swift package
graph at all, so nothing on the SwiftPM side reads its framework module map.

What actually happens is a staging step on the consumer side —
`stageReactHeadersTarget` in `scripts/spm/flavored-frameworks.js` copies
`React.framework/Headers` into `ReactHeadersTarget/include/React` and rewrites
`framework module React` to a plain `module React`, which is then vended as the
`ReactHeaders` target. The prebuild output is still the source of those headers,
which is why the sentence was nearly right; the consumption path is what differs.

Says so, and keeps the CocoaPods half explicit about `FRAMEWORK_SEARCH_PATHS` so
the two paths read as the distinct mechanisms they are.

## Changelog:

[Internal] - Clarify that SwiftPM consumes the prebuilt React headers through a
staged `ReactHeaders` target, not through the XCFramework's module map

Pull Request resolved: https://github.com/react/react-native/pull/58007

Test Plan:
Docs only. Verified against `scripts/spm/generate-spm-package.js`, whose generated
`ReactNative` manifest declares exactly three headers-only products and no runtime
`binaryTarget`, and against `stageReactHeadersTarget`, which does the copy and the
module-map rewrite only after Debug and Release are asserted to expose identical
headers. Prettier clean — the file was formatted before this change and still is.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

Reviewed By: fabriziocucci

Differential Revision: D116598314

Pulled By: cipolleschi

fbshipit-source-id: 3b58101e64410d35f0346c696992dda8261e00a4
This commit is contained in:
Christian Falch
2026-08-19 09:21:09 -07:00
committed by meta-codesync[bot]
co-authored by Claude Opus 5
parent a6898cc4cf
commit 0c86952e40
1 changed files with 7 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/react-native/scripts/ios-prebuild/__docs__/README.md
+7 -1
View File
@@ -138,7 +138,13 @@ The prebuild (`xcframework.js`) always produces:
- `React.xcframework` — the compiled React core. Each slice's `React.framework`
carries the headers-spec layout (every `<React/...>` header + the framework
module map), which is what both CocoaPods and SwiftPM consume.
module map). CocoaPods consumes that layout directly, through
`FRAMEWORK_SEARCH_PATHS`. SwiftPM consumes the same headers indirectly: the
XCFramework is not a member of the Swift package graph, so the consumer side
stages a copy of `React.framework/Headers` into
`ReactHeadersTarget/include/React` and rewrites `framework module React` to a
plain `module React`, vended as the `ReactHeaders` target (see
`spm-header-paths-contract.md` in the SwiftPM docs).
- `ReactNativeHeaders.xcframework` — headers-only; carries every other
namespace. Consumed by SwiftPM as a `binaryTarget` and by CocoaPods via the
`React-Core-prebuilt` pod (headers flattened onto the header search path).