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
2079cb295f2ea6267f4a0ce4876b6ea696ce98da
react-native/scripts/build-types
T
History
Dawid Małecki beb3d49a1b Fix sorting string literals in React Native API snapshot (#51916) 
Summary:
Pull Request resolved: https://github.com/facebook/react-native/pull/51916

String literals were not sorted in React Native API Snapshot. This diff fixes the issue by retrieving the value from the string literal.

Before:

```ts
type A = {
  a: string;
  b: string;
  \"ba\": string;
  \"ab\": string;
  aFn: () => void;
  bFn: () => void;
  aMethod(): void;
  bMethod(): void;
};
```

After:

```ts
type A = {
  a: string;
  \"ab\": string;
  b: string;
  \"ba\": string;
  aFn: () => void;
  bFn: () => void;
  aMethod(): void;
  bMethod(): void;
};
```

Changelog:
[Internal]

Reviewed By: robhogan

Differential Revision: D76329242

fbshipit-source-id: 9645b82cbd22e2d3acef1376a9ffefa3646457d9
2025-06-10 05:46:40 -07:00
..
resolution
RN: Delete @oncall Annotations (#51416)
2025-05-17 16:18:05 -07:00
templates
WIP [RN][JS Stable API] Verify built types in Github CI (#51808)
2025-06-06 00:29:36 -07:00
transforms
Fix sorting string literals in React Native API snapshot (#51916)
2025-06-10 05:46:40 -07:00
BuildApiSnapshot.js
Rename local symbols exported by default before generating the snapshot (#51864)
2025-06-06 03:54:43 -07:00
buildGeneratedTypes.js
Rename local symbols exported by default before generating the snapshot (#51864)
2025-06-06 03:54:43 -07:00
config.js
Integrate building a type snapshot into typegen script (#51765)
2025-06-03 06:15:25 -07:00
index.js
Replace chalk in build scripts (#51904)
2025-06-09 18:21:18 -07:00
README.md
Add docs for build-types (#51852)
2025-06-06 01:14:43 -07:00
translateSourceFile.js
Disallow usage of unprefixed (suffixed) Props type name (#51653)
2025-06-04 04:38:48 -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