pmndrs/react-three-fiber

RFC: @react-three/eslint-plugin rules

Open

#2.701 geöffnet am 10. Jan. 2023

Auf GitHub ansehen
 (15 Kommentare) (10 Reaktionen) (0 zugewiesene Personen)TypeScript (25.748 Stars) (1.464 Forks)batch import
help wantedrequest for commentsv10

Beschreibung

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
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
3-5 days
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
active
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
Basic ESLint plugin knowledgeReact Three Fiber conceptsJavaScript/TypeScript
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60
Research-Richtung
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.