pmndrs/react-three-fiber

RFC: @react-three/eslint-plugin rules

Open

#2701 opened on Jan 10, 2023

View on GitHub
 (15 comments) (10 reactions) (0 assignees)TypeScript (25,748 stars) (1,464 forks)batch import
help wantedrequest for commentsv10

Description

Aligning with our docs for general performance pitfalls and API usage around context (use R3F hooks within Canvas):

  • no-clone-in-frame-loop: Prefer creating temporary objects in global space and copy rather than clone in hot paths. This should be restricted to three.js classes to avoid collisions. https://github.com/pmndrs/react-three-fiber/pull/2710
  • no-fast-state: Don't set state within loops or continuous events (startTransition can be used if you must, this can be disabled for specific polling cases)
  • prefer-useloader: Prefer useLoader for suspense and caching rather than calling Loader.load or Loader.loadAsync in an effect. This will de-dup resources on both the CPU and GPU and avoid later expensive runtime compilation.

Contributor guide

Tech stack
reacttypescriptjavascript
Domain
developer experiencetooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic ESLint plugin knowledgeReact Three Fiber conceptsJavaScript/TypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Examine the existing pitfalls documentation (https://docs.pmnd.rs/react three fiber/advanced/pitfalls) and the reference PR #2710 for the no clone in frame loop rule. Study ESLint plugin structures (e.g., ast, rule creation) and decide on rule names and messages. Consider adding tests and documentation.