mirror of
https://github.com/react/react-native.git
synced 2026-09-28 13:23:09 +08:00
Alex Hunt
ffe3f79495
Summary: Pull Request resolved: https://github.com/react/react-native/pull/57273 **Motivation** A README is the first thing an npm visitor sees on each package; internal-repo boilerplate like the "Testing" sections and the "We're using yarn…" note doesn't belong on a published package page. **Changes** - Standardize every README: a `# react-native/<name>` heading, a user-facing description, and a blue version badge plus a green monthly-downloads badge. - Keep the "internal dependency" prelude only on `community-cli-plugin`, `virtualized-lists`, and `js-polyfills`. - Drop the monorepo-template "Testing" sections and yarn note. - Rework `metro-config` around the Configuring Metro guide; add missing READMEs for `metro-babel-transformer` and `popup-menu-android`. Changelog: [Internal] Reviewed By: emily8rown Differential Revision: D109017270 fbshipit-source-id: 6208294c4ad2e6235a6605ae54f22d730f0476e7
17 lines
1.6 KiB
Markdown
17 lines
1.6 KiB
Markdown
# @react-native/debugger-shell
|
|
|
|
[![npm]](https://www.npmjs.com/package/@react-native/debugger-shell) [![npm downloads]](https://www.npmjs.com/package/@react-native/debugger-shell)
|
|
|
|
[npm]: https://img.shields.io/npm/v/@react-native/debugger-shell.svg?color=blue
|
|
[npm downloads]: https://img.shields.io/npm/dm/@react-native/debugger-shell.svg
|
|
|
|
Experimental Electron-based shell for React Native DevTools.
|
|
|
|
## Why Electron?
|
|
|
|
The React Native DevTools frontend is based on Chrome DevTools, which is a web app, but is not particularly portable: it's designed to run in Chromium, and Chromium only. Prior to `@react-native/debugger-shell`, we would run it in [hosted mode](https://chromium.googlesource.com/devtools/devtools-frontend/+/main/docs/get_the_code.md#running-in-hosted-mode) in an instance of Chrome or Edge.
|
|
|
|
Relying on hosted mode presents a variety of UX issues in the debugging workflow, such as the need to ask developers to install a particular browser before they can debug in React Native, and the inability to foreground/reuse existing debugger windows when relaunching the debugger for the same app. In order to address these issues effectively, we fundamentally need to leave the browser sandbox and run the debugger in a shell we can bundle with React Native, and whose behavior we can control.
|
|
|
|
Electron is a tried-and-tested framework for the *specific* task of embedding a Chromium browser in a portable, customized shell. As a rule we'll hold a high bar for performance and reliability, and we'll only add features to the shell if they are strictly necessary to complement the DevTools frontend's built-in capabilities.
|