expo-codemod
CLI and jscodeshift codemods for migrating Expo apps between SDK versions
📚 Read the Documentation
•
Learn more on our blog
•
Contribute to expo-codemod
⭐️ Be sure to star the Expo GitHub repo if you enjoy using the project! ⭐️
---
The `expo-codemod` package is a CLI binary provided to help you upgrade between Expo SDK versions.
```
npx expo-codemod
```
## Usage
Run a transform against one or more paths or globs:
```sh
npx expo-codemod
```
```
Options:
(required) name of transform to apply to files
(see a list of transforms available below)
one or more paths or globs (e.g. src/**/*.tsx) of sources to transform
-h, --help print this help message
-v, --version print the CLI version
```
For example, to run a transform over everything under `src`:
```sh
npx expo-codemod sdk-56-expo-router-react-navigation-replace src
```
Globs work too (wrap them in quotes so the shell doesn't expand them):
```sh
npx expo-codemod sdk-56-expo-router-react-navigation-replace '**/*.{ts,tsx,js,jsx}'
```
## Transforms
### `sdk-56-expo-router-react-navigation-replace`
_Used to migrate a React Navigation app to Expo Router (SDK 56)._
Replaces imports from `@react-navigation/*` with their `expo-router` equivalents.
| From | To |
| ----------------------------------- | -------------------------- |
| `@react-navigation/native` | `expo-router` |
| `@react-navigation/stack` | `expo-router/js-stack` |
| `@react-navigation/bottom-tabs` | `expo-router/js-tabs` |
| `@react-navigation/material-top-tabs` | `expo-router/js-top-tabs` |
Default and namespace imports (`import X from ...` / `import * as X from ...`) from the mapped packages are not supported.
#### Example
Input:
```ts
import { NavigationContainer, useNavigation } from '@react-navigation/native';
import { useRouter } from 'expo-router';
```
Output:
```ts
import { NavigationContainer, useNavigation, useRouter } from "expo-router";
```
# Contributing
## Adding a new transform
1. Drop a new file under `src/transforms/` named `sdk--.ts` exporting a default jscodeshift `Transform` function. After the next build the runtime glob in [`src/transforms/index.ts`](./src/transforms/index.ts) picks it up automatically — no other wiring needed.
2. Add a sibling test under `src/transforms/__tests__/-test.ts` using `applyTransform` from `jscodeshift/dist/testUtils`.
3. Document the transform under [`## Transforms`](#transforms) above with a from/to table and a short example.