Skip to content

Generalize special case lookup to all indexer properties #642

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gewarren merged 4 commits into from
Mar 25, 2026
+80 −24
Merged

Generalize special case lookup to all indexer properties #642

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
92033c9
generalize to all indexer properties
gewarren Mar 19, 2026
0cbdc8e
undo unrelated change
gewarren Mar 19, 2026
45db524
remove unnecessary change
gewarren Mar 20, 2026
516ffa6
Merge branch 'main' into indexers
gewarren Mar 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified xref-helper/dist/xref-helper.vsix
View file
Open in desktop
Binary file not shown.
87 changes: 72 additions & 15 deletions xref-helper/package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions xref-helper/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "xref-helper",
"displayName": "API Reference Link Helper",
"description": "A Visual Studio Code extension to help you quickly insert API reference (xref) links.",
"version": "1.0.30",
"version": "1.0.40",
"engines": {
"vscode": "^1.102.0"
},
Expand Down Expand Up @@ -187,7 +187,7 @@
"eslint": "^9.31.0",
"glob": "^11.1.0",
"mocha": "^11.7.1",
"rimraf": "^6.0.1",
"rimraf": "^6.1.3",
"semantic-release": "^25.0.2",
"semantic-release-stop-before-publish": "^1.0.0",
"semantic-release-vsce": "^6.0.11",
Expand Down
13 changes: 6 additions & 7 deletions xref-helper/src/services/docid-service.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,17 +172,16 @@ async function parseXml(text: string, displayName: string, apiType: ItemType, gi
apiType === ItemType.event || apiType === ItemType.attachedEvent ||
apiType === ItemType.field) {

// Special case for "Item" property (which is actually
// an indexer, not a property. Go figure.)
// The displayName is "Item[String]" or "Item[Int32]" etc.,
// but in the ECMAXML, the MemberName is just "Item".
// And, this "property" also has parameter(s)!
if (memberName.split('[')[0] === "Item") {
// Special case for indexer properties (e.g. "Item[String]", "Chars[Int32]").
// The displayName includes parameters in square brackets,
// but in the ECMAXML, the MemberName doesn't include the brackets/params.
if (memberName.includes('[')) {
const baseName = memberName.split('[')[0];
const paramList = memberName.split('[')[1].slice(0, -1);
const paramTypes = paramList.length > 0 ? paramList.split(',').map(x => x.trim().split(' ')[0]) : [];

const candidates = xml.Type.Members[0].Member?.filter((x: any) =>
x.$.MemberName === "Item" &&
x.$.MemberName === baseName &&
x.MemberType[0] === memberType &&
x.Parameters[0].Parameter?.length === paramTypes.length
);
Expand Down
Loading