reactjs / reactjs/react.dev

[Bug]: eslint-plugin-react-hooks documentation says that 2 rules are recommended and all others are opt-in but that's not true

Aperta
#8,066 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

bug: unconfirmed
Lingua principale
JavaScript
Stelle
11.8k
Fork
7.9k
Merge medio
1g 11h
PR unite (30g)
11

Descrizione

Summary

https://react.dev/reference/eslint-plugin-react-hooks says:

Starting in version 6.0, these rules are available to opt-in:
...

According to that page only exhaustive-deps and rules-of-hooks are recommended.

But if you look are the source code for 7.0, you can see that extending configs.flat.recommended will more or less enable ALL the rules, including the ones related to the compiler:

https://github.com/facebook/react/blob/4b3e662e4ce54eb54a8701c48a967cc84a389501/packages/eslint-plugin-react-hooks/src/index.ts#L49-L52

Either the documentation needs to be updated or there is a bug in eslint-plugin-react-hooks where the recommended flat configs enabled too many rules. I am not in a position to decide who is wrong here :).

Page

https://react.dev/reference/eslint-plugin-react-hooks

Details

No response

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Confronta la documentazione di eslint-plugin-react-hooks all'indirizzo react.dev/reference/eslint-plugin-react-hooks con la configurazione referenziata in packages/eslint-plugin-react-hooks/src/index.ts intorno alle righe 49-52. Determina se la configurazione consigliata o la documentazione è incoerente, quindi aggiorna la fonte pertinente e verifica che il comportamento documentato della regola corrisponda alla configurazione.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
eslint, javascript, react
Ambito
documentation, tooling
Tipo di issue
Documentazione
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
45/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.