microsoft / microsoft/TypeScript
Include Default Parameter Values in Signature Help
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 132
Description
From https://github.com/Microsoft/vscode/issues/28925
TypeScript Version: 2.4.0
Feature Request
signatureHelp current shows when a parameter is optional but does not include any information about that parameter's default value:
function foo(x = 10) { }
foo(|)
Result of TSServer signatureHelp on foo
[Trace - 5:42:22 PM] Response received: signatureHelp (378). Request took 20 ms. Success: true
Result: {
"items": [
{
"isVariadic": false,
"prefixDisplayParts": [
{
"text": "foo",
"kind": "functionName"
},
{
"text": "(",
"kind": "punctuation"
}
],
"suffixDisplayParts": [
{
"text": ")",
"kind": "punctuation"
},
{
"text": ":",
"kind": "punctuation"
},
{
"text": " ",
"kind": "space"
},
{
"text": "void",
"kind": "keyword"
}
],
"separatorDisplayParts": [
{
"text": ",",
"kind": "punctuation"
},
{
"text": " ",
"kind": "space"
}
],
"parameters": [
{
"name": "x",
"documentation": [],
"displayParts": [
{
"text": "x",
"kind": "parameterName"
},
{
"text": "?",
"kind": "punctuation"
},
{
"text": ":",
"kind": "punctuation"
},
{
"text": " ",
"kind": "space"
},
{
"text": "number",
"kind": "keyword"
}
],
"isOptional": true
}
],
"documentation": [],
"tags": []
}
],
"applicableSpan": {
"start": {
"line": 3,
"offset": 5
},
"end": {
"line": 3,
"offset": 5
}
},
"selectedItemIndex": 0,
"argumentIndex": 0,
"argumentCount": 0
}
When the default value is a simple literal type, it would be helpful to display this default value in the signature help. This information could be included in the displayParts response
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the TSServer signatureHelp response shown in the issue and trace the signature-help implementation in the TypeScript language service. Confirm how parameter displayParts are assembled, then make the simple default-value case appear in that response and verify the resulting signature help against the foo example.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100