react-native-macos/packages/eslint-plugin-react-native-...
Tim Yung 77ecc7ede1 JS: Format with Prettier v2.4.1 [3/n]
Summary:
Changelog:
[General][Internal]

Reviewed By: zertosh

Differential Revision: D31883447

fbshipit-source-id: cbbf85e4bf935096d242336f41bf0cc5d6f92359
2021-11-02 22:14:16 -07:00
..
__tests__ JS: Format with Prettier v2.4.1 [3/n] 2021-11-02 22:14:16 -07:00
BUCK Move error-subclass-name lint rule to GitHub 2019-10-09 11:48:07 -07:00
README.md RN: Replace `master` with `main` in Documentation 2021-07-15 15:22:57 -07:00
error-subclass-name.js Move error-subclass-name lint rule to GitHub 2019-10-09 11:48:07 -07:00
index.js Add ES Lint rules for `DynamicColorIOS()`and `ColorAndroid()` (#28398) 2020-03-27 23:02:15 -07:00
no-haste-imports.js Add a lint rule to disallow Haste imports (#25058) 2019-05-30 07:45:16 -07:00
package.json chore: deduplicate lock, update packages repository fields (#30044) 2020-09-28 22:41:50 -07:00
platform-colors.js JS: Format with Prettier v2.4.1 [3/n] 2021-11-02 22:14:16 -07:00

README.md

eslint-plugin-react-native-community

This plugin is intended to be used in @react-native-community/eslint-config. You probably want to install that package instead.

Installation

yarn add --dev eslint @react-native-community/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):

{
    "plugins": ["@react-native-community"]
}

Rules

error-subclass-name

NOTE: This rule is primarily used for developing React Native itself and is not generally applicable to other projects.

Enforces that error classes ( = classes with PascalCase names ending with Error) only extend other error classes, and that regular functions don't have names that could be mistaken for those of error classes.

no-haste-imports

Disallows Haste module names in import statements and require() calls.

platform-colors

Enforces that calls to PlatformColor and DynamicColorIOS are statically analyzable to enable performance optimizations.