Facebook/react-native
1
0
Fork 0
mirror of https://github.com/facebook/react-native.git synced 2025-11-01 09:14:26 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
050fb25c14cf4dd3c8024201a8a1ca9310786cd5
react-native/scripts/build-types
T
History
Alex Hunt 050fb25c14 Add debug flag to show versionExportedApis graph in output (#52298) 
Summary:
Pull Request resolved: https://github.com/facebook/react-native/pull/52298

Exposes the ability to output inline debug annotations for the `versionExportedApis` transform (D77303917) as a formalised `--debug-version-annotations` CLI flag.

This is helpful for debugging and future maintenance, and will be used to show the effect of the next diffs.

Changelog: [Internal]

Reviewed By: cipolleschi

Differential Revision: D77373723

fbshipit-source-id: 91c91abcb657ab88ee2f8209efccb4024602acc7
2025-06-26 10:46:23 -07:00
..
resolution
RN: Delete @oncall Annotations (#51416)
2025-05-17 16:18:05 -07:00
templates
Add nocommit to V2 JS API snapshot (#52200)
2025-06-24 06:31:04 -07:00
transforms
Add debug flag to show versionExportedApis graph in output (#52298)
2025-06-26 10:46:23 -07:00
utils
Update all transforms to apply sequentially (#52228)
2025-06-24 09:15:53 -07:00
BuildApiSnapshot.js
Add debug flag to show versionExportedApis graph in output (#52298)
2025-06-26 10:46:23 -07:00
buildGeneratedTypes.js
Improve CLI output for build-types (#52151)
2025-06-20 08:21:29 -07:00
config.js
Integrate building a type snapshot into typegen script (#51765)
2025-06-03 06:15:25 -07:00
index.js
Add debug flag to show versionExportedApis graph in output (#52298)
2025-06-26 10:46:23 -07:00
README.md
Add docs for build-types (#51852)
2025-06-06 01:14:43 -07:00
translateSourceFile.js
Update all transforms to apply sequentially (#52228)
2025-06-24 09:15:53 -07:00

README.md

scripts/build-types

TypeScript build pipeline for React Native's JavaScript API.

Overview

yarn build-types is a custom build pipeline for translating React Native's Flow source code to TypeScript.

Specifically, it reduces the runtime JavaScript API of react-native into two outputs:

  • Generated TypeScript types
    Public user types for react-native, shipped to npm
    packages/react-native/types_generated/
  • ‌Public API snapshot (experimental)
    Snapshot file of the public API shape, used by maintainers
    packages/react-native/ReactNativeApi.d.ts

Dependencies

yarn build-types makes use of the following dependencies, composed with other pre/post transformation steps and dependency resolution.

Usage

yarn build-types is designed to be run by maintainers with minimal arguments.

API snapshot generation is currently experimental, and will be folded into the default behaviour when ready.

# Build types
yarn build-types

# Build types + API snapshot (experimental)
yarn build-types --withSnapshot [--validate]

Configuration

Sparse configuration options are defined and documented in scripts/build-types/config.js.

About the two formats

Generated TypeScript types

types_generated/

Directory providing TypeScript user types for the react-native package, distributed via npm.

  • Gitignored.
  • Scoped to the index.d.ts entry point via package.json#exports.
  • Preserves unstable_ and experimental_ APIs.
  • Preserves doc comments.
  • Preserves source file names (for go to definition).

Public API snapshot (experimental)

ReactNative.d.ts

Provides a human-readable, maintainable reference of the React Native's public JavaScript API, optimized for developers and diff tooling.

  • Committed to the repo.
  • Strips unstable_ and experimental_ APIs.
  • Strips doc comments.
  • Strips source file names and some un-exported type names (WIP).
Reference in New Issue View Git Blame Copy Permalink