mirror of
https://github.com/facebook/react-native.git
synced 2025-11-01 09:14:26 +00:00
Nick Gerleman
26983aed25
Summary: Pull Request resolved: https://github.com/facebook/react-native/pull/37347 This fixes the file-structure of `eslint-config-react-native-communtiy`, and `eslint-plugin-react-native-communtiy` to match the name they were renamed to as part of 0.72. Changelog: [Internal] Reviewed By: cortinico Differential Revision: D45721173 fbshipit-source-id: 7ad784dbf56fb4cd05d7dba608e6d5064392e43d
35 lines
964 B
Markdown
35 lines
964 B
Markdown
# @react-native/eslint-plugin
|
|
|
|
This plugin is intended to be used in [`@react-native/eslint-config`](https://github.com/facebook/react-native/tree/HEAD/packages/eslint-config-react-native). You probably want to install that package instead.
|
|
|
|
## Installation
|
|
|
|
```
|
|
yarn add --dev eslint @react-native/eslint-plugin
|
|
```
|
|
|
|
*Note: We're using `yarn` to install deps. Feel free to change commands to use `npm` 3+ and `npx` if you like*
|
|
|
|
## Usage
|
|
|
|
Add to your eslint config (`.eslintrc`, or `eslintConfig` field in `package.json`):
|
|
|
|
```json
|
|
{
|
|
"plugins": ["@react-native"]
|
|
}
|
|
```
|
|
|
|
## Rules
|
|
|
|
### `platform-colors`
|
|
|
|
Enforces that calls to `PlatformColor` and `DynamicColorIOS` are statically analyzable to enable performance optimizations.
|
|
|
|
## Testing
|
|
|
|
To run the tests in this package, run the following commands from the React Native root folder:
|
|
|
|
1. `yarn` to install the dependencies. You just need to run this once
|
|
2. `yarn jest packages/eslint-plugin-react-native`.
|