@react-three/eslint-plugin

v0.1.2
  • Types
  • ESM
  • CJS

An ESLint plugin which provides lint rules for @react-three/fiber.

License
MIT
Install Size
13 kB/-
Vulns
0
Published

Get started

$npm install @react-three/eslint-plugin
$pnpm add @react-three/eslint-plugin
$yarn add @react-three/eslint-plugin
$bun add @react-three/eslint-plugin
$deno add npm:@react-three/eslint-plugin
$vlt install @react-three/eslint-plugin
# Usually installed as a dev dependency
$npm install -D @react-three/eslint-plugin
$pnpm add -D @react-three/eslint-plugin
$yarn add -D @react-three/eslint-plugin
$bun add -d @react-three/eslint-plugin
$deno add -D npm:@react-three/eslint-plugin
$vlt install -D @react-three/eslint-plugin

Readme

@react-three/eslint-plugin

Version Twitter Discord Open Collective ETH BTC

An ESLint plugin which provides lint rules for @react-three/fiber.

Installation

npm install @react-three/eslint-plugin --save-dev

Configuration

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"
}

Rules

✅ Enabled in the recommended configuration.
🔧 Automatically fixable by the --fix CLI option.
💡 Manually fixable by editor suggestions.

Rule Description 🔧 💡
no-clone-in-loop Disallow cloning vectors in the frame loop which can cause performance problems.
no-new-in-loop Disallow instantiating new objects in the frame loop which can cause performance problems.

Shareable configs

This plugin exports a recommended configuration that enforces rules appropriate for everyone using React Three Fiber.

"extends": [
  "plugin:@react-three/recommended"
]
All

This plugin also exports an all configuration that includes every available rule.

"extends": [
  "plugin:@react-three/all"
]