Skip to content

feat(typescript-plugin): allow triggering file references on <template> #5734

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
merged 1 commit into from
Nov 2, 2025
Merged

feat(typescript-plugin): allow triggering file references on <template> #5734

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
93 changes: 79 additions & 14 deletions packages/typescript-plugin/lib/common.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,16 @@ export function createVueLanguageServiceProxy<T>(
const proxyCache = new Map<string | symbol, Function | undefined>();
const getProxyMethod = (target: ts.LanguageService, p: string | symbol): Function | undefined => {
switch (p) {
case 'findReferences':
return findReferences(ts, language, languageService, asScriptId, target[p]);
case 'getCompletionsAtPosition':
return getCompletionsAtPosition(ts, language, asScriptId, vueOptions, target[p]);
case 'getCompletionEntryDetails':
return getCompletionEntryDetails(language, target[p]);
case 'getCodeFixesAtPosition':
return getCodeFixesAtPosition(target[p]);
case 'getDefinitionAndBoundSpan':
return getDefinitionAndBoundSpan(language, asScriptId, target[p]);
return getDefinitionAndBoundSpan(ts, language, asScriptId, target[p]);
}
};

Expand All @@ -42,6 +44,56 @@ export function createVueLanguageServiceProxy<T>(
});
}

function findReferences<T>(
ts: typeof import('typescript'),
language: Language<T>,
languageService: ts.LanguageService,
asScriptId: (fileName: string) => T,
findReferences: ts.LanguageService['findReferences'],
): ts.LanguageService['findReferences'] {
return (fileName, position) => {
const result = findReferences(fileName, position);

const sourceScript = language.scripts.get(asScriptId(fileName));
const root = sourceScript?.generated?.root;
if (!(root instanceof VueVirtualCode)) {
return result;
}

const { template } = root.sfc;
if (template) {
const textSpan = {
start: template.start + 1,
length: 'template'.length,
};
if (position >= textSpan.start && position <= textSpan.start + textSpan.length) {
result?.push({
definition: {
fileName,
textSpan,
kind: ts.ScriptElementKind.scriptElement,
name: fileName,
containerKind: ts.ScriptElementKind.unknown,
containerName: '',
displayParts: [],
},
references: [
{
fileName,
textSpan,
isDefinition: true,
isWriteAccess: false,
},
...languageService.getFileReferences(fileName),
],
});
}
}

return result;
};
}

function getCompletionsAtPosition<T>(
ts: typeof import('typescript'),
language: Language<T>,
Expand Down Expand Up @@ -190,24 +242,42 @@ function getCodeFixesAtPosition(
}

function getDefinitionAndBoundSpan<T>(
ts: typeof import('typescript'),
language: Language<T>,
asScriptId: (fileName: string) => T,
getDefinitionAndBoundSpan: ts.LanguageService['getDefinitionAndBoundSpan'],
): ts.LanguageService['getDefinitionAndBoundSpan'] {
return (fileName, position) => {
const result = getDefinitionAndBoundSpan(fileName, position);
if (!result?.definitions?.length) {
return result;
}

const sourceScript = language.scripts.get(asScriptId(fileName));
if (!sourceScript?.generated) {
const root = sourceScript?.generated?.root;
if (!(root instanceof VueVirtualCode)) {
return result;
}

const root = sourceScript.generated.root;
if (!(root instanceof VueVirtualCode)) {
return result;
if (!result?.definitions?.length) {
const { template } = root.sfc;
if (template) {
const textSpan = {
start: template.start + 1,
length: 'template'.length,
};
if (position >= textSpan.start && position <= textSpan.start + textSpan.length) {
return {
textSpan,
definitions: [{
fileName,
textSpan,
kind: ts.ScriptElementKind.scriptElement,
name: fileName,
containerKind: ts.ScriptElementKind.unknown,
containerName: '',
}],
};
}
}
return;
}

if (
Expand All @@ -219,7 +289,6 @@ function getDefinitionAndBoundSpan<T>(
}

const definitions = new Set<ts.DefinitionInfo>(result.definitions);
const skippedDefinitions: ts.DefinitionInfo[] = [];

// #5275
if (result.definitions.length >= 2) {
Expand All @@ -228,15 +297,11 @@ function getDefinitionAndBoundSpan<T>(
root.sfc.content[definition.textSpan.start - 1] === '@'
|| root.sfc.content.slice(definition.textSpan.start - 5, definition.textSpan.start) === 'v-on:'
) {
skippedDefinitions.push(definition);
definitions.delete(definition);
}
}
}

for (const definition of skippedDefinitions) {
definitions.delete(definition);
}

return {
definitions: [...definitions],
textSpan: result.textSpan,
Expand Down
Loading