reactjs / reactjs/react-docgen

Missing support for `Pick<>` and `Omit<>`

Aperta
#925 3 commenti 10 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

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

Descrizione

Whenever an interface is using the typescript features Pick or Omit, then we don't get any props from these interfaces/types.

In the case of an interface like this:

import { type LinkProps } from "next/link";

interface MyComponentProps
  extends Pick<LinkProps, "prefetch" | "replace" | "scroll" | "shallow"> {
  children?: React.ReactNode;
}

export const MyComponent: FunctionComponent<MyComponentProps> = () => {
  return <>My Component</>;
};

-> in this case it will only find "children" as prop.

import { type LinkProps } from "next/link";

interface MyComponentProps
  extends Pick<LinkProps, "prefetch" | "replace" | "scroll" | "shallow"> {
  children?: React.ReactNode;
}

export const MyComponent: FunctionComponent<MyComponentProps> = () => {
  return <>My Component</>;
};

The same with Omit<>:

import { type LinkProps } from "next/link";

interface MyComponentProps
  extends Omit<LinkProps, "prefetch" | "replace" | "scroll" | "shallow"> {
  children?: React.ReactNode;
}

export const MyComponent: FunctionComponent<MyComponentProps> = () => {
  return <>My Component</>;
};

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 riproducendo gli esempi TypeScript segnalati usando Pick e Omit, verificando le props estratte per ogni interfaccia. Il lavoro è completato quando le props ereditate attraverso entrambi i tipi utility sono incluse insieme alle props dichiarate esplicitamente.

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

Valutazione

Stack tecnologico
next.js, react, typescript
Ambito
developer-experience, devtools
Tipo di issue
Bug
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.