migrate-to-strict-api
Use when migrating a React Native project to the Strict TypeScript API — the default JavaScript API from React Native 0.87, available as an opt-in preview since 0.80. Handles tsconfig.json setup, dependency updates, rewriting deep imports to root imports, and resolving breaking type changes. Invoke with `/migrate-to-strict-api`.
react-native-community · Static checks on file
Installation
Read the source and dependencies before running a command. Copying does not install or execute anything.
npx skills add react-native-community/skills --skill migrate-to-strict-apiAbout this skill
name: migrate-to-strict-api
description: >
Use when migrating a React Native project to the Strict TypeScript API —
the default JavaScript API from React Native 0.87, available as an opt-in
preview since 0.80. Handles tsconfig.json setup, dependency updates,
rewriting deep imports to root imports, and resolving breaking type
changes. Invoke with /migrate-to-strict-api.
license: MIT
metadata:
author: react-native-community
version: 0.1.0
Migrate to Strict TypeScript API
Migrate a React Native project to the Strict TypeScript API — auto-generated TypeScript types, scoped to react-native's root exports. The Strict API is the default from React Native 0.87, and an opt-in preview on 0.80–0.86.
This migration affects TypeScript analysis only. Nothing changes in the bundle or at runtime, so it is safe to apply incrementally and there is no shipping risk.
Invocation
/migrate-to-strict-api
Step-by-step procedure
Follow every step below in order. Do not skip steps.
1. Verify prerequisites
- Read
package.jsonand confirm thereact-nativeversion is >= 0.80. If not, stop and tell the user to upgrade first. Record whether the version is >= 0.87 — this decides steps 3 and 5. - Confirm
tsconfig.jsonexists. - Confirm
node_modules/react-native/types_generated/index.d.tsexists. If not, tell the user to run their package manager install first.
2. Update dependencies
Some libraries ship raw TypeScript source that is type-checked as part of the user's project — most commonly Jest mock entry points imported from a setup file. Under the Strict API these produce errors located under node_modules, typically TS2307: Cannot find module 'react-native/Libraries/...', which the user cannot fix in their own code.
- Confirm
skipLibCheckis enabled (@react-native/typescript-configsets it). Do not disable it. - Whenever type errors are located under
node_modules/<package>— at any point in this migration — update that package first, checking its releases for a Strict API compatibility fix. Known fixed versions are listed in references/library-compatibility.md. - If no fixed release exists, apply a local fix by redirecting the imported subpath to an untyped stub, and tell the user to report the incompatibility to the library:
{
"compilerOptions": {
"paths": {
"some-library/jest/mock": ["./untyped-module.d.ts"]
}
}
}
// untyped-module.d.ts
declare const anyExport: unknown;
export default anyExport;
An inline @ts-ignore does not work for this case — the errors are reported inside the library's files, not at the import site.
3. Enable the Strict API in tsconfig.json
React Native >= 0.87 — the Strict API is the default:
- If
compilerOptions.customConditionscontains"react-native-legacy-deep-imports", remove that entry (it is the temporary opt-out, due for removal in a future release), keeping"react-native"in place. - Otherwise, no config change is needed.
React Native 0.80–0.86 — opt in:
- Add
"customConditions": ["react-native", "react-native-strict-api"]tocompilerOptions. Both entries are required:customConditionsreplaces (not merges with) the value from an extended config, so omitting"react-native"drops the standard condition set by@react-native/typescript-configand breaks module resolution for packages that key on it. The project must use"moduleResolution": "bundler"(or"node16"/"nodenext") for custom conditions to take effect.
4. Fix deep imports
4a. Run the ESLint autofix first
@react-native/eslint-plugin ships a no-deep-imports rule with a code autofixer that rewrites known deep imports (default and type imports) to root imports. If the plugin is installed — it is bundled with @react-native/eslint-config — enable the rule in the project's ESLint config:
{"@react-native/no-deep-imports": "error"}
Then run ESLint with --fix across the project source. Recommend keeping the rule enabled afterwards to prevent regressions.
4b. Manual pass for the remainder
Read node_modules/react-native/types_generated/index.d.ts. This file is the source of truth for every export available under the Strict API. Each line maps an internal source path to an exported name:
export { default as Alert } from "./Libraries/Alert/Alert";
export type { AlertButton } from "./Libraries/Alert/Alert";
Parse this file to build two mappings:
- Value exports: internal path + original name → exported name (e.g.
./Libraries/Alert/Alertdefault →Alert) - Type exports: internal path → list of exported type names (e.g.
./Libraries/Alert/Alert→AlertType,AlertButton, ...)
Search all source files (.ts, .tsx, .js, .jsx) for remaining imports from react-native/Libraries/... or react-native/src/... subpaths, and rewrite each using the mapping:
| Deep import pattern | Replacement |
|---|---|
import Foo from 'react-native/Libraries/.../Foo' | import {Foo} from 'react-native' |
import type {FooProps} from 'react-native/Libraries/.../Foo' | import type {FooProps} from 'react-native' |
import {named} from 'react-native/Libraries/.../Foo' | import {named} from 'react-native' |
When a file already has a react-native root import, merge into it rather than adding a duplicate.
Codegen imports move to the CodegenTypes namespace:
// Before
import codegenNativeComponent from 'react-native/Libraries/Utilities/codegenNativeComponent';
import codegenNativeCommands from 'react-native/Libraries/Utilities/codegenNativeCommands';
import type {Int32, WithDefault} from 'react-native/Libraries/Types/CodegenTypes';
// After
import {codegenNativeComponent, codegenNativeCommands} from 'react-native';
import type {CodegenTypes} from 'react-native';
// Usage changes: Int32 →
Read the complete source ↗