microsoft / microsoft/TypeScript

Improve quick info on JSX component elements

Aperta
#45,140 7 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Awaiting More Feedback Domain: LS: Quick Info Suggestion
Lingua principale
Go
Stelle
111k
Fork
14.4k
Merge medio
1g 19h
PR unite (30g)
117

Descrizione

TS Template added by @mjbvz

TypeScript Version: 4.4.0-dev.20210713

Search Terms

  • react
  • prop-types
  • jsx

Does this issue occur when all extensions are disabled?: Yes

  • VS Code Version: 1.58.2 (was happening before this version as well)
  • OS Version: Mac OS 10.14

Steps to Reproduce:

  1. Create a React functional component like this:
import React from "react";
import PropTypes from "prop-types";

//  vscode is able to infer the types correctly in autocomplete
// as this is a functional component, with prop types
// Please note that vscode still does not show the correct types
// when hovering on the component usage

function MyComponent({ prop1, prop2, prop3 }) {
  return (
    <div>
      <span>{prop1}</span>
      <span>{prop2}</span>
    </div>
  );
}

MyComponent.propTypes = {
  prop1: PropTypes.string.isRequired,
  prop2: PropTypes.bool,
  prop3: PropTypes.shape({
    p1: PropTypes.string
  })
};

MyComponent.defaultProps = {
  prop2: false
};

export default MyComponent;
  1. At the point of usage, where you have imported this component, hover on the usage, you will see that vscode is able to identify the function signature, but not the types of the function arguments, and shows them as any
Screenshot 2021-07-21 at 1 30 58 AM
  1. If you hovber over the specific prop though, you would see that vscode shows the correct type (inferred from prop types) and also provides autocompletion for the prop name. (Although there is still an issue that it shows all the props as optional)
Screenshot 2021-07-21 at 1 31 04 AM
Example:

https://codesandbox.io/s/vscode-intellisense-proptypes-fc-w-destructuring-w-proptypes-cngth?from-embed=&file=/src/MyComponent.js:0-655

Expectation:

I would have expected that

  • vscode would be able to infer the types on hovering as well, same as it can do while providing autocomplete suggestion for the prop
  • vscode would not show all the props as optional, since it seems that it can infer prop names and types from prop types, it should also be able to infer whether it is required or optional.

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 con il CodeSandbox collegato e riproduci il comportamento dell’hover del componente JSX nel servizio linguistico TypeScript. Confronta la quick info per l’utilizzo del componente con la prop autocomplete e i PropTypes inferiti in MyComponent.js. Il lavoro è completato quando l’hover mostra i tipi di prop inferiti e distingue le prop obbligatorie da quelle opzionali.

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

Valutazione

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

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.