mirror of
https://github.com/facebook/react-native.git
synced 2025-11-01 09:14:26 +00:00
Alex Hunt
0d66c524cf
Summary: Pull Request resolved: https://github.com/facebook/react-native/pull/49353 This change adds an opt-in to restore JavaScript log streaming via the Metro dev server, [removed from React Native core in 0.77](https://reactnative.dev/blog/2025/01/21/version-0.77#removal-of-consolelog-streaming-in-metro). Users can opt into this legacy behaviour by adding the `--client-logs` flag to `npx react-native-community/cli start`. - The default experience remains without streamed JS logs. - The existing "JavaScript logs have moved! ..." notice is printed in all cases, and we do not advertise the new flag for new users. - Under non-Community CLI dev servers (i.e. Expo), log streaming is restored implicitly. We will clean up this functionality again when we eventually remove JS log streaming over `HMRClient`, tasked in T214991636. **Implementation notes** - Logs are always sent over `HMRClient` (previous status quo), even with log streaming off in the dev server. This is a necessary evil to be able to flag this functionality in a user-accessible place, and to move fast for 0.78. - Necessarily, emitting `fusebox_console_notice` moves to the dev server itself, on first device (Fusebox) connection. Changelog: [General][Added] - Add opt in for legacy Metro log streaming via `--client-logs` flag Reviewed By: robhogan Differential Revision: D69469039 fbshipit-source-id: be99d02a3b1c977a59bf7d2726f0e6cf2e60b28a
76 lines
3.8 KiB
Markdown
76 lines
3.8 KiB
Markdown
# @react-native/community-cli-plugin
|
|
|
|
> This is an internal dependency of React Native. **Please don't depend on it directly.**
|
|
|
|
CLI entry points supporting core React Native development features.
|
|
|
|
Formerly [@react-native-community/cli-plugin-metro](https://www.npmjs.com/package/@react-native-community/cli-plugin-metro).
|
|
|
|
## Commands
|
|
|
|
### `start`
|
|
|
|
Start the React Native development server.
|
|
|
|
#### Usage
|
|
|
|
```sh
|
|
npx @react-native-community/cli start [options]
|
|
```
|
|
|
|
#### Options
|
|
|
|
| Option | Description |
|
|
| - | - |
|
|
| `--port <number>` | Set the server port. |
|
|
| `--host <string>` | Set the server host. |
|
|
| `--projectRoot <path>` | Set the path to the project root. |
|
|
| `--watchFolders <list>` | Specify additional folders to be added to the watch list. |
|
|
| `--assetPlugins <list>` | Specify additional asset plugins. |
|
|
| `--sourceExts <list>` | Specify additional source extensions to bundle. |
|
|
| `--max-workers <number>` | Set the maximum number of workers the worker-pool will spawn for transforming files. Defaults to the number of the cores available on your machine. |
|
|
| `--transformer <string>` | Specify a custom transformer. |
|
|
| `--reset-cache` | Remove cached files. |
|
|
| `--custom-log-reporter-path <string>` | Specify a module path exporting a replacement for `TerminalReporter`. |
|
|
| `--https` | Enable HTTPS connections. |
|
|
| `--key <path>`| Specify path to a custom SSL key. |
|
|
| `--cert <path>` | Specify path to a custom SSL cert. |
|
|
| `--config <string>` | Path to the CLI configuration file. |
|
|
| `--no-interactive` | Disable interactive mode. |
|
|
| `--client-logs` | **[Deprecated]** Enable plain text JavaScript log streaming for all connected apps. |
|
|
|
|
### `bundle`
|
|
|
|
Build the bundle for the provided JavaScript entry file.
|
|
|
|
#### Usage
|
|
|
|
```sh
|
|
npx @react-native-community/cli bundle --entry-file <path> [options]
|
|
```
|
|
|
|
#### Options
|
|
|
|
| Option | Description |
|
|
| - | - |
|
|
| `--entry-file <path>` | Set the path to the root JavaScript entry file. |
|
|
| `--platform <string>` | Set the target platform (either `"android"` or `"ios"`). Defaults to `"ios"`. |
|
|
| `--transformer <string>` | Specify a custom transformer. |
|
|
| `--dev [boolean]` | If `false`, warnings are disabled and the bundle is minified. Defaults to `true`. |
|
|
| `--minify [boolean]` | Allows overriding whether bundle is minified. Defaults to `false` if `--dev` is set. Disabling minification can be useful for speeding up production builds for testing purposes. |
|
|
| `--bundle-output <string>` | Specify the path to store the resulting bundle. |
|
|
| `--bundle-encoding <string>` | Specify the encoding for writing the bundle (<https://nodejs.org/api/buffer.html#buffer_buffer>). |
|
|
| `--resolver-option <string...>` | Custom resolver options of the form key=value. URL-encoded. May be specified multiple times. |
|
|
| `--sourcemap-output <string>` | Specify the path to store the source map file for the resulting bundle. |
|
|
| `--sourcemap-sources-root <string>` | Set the root path for source map entries. |
|
|
| `--sourcemap-use-absolute-path` | Report `SourceMapURL` using its full path. |
|
|
| `--max-workers <number>` | Set the maximum number of workers the worker-pool will spawn for transforming files. Defaults to the number of the cores available on your machine. |
|
|
| `--assets-dest <string>` | Specify the directory path for storing assets referenced in the bundle. |
|
|
| `--reset-cache` | Remove cached files. |
|
|
| `--read-global-cache` | Attempt to fetch transformed JS code from the global cache, if configured. Defaults to `false`. |
|
|
| `--config <string>` | Path to the CLI configuration file. |
|
|
|
|
## Contributing
|
|
|
|
Changes to this package can be made locally and tested against the `rn-tester` app, per the [Contributing guide](https://reactnative.dev/contributing/overview#contributing-code). During development, this package is automatically run from source with no build step.
|