Microsoft/TypeScript

Sort jsdoc parameter suggestions by argument position

Open

#20 183 ouverte le 21 nov. 2017

Voir sur GitHub
 (9 commentaires) (0 réactions) (0 assignés)TypeScript (6 726 forks)batch import
Domain: LS: Completion ListsGood First IssueHelp WantedSuggestionVS Code Tracked

Métriques du dépôt

Stars
 (48 455 stars)
Métriques de merge PR
 (Merge moyen 6j 17h) (9 PRs mergées en 30 j)

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 contributeur

Direction de recherche
Examinez le fournisseur d'éléments de complétion pour les balises JSDoc, en particulier comment les paramètres sont triés. Modifiez le sortText pour prioriser les paramètres en fonction de leur ordre d'arguments dans la signature de la fonction.
Stack technique
typescript
Domaine
compilers
Type d'issue
Bug
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
GitNode.js
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75