reactjs / reactjs/react-docgen

Expressions in propTypes not parsed correctly

Aperta
#36 4 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

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

Descrizione

Originally reported in https://github.com/sapegin/react-styleguidist/issues/13#issuecomment-146868948.

I use an expression in React.PropTypes.oneOf(...). This is the output from react-docgen:

{
  "description": "",
  "props": {
    "issue": {
      "type": {
        "name": "object"
      },
      "required": false,
      "description": ""
    },
    "width": {
      "type": {
        "name": "enum",
        "computed": true,
        "value": "_.map(_.keys(coverWidths), _.parseInt)" <------- problem
      },
      "required": false,
      "description": ""
    },
    "style": {
      "type": {
        "name": "object"
      },
      "required": false,
      "description": ""
    }
  }
}

coverWidths is a variable defined in that file. In runtime it's generated correctly, but react-docgen can't parse it.

value in the marked line should be null, and there should be a raw property with it instead.

@fkling confirmed that this is is a bug in react-docgen.

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 individuando il punto di ingresso del parser di propTypes che gestisce le espressioni calcolate, usando l’esempio React.PropTypes.oneOf in questa issue come caso di riproduzione. Verifica l’output generato per .map(.keys(coverWidths), _.parseInt); l’operazione è completata quando value è null e l’espressione viene preservata in una proprietà raw.

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

Valutazione

Stack tecnologico
react, typescript
Ambito
documentation
Tipo di issue
Bug
Difficoltà
3/5
Tempo stimato
1-2 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.