Skip to content
Open
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
3 changes: 2 additions & 1 deletion docs/healthChecks.md
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ async function needToInstallFoo({loader, logManualInstallation}) {

return logManualInstallation({
healthcheck: 'Foo',
url: 'https:/foo.com/download',
url: 'https://foo.com/download',
});
}
```
Expand All @@ -169,3 +169,4 @@ async function fixFoo({loader}) {

loader.succeed();
}
```
19 changes: 13 additions & 6 deletions docs/platforms.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,10 @@ At the end, a map of available platforms is passed to the bundler (Metro) to mak
## Platform interface

```ts
type PlatformConfig<ProjectParams, ProjectConfig, DependencyConfig> = {
type PlatformConfig<ProjectParams, ProjectConfig, DependencyParams, DependencyConfig> = {
npmPackageName?: string;
projectConfig: (string, ProjectParams) => ?ProjectConfig;
dependencyConfig: (string, ProjectParams) => ?DependencyConfig;
projectConfig: (root: string, params: ProjectParams) => ProjectConfig | null;
dependencyConfig: (root: string, params: DependencyParams) => DependencyConfig | null;
};
```

Expand Down Expand Up @@ -75,18 +75,23 @@ type IOSProjectConfig = {
sourceDir: string;
xcodeProject: {
name: string;
path: string;
isWorkspace: boolean;
} | null;
watchModeCommandParams: string;
watchModeCommandParams?: string[];
automaticPodsInstallation?: boolean;
assets: string[];
};

type AndroidProjectConfig = {
sourceDir: string;
appName: string;
packageName: string;
applicationId: string;
mainActivity: string;
dependencyConfiguration?: string;
watchModeCommandParams: string;
watchModeCommandParams?: string[];
assets: string[];
};
```

Expand All @@ -101,7 +106,9 @@ Second argument is everything that dependency authors defined under:
```js
module.exports = {
dependency: {
[yourPlatformKey]: {},
platforms: {
[yourPlatformKey]: {},
},
},
};
```
Expand Down
2 changes: 1 addition & 1 deletion docs/plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Also, you can provide your own configuration by creating a `react-native.config.
type Command = {
name: string;
description?: string;
func: (argv: Array<string>, config: ConfigT, args: Object) => ?Promise<void>;
func: (argv: Array<string>, config: ConfigT, args: Object) => Promise<void> | void;
options?: Array<{
name: string;
description?: string;
Expand Down
2 changes: 1 addition & 1 deletion docs/projects.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ You can check all available options below.
```ts
// referenced from @react-native-community/cli-types
type ProjectConfigT = {
reactNativePath: ?string;
reactNativePath?: string;
project: {
android?: AndroidProjectParams;
ios?: IOSProjectParams;
Expand Down
2 changes: 1 addition & 1 deletion packages/cli-tools/src/doclink.ts
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ function doclink(
isObj && hashOrOverrides.version ? hashOrOverrides.version : _version;
const OS = isObj && hashOrOverrides.os ? hashOrOverrides.os : getOS();

url.pathname = _version
url.pathname = version
? `${section}/${version}/${path}`
: `${section}/${path}`;

Expand Down
Loading