From ed8b07a812e20b0c8562911283da932e4a290e9b Mon Sep 17 00:00:00 2001 From: Oskar Eichler <62393985+OskarEichler@users.noreply.github.com> Date: Fri, 28 Aug 2026 10:08:28 +0300 Subject: [PATCH] docs: correct configuration examples and versioned documentation links --- docs/healthChecks.md | 3 ++- docs/platforms.md | 19 +++++++++++++------ docs/plugins.md | 2 +- docs/projects.md | 2 +- packages/cli-tools/src/doclink.ts | 2 +- 5 files changed, 18 insertions(+), 10 deletions(-) diff --git a/docs/healthChecks.md b/docs/healthChecks.md index d47508793..968b1460a 100644 --- a/docs/healthChecks.md +++ b/docs/healthChecks.md @@ -154,7 +154,7 @@ async function needToInstallFoo({loader, logManualInstallation}) { return logManualInstallation({ healthcheck: 'Foo', - url: 'https:/foo.com/download', + url: 'https://foo.com/download', }); } ``` @@ -169,3 +169,4 @@ async function fixFoo({loader}) { loader.succeed(); } +``` diff --git a/docs/platforms.md b/docs/platforms.md index 770a8207f..b4fa3778c 100644 --- a/docs/platforms.md +++ b/docs/platforms.md @@ -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 = { +type PlatformConfig = { npmPackageName?: string; - projectConfig: (string, ProjectParams) => ?ProjectConfig; - dependencyConfig: (string, ProjectParams) => ?DependencyConfig; + projectConfig: (root: string, params: ProjectParams) => ProjectConfig | null; + dependencyConfig: (root: string, params: DependencyParams) => DependencyConfig | null; }; ``` @@ -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[]; }; ``` @@ -101,7 +106,9 @@ Second argument is everything that dependency authors defined under: ```js module.exports = { dependency: { - [yourPlatformKey]: {}, + platforms: { + [yourPlatformKey]: {}, + }, }, }; ``` diff --git a/docs/plugins.md b/docs/plugins.md index 072e2096d..17e772501 100644 --- a/docs/plugins.md +++ b/docs/plugins.md @@ -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, config: ConfigT, args: Object) => ?Promise; + func: (argv: Array, config: ConfigT, args: Object) => Promise | void; options?: Array<{ name: string; description?: string; diff --git a/docs/projects.md b/docs/projects.md index 2c0537306..2103cd31c 100644 --- a/docs/projects.md +++ b/docs/projects.md @@ -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; diff --git a/packages/cli-tools/src/doclink.ts b/packages/cli-tools/src/doclink.ts index 19ef6c1d1..303f5e3df 100644 --- a/packages/cli-tools/src/doclink.ts +++ b/packages/cli-tools/src/doclink.ts @@ -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}`;