add more information to quickinfo for imported symbols #19489
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jwbay
force-pushed
the
import-quickinfo
branch
from
ea0d56d to
9aaa6d2
Compare
|
@DanielRosenwasser and @bowdenk7 can i get your input on this? |
jwbay
force-pushed
the
import-quickinfo
branch
2 times, most recently
from
27f02d9 to
d268886
Compare
jwbay
commented
Nov 4, 2017
| verify.baselineQuickInfo(); |
There was a problem hiding this comment.
This test was a bit difficult to decipher, so I swapped it for a baseline. Hope that's alright. If it helps, this is the diff for it against master.
diff --git a/tests/baselines/reference/quickInfoDisplayPartsInternalModuleAlias.baseline b/tests/baselines/reference/quickInfoDisplayPartsInternalModuleAlias.baseline
index 6c2047f..c476aba 100644
--- a/tests/baselines/reference/quickInfoDisplayPartsInternalModuleAlias.baseline
+++ b/tests/baselines/reference/quickInfoDisplayPartsInternalModuleAlias.baseline
@@ -1,434 +1,722 @@
[
{
"marker": {
"fileName": "/tests/cases/fourslash/quickInfoDisplayPartsInternalModuleAlias.ts",
"position": 66
},
"quickInfo": {
"kind": "alias",
"kindModifiers": "",
"textSpan": {
"start": 66,
"length": 2
},
"displayParts": [
{
+ "text": "(",
+ "kind": "punctuation"
+ },
+ {
+ "text": "alias",
+ "kind": "text"
+ },
+ {
+ "text": ")",
+ "kind": "punctuation"
+ },
+ {
+ "text": " ",
+ "kind": "space"
+ },
+ {
+ "text": "namespace",
+ "kind": "keyword"
+ },
+ {
+ "text": " ",
+ "kind": "space"
+ },
+ {
+ "text": "a1",
+ "kind": "aliasName"
+ },
+ {
+ "text": "\n",
+ "kind": "lineBreak"
+ },
+ {
"text": "import",
"kind": "keyword"
},
{
"text": " ",
"kind": "space"
},
{
"text": "a1",
"kind": "aliasName"
},
{
"text": " ",
"kind": "space"
},
{
"text": "=",
"kind": "operator"
},
{
"text": " ",
"kind": "space"
},
{
"text": "m",
"kind": "moduleName"
}
],
"documentation": [],
"tags": []
}
},
{
"marker": {
"fileName": "/tests/cases/fourslash/quickInfoDisplayPartsInternalModuleAlias.ts",
"position": 82
},
"quickInfo": {
"kind": "alias",
"kindModifiers": "",
"textSpan": {
"start": 82,
"length": 2
},
"displayParts": [
{
+ "text": "(",
+ "kind": "punctuation"
+ },
+ {
+ "text": "alias",
+ "kind": "text"
+ },
+ {
+ "text": ")",
+ "kind": "punctuation"
+ },
+ {
+ "text": " ",
+ "kind": "space"
+ },
+ {
+ "text": "namespace",
+ "kind": "keyword"
+ },
+ {
+ "text": " ",
+ "kind": "space"
+ },
+ {
+ "text": "a1",
+ "kind": "aliasName"
+ },
+ {
+ "text": "\n",
+ "kind": "lineBreak"
+ },
+ {
"text": "import",
"kind": "keyword"
},
{
"text": " ",
"kind": "space"
},
{
"text": "a1",
"kind": "aliasName"
},
{
"text": " ",
"kind": "space"
},
{
"text": "=",
"kind": "operator"
},
{
"text": " ",
"kind": "space"
},
{
"text": "m",
"kind": "moduleName"
}
],
"documentation": [],
"tags": []
}
},
{
"marker": {
"fileName": "/tests/cases/fourslash/quickInfoDisplayPartsInternalModuleAlias.ts",
"position": 104
},
"quickInfo": {
"kind": "alias",
"kindModifiers": "",
"textSpan": {
"start": 104,
"length": 2
},
"displayParts": [
{
+ "text": "(",
+ "kind": "punctuation"
+ },
+ {
+ "text": "alias",
+ "kind": "text"
+ },
+ {
+ "text": ")",
+ "kind": "punctuation"
+ },
+ {
+ "text": " ",
+ "kind": "space"
+ },
+ {
+ "text": "namespace",
+ "kind": "keyword"
+ },
+ {
+ "text": " ",
+ "kind": "space"
+ },
+ {
+ "text": "a2",
+ "kind": "aliasName"
+ },
+ {
+ "text": "\n",
+ "kind": "lineBreak"
+ },
+ {
"text": "import",
"kind": "keyword"
},
{
"text": " ",
"kind": "space"
},
{
"text": "a2",
"kind": "aliasName"
},
{
"text": " ",
"kind": "space"
},
{
"text": "=",
"kind": "operator"
},
{
"text": " ",
"kind": "space"
},
{
"text": "m",
"kind": "moduleName"
},
{
"text": ".",
"kind": "punctuation"
},
{
"text": "m1",
"kind": "moduleName"
}
],
"documentation": [],
"tags": []
}
},
{
"marker": {
"fileName": "/tests/cases/fourslash/quickInfoDisplayPartsInternalModuleAlias.ts",
"position": 123
},
"quickInfo": {
"kind": "alias",
"kindModifiers": "",
"textSpan": {
"start": 123,
"length": 2
},
"displayParts": [
{
+ "text": "(",
+ "kind": "punctuation"
+ },
+ {
+ "text": "alias",
+ "kind": "text"
+ },
+ {
+ "text": ")",
+ "kind": "punctuation"
+ },
+ {
+ "text": " ",
+ "kind": "space"
+ },
+ {
+ "text": "namespace",
+ "kind": "keyword"
+ },
+ {
+ "text": " ",
+ "kind": "space"
+ },
+ {
+ "text": "a2",
+ "kind": "aliasName"
+ },
+ {
+ "text": "\n",
+ "kind": "lineBreak"
+ },
+ {
"text": "import",
"kind": "keyword"
},
{
"text": " ",
"kind": "space"
},
{
"text": "a2",
"kind": "aliasName"
},
{
"text": " ",
"kind": "space"
},
{
"text": "=",
"kind": "operator"
},
{
"text": " ",
"kind": "space"
},
{
"text": "m",
"kind": "moduleName"
},
{
"text": ".",
"kind": "punctuation"
},
{
"text": "m1",
"kind": "moduleName"
}
],
"documentation": [],
"tags": []
}
},
{
"marker": {
"fileName": "/tests/cases/fourslash/quickInfoDisplayPartsInternalModuleAlias.ts",
"position": 149
},
"quickInfo": {
"kind": "alias",
"kindModifiers": "export",
"textSpan": {
"start": 149,
"length": 2
},
"displayParts": [
{
+ "text": "(",
+ "kind": "punctuation"
+ },
+ {
+ "text": "alias",
+ "kind": "text"
+ },
+ {
+ "text": ")",
+ "kind": "punctuation"
+ },
+ {
+ "text": " ",
+ "kind": "space"
+ },
+ {
+ "text": "namespace",
+ "kind": "keyword"
+ },
+ {
+ "text": " ",
+ "kind": "space"
+ },
+ {
+ "text": "m2",
+ "kind": "moduleName"
+ },
+ {
+ "text": ".",
+ "kind": "punctuation"
+ },
+ {
+ "text": "a3",
+ "kind": "aliasName"
+ },
+ {
+ "text": "\n",
+ "kind": "lineBreak"
+ },
+ {
"text": "import",
"kind": "keyword"
},
{
"text": " ",
"kind": "space"
},
{
"text": "m2",
"kind": "moduleName"
},
{
"text": ".",
"kind": "punctuation"
},
{
"text": "a3",
"kind": "aliasName"
},
{
"text": " ",
"kind": "space"
},
{
"text": "=",
"kind": "operator"
},
{
"text": " ",
"kind": "space"
},
{
"text": "m",
"kind": "moduleName"
}
],
"documentation": [],
"tags": []
}
},
{
"marker": {
"fileName": "/tests/cases/fourslash/quickInfoDisplayPartsInternalModuleAlias.ts",
"position": 165
},
"quickInfo": {
"kind": "alias",
"kindModifiers": "export",
"textSpan": {
"start": 165,
"length": 2
},
"displayParts": [
{
+ "text": "(",
+ "kind": "punctuation"
+ },
+ {
+ "text": "alias",
+ "kind": "text"
+ },
+ {
+ "text": ")",
+ "kind": "punctuation"
+ },
+ {
+ "text": " ",
+ "kind": "space"
+ },
+ {
+ "text": "namespace",
+ "kind": "keyword"
+ },
+ {
+ "text": " ",
+ "kind": "space"
+ },
+ {
+ "text": "m2",
+ "kind": "moduleName"
+ },
+ {
+ "text": ".",
+ "kind": "punctuation"
+ },
+ {
+ "text": "a3",
+ "kind": "aliasName"
+ },
+ {
+ "text": "\n",
+ "kind": "lineBreak"
+ },
+ {
"text": "import",
"kind": "keyword"
},
{
"text": " ",
"kind": "space"
},
{
"text": "m2",
"kind": "moduleName"
},
{
"text": ".",
"kind": "punctuation"
},
{
"text": "a3",
"kind": "aliasName"
},
{
"text": " ",
"kind": "space"
},
{
"text": "=",
"kind": "operator"
},
{
"text": " ",
"kind": "space"
},
{
"text": "m",
"kind": "moduleName"
}
],
"documentation": [],
"tags": []
}
},
{
"marker": {
"fileName": "/tests/cases/fourslash/quickInfoDisplayPartsInternalModuleAlias.ts",
"position": 194
},
"quickInfo": {
"kind": "alias",
"kindModifiers": "export",
"textSpan": {
"start": 194,
"length": 2
},
"displayParts": [
{
+ "text": "(",
+ "kind": "punctuation"
+ },
+ {
+ "text": "alias",
+ "kind": "text"
+ },
+ {
+ "text": ")",
+ "kind": "punctuation"
+ },
+ {
+ "text": " ",
+ "kind": "space"
+ },
+ {
+ "text": "namespace",
+ "kind": "keyword"
+ },
+ {
+ "text": " ",
+ "kind": "space"
+ },
+ {
+ "text": "m2",
+ "kind": "moduleName"
+ },
+ {
+ "text": ".",
+ "kind": "punctuation"
+ },
+ {
+ "text": "a4",
+ "kind": "aliasName"
+ },
+ {
+ "text": "\n",
+ "kind": "lineBreak"
+ },
+ {
"text": "import",
"kind": "keyword"
},
{
"text": " ",
"kind": "space"
},
{
"text": "m2",
"kind": "moduleName"
},
{
"text": ".",
"kind": "punctuation"
},
{
"text": "a4",
"kind": "aliasName"
},
{
"text": " ",
"kind": "space"
},
{
"text": "=",
"kind": "operator"
},
{
"text": " ",
"kind": "space"
},
{
"text": "m",
"kind": "moduleName"
},
{
"text": ".",
"kind": "punctuation"
},
{
"text": "m1",
"kind": "moduleName"
}
],
"documentation": [],
"tags": []
}
},
{
"marker": {
"fileName": "/tests/cases/fourslash/quickInfoDisplayPartsInternalModuleAlias.ts",
"position": 213
},
"quickInfo": {
"kind": "alias",
"kindModifiers": "export",
"textSpan": {
"start": 213,
"length": 2
},
"displayParts": [
{
+ "text": "(",
+ "kind": "punctuation"
+ },
+ {
+ "text": "alias",
+ "kind": "text"
+ },
+ {
+ "text": ")",
+ "kind": "punctuation"
+ },
+ {
+ "text": " ",
+ "kind": "space"
+ },
+ {
+ "text": "namespace",
+ "kind": "keyword"
+ },
+ {
+ "text": " ",
+ "kind": "space"
+ },
+ {
+ "text": "m2",
+ "kind": "moduleName"
+ },
+ {
+ "text": ".",
+ "kind": "punctuation"
+ },
+ {
+ "text": "a4",
+ "kind": "aliasName"
+ },
+ {
+ "text": "\n",
+ "kind": "lineBreak"
+ },
+ {
"text": "import",
"kind": "keyword"
},
{
"text": " ",
"kind": "space"
},
{
"text": "m2",
"kind": "moduleName"
},
{
"text": ".",
"kind": "punctuation"
},
{
"text": "a4",
"kind": "aliasName"
},
{
"text": " ",
"kind": "space"
},
{
"text": "=",
"kind": "operator"
},
{
"text": " ",
"kind": "space"
},
{
"text": "m",
"kind": "moduleName"
},
{
"text": ".",
"kind": "punctuation"
},
{
"text": "m1",
"kind": "moduleName"
}
],
"documentation": [],
"tags": []
}
}
]
jwbay
force-pushed
the
import-quickinfo
branch
from
d268886 to
c5dd7e6
Compare
|
Sorry for the delay! I think it's an improvement, but I could see where it'd go wrong for much more complex types. That said, I don't think that should block the change. |
|
👍 from me |
jwbay
force-pushed
the
import-quickinfo
branch
from
c5dd7e6 to
00faeac
Compare
jwbay
force-pushed
the
import-quickinfo
branch
from
00faeac to
56fc112
Compare
|
@jwbay sorry for the delay. can you please refresh the PR, and address the failing CI test? |
|
merged manually. thanks. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #5515
I took the approach here, more or less -- #5515 (comment). We basically print out the root symbol meanings above the import, but with the alias name where it makes sense.
The result:
I tried to follow prior art on how things are displayed. This is the current behavior in master for quickinfo on a resolved signature of an imported alias.
