Skip to content

Commit 3915e60

Browse files
docs: update commands argument types to match source (#1331)
1 parent c09733a commit 3915e60

File tree

1 file changed

+41
-41
lines changed

1 file changed

+41
-41
lines changed

docs/commands.md

Lines changed: 41 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -33,13 +33,13 @@ Builds the JavaScript bundle for offline use.
3333

3434
Path to the root JS file, either absolute or relative to JS root.
3535

36-
#### `--platform [string]`
36+
#### `--platform <string>`
3737

3838
> default: ios
3939
4040
Either "ios" or "android".
4141

42-
#### `--transformer [string]`
42+
#### `--transformer <string>`
4343

4444
Specify a custom transformer to be used.
4545

@@ -71,21 +71,21 @@ The expected path for the js bundle can be found on the line that starts with <c
7171

7272
</details>
7373

74-
#### `--bundle-encoding [string]`
74+
#### `--bundle-encoding <string>`
7575

7676
> default: utf8
7777
7878
Encoding the bundle should be written in (https://nodejs.org/api/buffer.html#buffer_buffer).
7979

80-
#### `--max-workers [number]`
80+
#### `--max-workers <number>`
8181

8282
Specifies the maximum number of workers the worker-pool will spawn for transforming files. This defaults to the number of the cores available on your machine.
8383

84-
#### `--sourcemap-output [string]`
84+
#### `--sourcemap-output <string>`
8585

8686
File name where to store the sourcemap file for resulting bundle, ex. `/tmp/groups.map`.
8787

88-
#### `--sourcemap-sources-root [string]`
88+
#### `--sourcemap-sources-root <string>`
8989

9090
Path to make sourcemaps sources entries relative to, ex. `/root/dir`.
9191

@@ -95,7 +95,7 @@ Path to make sourcemaps sources entries relative to, ex. `/root/dir`.
9595
9696
Report SourceMapURL using its full path.
9797

98-
#### `--assets-dest [string]`
98+
#### `--assets-dest <string>`
9999

100100
Directory name where to store assets referenced in the bundle.
101101

@@ -123,7 +123,7 @@ Removes cached files.
123123
124124
Try to fetch transformed JS code from the global cache, if configured.
125125

126-
#### `--config [string]`
126+
#### `--config <string>`
127127

128128
Path to the CLI configuration file.
129129

@@ -153,19 +153,19 @@ Initialize a new React Native project named <projectName> in a directory of the
153153

154154
#### Options
155155

156-
#### `--version [string]`
156+
#### `--version <string>`
157157

158158
Shortcut for `--template react-native@version`.
159159

160-
#### `--directory [string]`
160+
#### `--directory <string>`
161161

162162
Uses a custom directory instead of `<projectName>`.
163163

164-
#### `--title [string]`
164+
#### `--title <string>`
165165

166166
Uses a custom app title instead of `<projectName>`.
167167

168-
#### `--template [string]`
168+
#### `--template <string>`
169169

170170
Uses a custom template. Accepts following template sources:
171171

@@ -310,59 +310,59 @@ Builds your app and starts it on a connected Android emulator or device.
310310

311311
#### Options
312312

313-
#### `--root [string]`
313+
#### `--root <string>`
314314

315315
> **DEPRECATED** – root is discovered automatically
316316
317317
Override the root directory for the Android build (which contains the android directory)'.
318318

319-
#### `--variant [string]`
319+
#### `--variant <string>`
320320

321321
> default: 'debug'
322322
323323
Specify your app's build variant.
324324

325-
#### `--appFolder [string]`
325+
#### `--appFolder <string>`
326326

327327
> **DEPRECATED** – use "project.android.appName" in react-native.config.js
328328
329329
> default: 'app'
330330
331331
Specify a different application folder name for the Android source. If not, we assume is "app".
332332

333-
#### `--appId [string]`
333+
#### `--appId <string>`
334334

335335
Specify an `applicationId` to launch after build. If not specified, `package` from AndroidManifest.xml will be used.
336336

337-
#### `--appIdSuffix [string]`
337+
#### `--appIdSuffix <string>`
338338

339339
Specify an `applicationIdSuffix` to launch after build.
340340

341-
#### `--main-activity [string]`
341+
#### `--main-activity <string>`
342342

343343
> default: 'MainActivity'
344344
345345
Name of the activity to start.
346346

347-
#### `--deviceId [string]`
347+
#### `--deviceId <string>`
348348

349349
builds your app and starts it on a specific device/simulator with the given device id (listed by running "adb devices" on the command line).
350350

351351
#### `--no-packager`
352352

353353
Do not launch packager while building.
354354

355-
#### `--port [number]`
355+
#### `--port <number>`
356356

357357
> default: process.env.RCT_METRO_PORT || 8081
358358
359-
#### `--terminal [string]`
359+
#### `--terminal <string>`
360360

361361
> default: process.env.REACT_TERMINAL || process.env.TERM_PROGRAM
362362
363363
Launches the Metro Bundler in a new window using the specified terminal path.
364364

365-
#### `--tasks [list]`
365+
#### `--tasks <list>`
366366

367367
> default: 'installDebug'
368368
@@ -387,7 +387,7 @@ Builds your app and starts it on iOS simulator.
387387

388388
#### Options
389389

390-
#### `--simulator [simulator_name]`
390+
#### `--simulator <simulator_name>`
391391

392392
> default: iPhone 11
393393
@@ -406,23 +406,23 @@ Example: this will launch your projet directly onto the iPhone XS Max simulator:
406406
react-native run-ios --simulator "iPhone XS Max"
407407
```
408408

409-
#### `--configuration [string]`
409+
#### `--configuration <string>`
410410

411411
Explicitly set the scheme configuration to use default: 'Debug'.
412412

413-
#### `--scheme [string]`
413+
#### `--scheme <string>`
414414

415415
Explicitly set Xcode scheme to use.
416416

417-
#### `--project-path [string]`
417+
#### `--project-path <string>`
418418

419419
Path relative to project root where the Xcode project (.xcodeproj) lives. default: 'ios'.
420420

421421
#### `--device [string]`
422422

423423
Explicitly set device to use by name. The value is not required if you have a single device connected.
424424

425-
#### `--udid [string]`
425+
#### `--udid <string>`
426426

427427
Explicitly set device to use by udid.
428428

@@ -434,7 +434,7 @@ Do not launch packager while building.
434434

435435
Do not use `xcpretty` even if installed.
436436

437-
#### `--port [number]`
437+
#### `--port <number>`
438438

439439
Runs packager on specified port
440440

@@ -452,35 +452,35 @@ Starts the server that communicates with connected devices
452452

453453
#### Options
454454

455-
#### `--port [number]`
455+
#### `--port <number>`
456456

457457
Specify port to listen on
458458

459-
#### `--projectRoot [path]`
459+
#### `--projectRoot <path>`
460460

461461
Path to a custom project root
462462

463-
#### `--watchFolders [list]`
463+
#### `--watchFolders <list>`
464464

465465
Specify any additional folders to be added to the watch list
466466

467-
#### `--sourceExts [list]`
467+
#### `--sourceExts <list>`
468468

469469
Specify any additional source extensions to be used by the packager
470470

471-
#### `--max-workers [number]`
471+
#### `--max-workers <number>`
472472

473473
Specifies the maximum number of workers the worker-pool will spawn for transforming files. This defaults to the number of the cores available on your machine
474474

475-
#### `--transformer [string]`
475+
#### `--transformer <string>`
476476

477477
Specify a custom transformer to be used
478478

479479
#### `--reset-cache, --resetCache`
480480

481481
Removes cached files
482482

483-
#### `--custom-log-reporter-path, --customLogReporterPath [string]`
483+
#### `--custom-log-reporter-path, --customLogReporterPath <string>`
484484

485485
Path to a JavaScript file that exports a log reporter as a replacement for TerminalReporter
486486

@@ -492,15 +492,15 @@ Enables logging
492492

493493
Enables https connections to the server
494494

495-
#### `--key [path]`
495+
#### `--key <path>`
496496

497497
Path to custom SSL key
498498

499-
#### `--cert [path]`
499+
#### `--cert <path>`
500500

501501
Path to custom SSL cert
502502

503-
#### `--config [string]`
503+
#### `--config <string>`
504504

505505
Path to the CLI configuration file
506506

@@ -565,7 +565,7 @@ Pull and convert a Hermes tracing profile to Chrome tracing profile, then store
565565
566566
#### Options
567567

568-
#### `--filename [string]`
568+
#### `--filename <string>`
569569

570570
File name of the profile to be downloaded, eg. sampling-profiler-trace8593107139682635366.cpuprofile.
571571

@@ -575,15 +575,15 @@ File name of the profile to be downloaded, eg. sampling-profiler-trace8593107139
575575

576576
Pulls the original Hermes tracing profile without any transformation
577577

578-
#### `--sourcemap-path [string]`
578+
#### `--sourcemap-path <string>`
579579

580580
The local path to your source map file if you generated it manually, ex. `/tmp/sourcemap.json`
581581

582582
#### `--generate-sourcemap`
583583

584584
Generate the JS bundle and source map in `os.tmpdir()`
585585

586-
#### '--port [number]',
586+
#### `--port <number>`,
587587

588588
The running metro server port number
589589

0 commit comments

Comments
 (0)