microsoft / microsoft/TypeScript
Sort jsdoc parameter suggestions by argument position
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Go
- Estrellas
- 111k
- Forks
- 14.3k
- Merge medio
- 2 d 4 h
- PR fusionados (30 d)
- 132
Descripción
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"
}
]
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Comienza con el punto de entrada de completado del language service de TypeScript para las sugerencias de JSDoc @param y reproduce el ejemplo con function foo(z, a). Ajusta el orden de completado para que los parámetros sigan la posición de los argumentos; después, verifica que z se devuelva antes que a y que sortText refleje este orden.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- typescript
- Área
- tooling
- Tipo de issue
- Error
- Dificultad
- 2/5
- Tiempo estimado
- 1-3 horas
- Estado de actividad
- Activo
- Claridad
- Bien especificado
- Aptitud para principiantes
- 72/100