Skip to content

docs: document how to disable autolinking for unsupported packages #444

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jun 27, 2019
Merged

docs: document how to disable autolinking for unsupported packages #444

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 16 additions & 0 deletions docs/autolinking.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,3 +48,19 @@ On the iOS side, you will need to ensure you have a Podspec to the root of your
## How can I customize how autolinking works for my package?

A library can add a `react-native.config.js` configuration file, which will customize the defaults.

## How do I disable autolinking for unsupported package?

It happens, that during transition period or due to convoluted setup some packages don't support autolinking on certain platforms. To disable autolinking from running for a certain package, update your `react-native.config.js`'s `dependencies` entry to look like this:

```js
module.exports = {
dependencies: {
'some-unsupported-package': {
platforms: {
android: null, // disable Android platform, other platforms will still autolink if provided
},
},
},
};
```
39 changes: 24 additions & 15 deletions packages/cli/src/tools/config/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,32 +13,41 @@ import {
readConfigFromDisk,
readDependencyConfigFromDisk,
} from './readConfigFromDisk';
import {type ConfigT} from 'types';
import type {
ConfigT,
UserDependencyConfigT,
UserConfigT,
DependencyConfigT,
} from 'types';
import assign from '../assign';
import merge from '../merge';
import resolveNodeModuleDir from './resolveNodeModuleDir';

function getDependencyConfig(
root,
dependencyName,
finalConfig,
config,
userConfig,
isPlatform,
) {
root: string,
dependencyName: string,
finalConfig: ConfigT,
config: UserDependencyConfigT,
userConfig: UserConfigT,
isPlatform: boolean,
): DependencyConfigT {
return merge(
{
root,
name: dependencyName,
platforms: Object.keys(finalConfig.platforms).reduce(
(dependency, platform) => {
// Linking platforms is not supported
dependency[platform] = isPlatform
? null
: finalConfig.platforms[platform].dependencyConfig(
root,
config.dependency.platforms[platform] || {},
);
const platformConfig = finalConfig.platforms[platform];
dependency[platform] =
// Linking platforms is not supported
isPlatform || !platformConfig
? null
: platformConfig.dependencyConfig(
root,
/* $FlowFixMe - can't figure out which platform's dependency
config to choose */
config.dependency.platforms[platform],
);
return dependency;
},
{},
Expand Down
2 changes: 1 addition & 1 deletion packages/platform-android/native_modules.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ class ReactNativeModules {
packageImports = packageImports + packages.collect {
"// ${it.name}\n${it.packageImportPath}"
}.join('\n')
packageClassInstances = ",\n " + packages.collect { it.packageInstance }.join(',')
packageClassInstances = ",\n " + packages.collect { it.packageInstance }.join(",\n ")
Copy link
Member Author

@thymikee thymikee Jun 25, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this updates the generated PackageList.java to be nicely formatted around package instance invocations

}

String generatedFileContents = generatedFileContentsTemplate
Expand Down
15 changes: 11 additions & 4 deletions types/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,9 +72,14 @@ type ProjectParamsIOST = {
plist: any[],
};

type PlatformConfig<ProjectParams, ProjectConfig, DependencyConfig> = {
projectConfig: (string, ProjectParams) => ?ProjectConfig,
dependencyConfig: (string, ProjectParams) => ?DependencyConfig,
type PlatformConfig<
ProjectParams,
DependencyParams,
ProjectConfig,
DependencyConfig,
> = {
projectConfig: (string, ?ProjectParams) => ?ProjectConfig,
dependencyConfig: (string, ?DependencyParams) => ?DependencyConfig,
linkConfig: () => {
isInstalled: (ProjectConfig, string, DependencyConfig) => boolean,
register: (string, DependencyConfig, Object, ProjectConfig) => void,
Expand Down Expand Up @@ -131,14 +136,16 @@ export type ConfigT = {|

// Map of available platforms (built-ins and dynamically loaded)
platforms: {
[name: string]: PlatformConfig<Object, Object, Object>,
[name: string]: PlatformConfig<any, any, any, any>,
ios?: PlatformConfig<
ProjectParamsIOST,
ProjectParamsIOST, // DependencyParams are the same as ProjectParams on iOS
ProjectConfigIOST,
DependencyConfigIOST,
>,
android?: PlatformConfig<
ProjectParamsAndroidT,
DependencyParamsAndroidT,
ProjectConfigAndroidT,
DependencyConfigAndroidT,
>,
Expand Down