Skip to content

Added Rule Options documentation for split-platform-components rule #257

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
Mar 23, 2021
Merged

Added Rule Options documentation for split-platform-components rule #257

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
27 changes: 27 additions & 0 deletions docs/rules/split-platform-components.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,3 +101,30 @@ export default function Hello() {
return <ActivityIndicatiorIOS/>
}
```

## Rule Options

```js
...
"react-native/split-platform-components": [ <enabled>, {
androidPathRegex: <string>,
iosPathRegex: <string>
}]
...
```

### `androidPathRegex`

A RegExp pattern to use for Android platform components. You can include other custom filenames like so:

```js
'react-native/split-platform-components': [2, {androidPathRegex: '\\.android.(js|jsx|ts|tsx)$'}]
```

### `iosPathRegex`

A RegExp pattern to use for iOS platform components. You can include other custom filenames like so:

```js
'react-native/split-platform-components': [2, {iosPathRegex: '\\.ios.(js|jsx|ts|tsx)$'}]
```