reactjs / reactjs/react-docgen

Typescript Status

Aperta
#1,005 0 commenti 4 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Lingua principale
TypeScript
Stelle
3.8k
Fork
316
Merge medio
5h 7m
PR unite (30g)
4

Descrizione

The overall development speed, as well as the frequency of new features and releases, has slowed down over the past few years. This is partly because I now have less time to dedicate to open source work. But more importantly, I believe the project has reached a critical turning point. Let me explain.

When this project started—before TypeScript was widely used—statically analyzing code to extract PropTypes was a reasonable solution. Most people used PropTypes in a fairly straightforward way, which made it easy for react-docgen to detect and interpret them. Even more complex use cases were manageable, because the underlying idea of PropTypes was relatively simple.

Fast forward to today: TypeScript has become the dominant way to type React props. react-docgen has some decent support for TypeScript—at least for the more common use cases. But TypeScript is a constantly evolving system, and it can be used in very sophisticated ways. This makes it increasingly difficult to cover all scenarios using static analysis alone.

While working on some of the more recent PRs, I realized that much of my time was spent effectively reimplementing how TypeScript works—trying to understand and reproduce its behavior just to infer component prop types. At that point, it started to feel like the project was heading in the wrong direction. I simply can’t keep up with the scale of what the TypeScript team and its much larger community are building.

There’s a project called react-docgen-typescript which I believe follows a more sustainable approach for TypeScript support. There may be even better options out there, but I don't currently have the time to invest in a shift of this magnitude.

So if you need better TypeScript support, I recommend giving react-docgen-typescript a try.

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

Inizia leggendo questa issue di stato e il progetto react-docgen-typescript referenziato. Il payload non indica alcun file del repository, test o punto di ingresso e non definisce alcuna modifica né alcun criterio di completamento, quindi qui non c’è un percorso di implementazione concreto da seguire.

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

Valutazione

Stack tecnologico
typescript
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
20/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.