microsoft / microsoft/TypeScript
Sort jsdoc parameter suggestions by argument position
Personne n'a encore pris cette issue.
- Langage dominant
- Go
- Étoiles
- 111k
- Forks
- 14.3k
- Merge moyen
- 2 j 4 h
- PR mergées (30 j)
- 132
Description
From https://github.com/Microsoft/vscode/issues/35124
TypeScript Version: 2.7.0-dev.20171116
Code
For the code:
/**
* @param |
*/
function foo(z, a) {}
Trigger completions at the | after @param
Expected behavior:
z is returned first, followed by a. The sortText can be used for this
Actual behavior:
a and z are returned with sort orders weights:
[Trace - 11:33:07 PM] Sending request: completions (176). Response expected: yes. Current queue length: 0
Arguments: {
"file": "/Users/matb/projects/san/y.ts",
"line": 2,
"offset": 11,
"includeExternalModuleExports": true
}
[Trace - 11:33:07 PM] Response received: completions (176). Request took 2 ms. Success: true
Result: [
{
"name": "a",
"kind": "parameter",
"kindModifiers": "",
"sortText": "0"
},
{
"name": "z",
"kind": "parameter",
"kindModifiers": "",
"sortText": "0"
}
]
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 point d’entrée de complétion du language service TypeScript pour les suggestions JSDoc @param et reproduisez l’exemple avec function foo(z, a). Ajustez l’ordre des complétions afin que les paramètres suivent la position des arguments, puis vérifiez que z est renvoyé avant a et que sortText reflète cet ordre.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- typescript
- Domaine
- tooling
- Type d'issue
- Bug
- Difficulté
- 2/5
- Temps estimé
- 1-3 heures
- Activité
- Active
- Clarté
- Clairement spécifiée
- Accessibilité débutants
- 72/100