Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README files, remove "dead" config types #1343

Merged
merged 4 commits into from
Mar 31, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/large-geese-share.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@rnx-kit/config": patch
---

Update READMEs. Remove dead configuration types.
2 changes: 1 addition & 1 deletion incubator/patcher-rnmacos/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# patcher-rnmacos
# @rnx-kit/patcher-rnmacos

[![Build](https://github.com/microsoft/rnx-kit/actions/workflows/build.yml/badge.svg)](https://github.com/microsoft/rnx-kit/actions/workflows/build.yml)
[![npm version](https://img.shields.io/npm/v/@rnx-kit/patcher-rnmacos)](https://www.npmjs.com/package/@rnx-kit/patcher-rnmacos)
Expand Down
2 changes: 1 addition & 1 deletion incubator/rn-changelog-generator/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# React Native core changelog generator
# @rnx-kit/rn-changelog-generator

[![Build](https://github.com/microsoft/rnx-kit/actions/workflows/build.yml/badge.svg)](https://github.com/microsoft/rnx-kit/actions/workflows/build.yml)
[![npm version](https://img.shields.io/npm/v/@rnx-kit/rn-changelog-generator)](https://www.npmjs.com/package/@rnx-kit/rn-changelog-generator)
Expand Down
81 changes: 75 additions & 6 deletions packages/cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,57 @@ Command-line interface for working with `kit` packages in your repo.

## Bundle a Kit

Bundle a `kit` package using [Metro](https://facebook.github.io/metro). The
Bundle an application using [Metro](https://facebook.github.io/metro). The
bundling process is controlled by
[kit configuration](https://github.com/microsoft/rnx-kit/tree/main/packages/config)
[configuration](https://github.com/microsoft/rnx-kit/tree/main/packages/config)
and optional command-line overrides.

### Example Commands

```bash
yarn react-native rnx-bundle
```

```bash
yarn react-native rnx-bundle --platform ios --dev false --minify true
```
$ yarn react-native rnx-bundle [options]

```bash
yarn react-native rnx-bundle --bundle-prefix test-app --experimental-tree-shake true
```

### Example Configuration

```json
{
"rnx-kit": {
"bundle": {
"entryPath": "src/index.ts",
"distPath": "dist",
"assetsPath": "dist",
"bundlePrefix": "main",
"detectCyclicDependencies": true,
"detectDuplicateDependencies": {
"ignoredModules": ["react-is"]
},
"typescriptValidation": true,
"experimental_treeShake": true,
"targets": ["ios", "android", "windows", "macos"],
"platforms": {
"android": {
"assetsPath": "dist/reså"
},
"macos": {
"typescriptValidation": false
}
}
}
}
}
```

### Command-Line Overrides

| Override | Description |
| ---------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| --id [id] | Target bundle definition. This is only needed when the kit configuration has multiple bundle definitions. |
Expand All @@ -43,15 +85,42 @@ $ yarn react-native rnx-bundle [options]

## Start a Bundle Server

Start a bundle server for a `kit` package using
Start a bundle server for an application using
[Metro](https://facebook.github.io/metro). The server is controlled by
[kit configuration](https://github.com/microsoft/rnx-kit/tree/main/packages/config)
[configuration](https://github.com/microsoft/rnx-kit/tree/main/packages/config)
and optional command-line overrides.

### Example Commands

```bash
yarn react-native rnx-start
```

```bash
yarn react-native rnx-start --host localhost --port 8812
```
$ yarn react-native rnx-start [options]

### Example Configuration

```json
{
"rnx-kit": {
"server": {
"projectRoot": "src",
"detectCyclicDependencies": true,
"detectDuplicateDependencies": {
"ignoredModules": ["react-is"],
"throwOnError": false
},
"typescriptValidation": true,
"experimental_treeShake": true
}
}
}
```

### Command-Line Overrides

| Override | Description |
| ----------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| --host [string] | Host name or address to bind when listening for incoming server requests. When not given, requests from all addresses are accepted. |
Expand Down
Loading