@defaultValue is not parsed from interface

Aperta
#901 1 commento 1 reazione 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
48/100
Tipo di issue
Bug
Chiarezza
Specificata chiaramente
Stato di attività
Ferma
Stack tecnologico
typescript
Ambito
tooling

Direzione di ricerca

Riproduci l’esempio di interfaccia TypeScript nel playground di react-docgen e verifica come vengono analizzati i relativi tag JSDoc. Conferma che @defaultValue venga rimosso dalla descrizione e prodotto come defaultValue non calcolato con il valore previsto; usa l’output mostrato come verifica del completamento.

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

Descrizione

The following code tested in the playgroud https://react-docgen.dev/playground

interface Props {
  /** 
   * The name to greet
   *
   * @defaultValue 'something'
   */
  name: string;
}

/**
 * Hello world component
 */
const MyComponent = (props: Props) => {
  return <div />;
}

returns:

[
  {
    "description": "Hello world component",
    "displayName": "MyComponent",
    "methods": [],
    "props": {
      "name": {
        "required": true,
        "tsType": {
          "name": "string"
        },
        "description": "The name to greet\n\n@defaultValue 'something'"
      }
    }
  }
]

I think the defaultValue property is missing and should appear in the result, and part of the description "@defaultValue 'something'" should be removed.

[
  {
    "description": "Hello world component",
    "displayName": "MyComponent",
    "methods": [],
    "props": {
      "name": {
        "required": true,
        "tsType": {
          "name": "string"
        },
        "description": "The name to greet",
        "defaultValue": {
          "value": "'something'",
          "computed": false
        }
      }
    }
  }
]
Lingua principale
TypeScript
Stelle
3.8k
Fork
316
Merge medio
3h 28m
PR unite (30g)
6

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.

Altre issue di reactjs/react-docgen

Tutte le issue di reactjs/react-docgen

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.