packages/eslint-plugin/README.md
An ESLint plugin which provides lint rules for @react-three/fiber.
npm install @react-three/eslint-plugin --save-dev
Use the recommended config to get reasonable defaults:
"extends": [
"plugin:@react-three/recommended"
]
If you do not use a config you will need to specify individual rules and add extra configuration.
Add "@react-three" to the plugins section.
"plugins": [
"@react-three"
]
Enable the rules that you would like to use.
"rules": {
"@react-three/no-clone-in-frame-loop": "error"
}
✅ Enabled in the recommended configuration.
🔧 Automatically fixable by the --fix CLI option.
💡 Manually fixable by editor suggestions.
<!-- START_RULE_CODEGEN --> <!-- @command yarn codegen:eslint -->| Rule | Description | ✅ | 🔧 | 💡 |
|---|---|---|---|---|
| <a href="./docs/rules/no-clone-in-loop.md">no-clone-in-loop</a> | Disallow cloning vectors in the frame loop which can cause performance problems. | ✅ | ||
| <a href="./docs/rules/no-new-in-loop.md">no-new-in-loop</a> | Disallow instantiating new objects in the frame loop which can cause performance problems. | ✅ |
This plugin exports a recommended configuration that enforces rules appropriate for everyone using React Three Fiber.
"extends": [
"plugin:@react-three/recommended"
]
This plugin also exports an all configuration that includes every available rule.
"extends": [
"plugin:@react-three/all"
]