microsoft / microsoft/TypeScript
Improve quick info on JSX component elements
Personne n'a encore pris cette issue.
- Langage dominant
- Go
- Étoiles
- 111k
- Forks
- 14.4k
- Merge moyen
- 1 j 19 h
- PR mergées (30 j)
- 117
Description
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:
- 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;
- 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
- 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)
Example:
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.
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par le CodeSandbox lié et reproduisez le comportement du survol du composant JSX dans le service de langage TypeScript. Comparez la quick info de l’utilisation du composant avec la prop autocomplete et les PropTypes inférés dans MyComponent.js. C’est terminé lorsque le survol affiche les types de props inférés et distingue les props obligatoires des props optionnelles.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- javascript, react, typescript
- Domaine
- developer-experience
- Type d'issue
- Bug
- Difficulté
- 4/5
- Temps estimé
- 3-5 jours
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 30/100