react-native/packages/debugger-frontend/README.md
Alex Hunt d4fe550478 Update source repo URL for debugger-frontend, require branch arg (#41118)
Summary:
Pull Request resolved: https://github.com/facebook/react-native/pull/41118

Updates the release process and guidance for `debugger-frontend`, now that the source [facebookexperimental/rn-chrome-devtools-frontend](https://github.com/facebookexperimental/rn-chrome-devtools-frontend) repo is published.

The `sync-and-build` script now requires a `--branch` argument, allowing us to match release branches across repos for hotfixes (e.g. `0.73-stable`).

Changelog: [Internal]

Reviewed By: motiz88

Differential Revision: D50496327

fbshipit-source-id: 671fd1581e23032eec0a419a6e50dac6c76feeb0
2023-10-20 12:34:29 -07:00

1.4 KiB

@react-native/debugger-frontend

npm package

Debugger frontend for React Native based on Chrome DevTools.

This package is internal to React Native and is intended to be used via @react-native/dev-middleware.

Usage

The package exports the absolute path to the directory containing the frontend assets.

const frontendPath = require('@react-native/debugger-frontend');

// Pass frontendPath to a static server, etc

Contributing

Source repo

Source code for this package lives in the facebookexperimental/rn-chrome-devtools-frontend repo. See below for how we build and check in changes.

Updating the frontend assets

The compiled assets for the debugger frontend are periodically checked into this package under the dist/ folder. To update these, run node scripts/debugger-frontend/sync-and-build from the root of your react-native checkout.

# For main
node scripts/debugger-frontend/sync-and-build --branch main

# For stable branches (e.g. '0.73-stable')
node scripts/debugger-frontend/sync-and-build --branch 0.73-stable

By default, this will clone and build from facebookexperimental/rn-chrome-devtools-frontend.