mirror of
https://github.com/expo/eas-cli.git
synced 2026-11-15 17:31:46 -10:00
## Why - Repository maintenance: standardize on Yarn 4 managed via Mise. - Prepare for introducing minimum package-age constraints in dependency policy. ## How - Migrated repo tooling to Yarn 4 with Mise. - Updated CI and scripts for Yarn 4 behavior: - Lerna invoked via `yarn run -T lerna`. - Coverage args forwarded correctly (`-- --coverage`). - Removed unsupported Yarn 4 `--silent` usage. - Added missing package-local script dependencies surfaced by Yarn 4 (`jest`, `oxlint`, `rimraf`). - Increased `EasCommand` coverage test timeout from 30s to 60s. (Was consistently failing in CI.) ## Test Plan - CI only: `Run tests` matrix (including Node 20 coverage) and other touched workflows. - Release behavior will be verified during the normal release run.
77 lines
2.4 KiB
Markdown
77 lines
2.4 KiB
Markdown
# Development
|
|
|
|
## Getting Started
|
|
|
|
If this is your first time running `eas-cli` locally, make sure you install and build the packages. In the project root, run:
|
|
|
|
```sh
|
|
yarn install
|
|
yarn build
|
|
```
|
|
|
|
From there, set up an alias for the EAS CLI so you can try it in projects all around your computer. The project is compiled on the fly so you don't need to run a build (watch) command.
|
|
|
|
> The only exception is if there have been changes in `packages/eas-json`. In that case, you'll have to run `yarn build` in the root.
|
|
|
|
Open your `.zshrc` or other config file and add:
|
|
|
|
```sh
|
|
alias easd="/PATH/TO/eas-cli/bin/run"
|
|
```
|
|
|
|
Then use it with `easd` like `easd build`.
|
|
|
|
If you're making changes to `packages/eas-json` or prefer/need to work with production code, start the build command in watch mode with:
|
|
|
|
```sh
|
|
yarn start
|
|
```
|
|
|
|
If it is easier for you to work with the code locally with compiler options set to:
|
|
|
|
```json
|
|
...
|
|
"compilerOptions": {
|
|
...
|
|
"noUnusedLocals": false,
|
|
"noUnusedParameters": false,
|
|
...
|
|
}
|
|
...
|
|
```
|
|
|
|
you can consider using:
|
|
|
|
```sh
|
|
yarn start-allow-unused
|
|
```
|
|
|
|
## Format
|
|
|
|
- Be sure to update the [`CHANGELOG.md`](./CHANGELOG.md) with changes for every PR. There is a changelog bot that can generate the proper entry for you. The instructions on how to use it are in the PR description placeholder.
|
|
- End `async` functions with `Async` like `runAsync`. This is just how we format functions at Expo.
|
|
- Utilize the unified `Log` module instead of `console.log`.
|
|
|
|
## Using local and staging API
|
|
|
|
For development against local API:
|
|
|
|
- Set up the API server as described at https://github.com/expo/universe/tree/main/server/www.
|
|
- Set the `EXPO_LOCAL=1` env variable either on every command run (e.g. `EXPO_LOCAL=1 easd ...`) or more permamently with `export EXPO_LOCAL=1` (works in a current shell session).
|
|
|
|
For development against staging API:
|
|
|
|
- Set the `EXPO_STAGING=1` env variable either on every command run (e.g. `EXPO_STAGING=1 easd ...`) or more permamently with `export EXPO_STAGING=1` (works in a current shell session).
|
|
|
|
## Working on local builds (`eas build --local`)
|
|
|
|
See [`CLAUDE.md`](./CLAUDE.md) for how to set up your environment when making changes to [`eas-cli-local-build-plugin`](./packages/local-build-plugin) and/or [`build-tools`](./packages/build-tools).
|
|
|
|
## Testing
|
|
|
|
From the repository root, run `yarn run -T lerna run test`. For a single package, run `yarn test` in that package directory.
|
|
|
|
## Releasing
|
|
|
|
See [RELEASING.md](./RELEASING.md).
|