Skip to content

feat(language-service): better sorting & filtering of completion #4671

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 8 commits into from
Aug 25, 2024
Merged

feat(language-service): better sorting & filtering of completion #4671

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
e31d4d7
fix: drop unnecessary completion of event
KazariEX Aug 8, 2024
1ef4dec
test: add
KazariEX Aug 9, 2024
e03f88e
Merge branch 'vuejs:master' into fix/issue-4670
KazariEX Aug 9, 2024
ff5444c
feat: better sorting & filtering of completion
KazariEX Aug 9, 2024
548133b
test: remove
KazariEX Aug 9, 2024
eca4dda
Merge branch 'master' into pr/4671
johnsoncodehk Aug 25, 2024
2ef6b53
Update completions.spec.ts
johnsoncodehk Aug 25, 2024
37e534e
Update vue-template.ts
johnsoncodehk Aug 25, 2024
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
17 changes: 17 additions & 0 deletions packages/language-server/tests/completions.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,23 @@ describe('Completions', async () => {
`);
});

it('#4670', async () => {
expect(
(await requestCompletionList('fixture.vue', 'vue', `<template><div click| /></template>`)).items.map(item => item.label).filter(label => label.includes('click'))
).toMatchInlineSnapshot(`
[
"onclick",
"ondblclick",
"v-on:auxclick",
"@auxclick",
"v-on:click",
"@click",
"v-on:dblclick",
"@dblclick",
]
`);
});

it('HTML tags and built-in components', async () => {
expect(
(await requestCompletionList('fixture.vue', 'vue', `<template><| /></template>`)).items.map(item => item.label)
Expand Down
164 changes: 116 additions & 48 deletions packages/language-service/lib/plugins/vue-template.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import type { Disposable, LanguageServiceContext, LanguageServicePluginInstance } from '@volar/language-service';
import { VueCompilerOptions, VueVirtualCode, hyphenateAttr, hyphenateTag, parseScriptSetupRanges, tsCodegen } from '@vue/language-core';
import { camelize, capitalize, hyphenate } from '@vue/shared';
import { camelize, capitalize } from '@vue/shared';
import { getComponentSpans } from '@vue/typescript-plugin/lib/common';
import { create as createHtmlService } from 'volar-service-html';
import { create as createPugService } from 'volar-service-pug';
Expand All @@ -12,10 +12,16 @@ import { getNameCasing } from '../ideFeatures/nameCasing';
import { AttrNameCasing, LanguageServicePlugin, TagNameCasing } from '../types';
import { loadModelModifiersData, loadTemplateData } from './data';

let builtInData: html.HTMLDataV1;
let modelData: html.HTMLDataV1;
type InternalItemId =
| 'componentEvent'
| 'componentProp'
| 'specialTag';

const specialTags = new Set(['slot', 'component', 'template']);
const specialProps = new Set(['class', 'is', 'key', 'ref', 'style']);

let builtInData: html.HTMLDataV1;
let modelData: html.HTMLDataV1;

export function create(
mode: 'html' | 'pug',
Expand Down Expand Up @@ -522,7 +528,6 @@ export function create(
attrs,
props: props.filter(prop =>
!prop.startsWith('ref_')
&& !hyphenate(prop).startsWith('on-vnode-')
),
events,
});
Expand Down Expand Up @@ -566,7 +571,9 @@ export function create(
const isGlobal = !propsSet.has(prop);
const name = casing.attr === AttrNameCasing.Camel ? prop : hyphenateAttr(prop);

if (hyphenateAttr(name).startsWith('on-')) {
const isEvent = hyphenateAttr(name).startsWith('on-');

if (isEvent) {

const propNameBase = name.startsWith('on-')
? name.slice('on-'.length)
Expand All @@ -584,7 +591,7 @@ export function create(
}
);
}
{
else {

const propName = name;
const propKey = createInternalItemId('componentProp', [isGlobal ? '*' : tag, propName]);
Expand All @@ -611,14 +618,16 @@ export function create(
const name = casing.attr === AttrNameCasing.Camel ? event : hyphenateAttr(event);
const propKey = createInternalItemId('componentEvent', [tag, name]);

attributes.push({
name: 'v-on:' + name,
description: propKey,
});
attributes.push({
name: '@' + name,
description: propKey,
});
attributes.push(
{
name: 'v-on:' + name,
description: propKey,
},
{
name: '@' + name,
description: propKey,
}
);
}

const models: [boolean, string][] = [];
Expand Down Expand Up @@ -765,70 +774,116 @@ export function create(
}

const itemIdKey = typeof item.documentation === 'string' ? item.documentation : item.documentation?.value;
const itemId = itemIdKey ? readInternalItemId(itemIdKey) : undefined;
let itemId = itemIdKey ? readInternalItemId(itemIdKey) : undefined;

if (itemId) {
let label = hyphenate(itemId.args[1]);
if (label.startsWith('on-')) {
label = 'on' + label.slice('on-'.length);
}
else if (itemId.type === 'componentEvent') {
label = 'on' + label;
let [isEvent, name] = tryGetEventName(itemId);
if (isEvent) {
name = 'on' + name;
}
const original = originals.get(label);
const original = originals.get(name);
item.documentation = original?.documentation;
}
else if (!originals.has(item.label)) {
originals.set(item.label, item);
else {
let name = item.label;
const isVBind = name.startsWith('v-bind:') ? (
name = name.slice('v-bind:'.length), true
) : false;
const isVBindAbbr = name.startsWith(':') && name !== ':' ? (
name = name.slice(':'.length), true
) : false;

/**
* for `is`, `key` and `ref` starting with `v-bind:` or `:`
* that without `internalItemId`.
*/
if (isVBind || isVBindAbbr) {
itemId = {
type: 'componentProp',
args: ['^', name]
};
}
else if (!originals.has(item.label)) {
originals.set(item.label, item);
}
}

const tokens: string[] = [];

if (item.kind === 10 satisfies typeof vscode.CompletionItemKind.Property && lastCompletionComponentNames.has(hyphenateTag(item.label))) {
item.kind = 6 satisfies typeof vscode.CompletionItemKind.Variable;
item.sortText = '\u0000' + (item.sortText ?? item.label);
tokens.push('\u0000');
}
else if (itemId && (itemId.type === 'componentProp' || itemId.type === 'componentEvent')) {
else if (itemId) {

const isComponent = itemId.args[0] !== '*';
const [isEvent, name] = tryGetEventName(itemId);

const [componentName] = itemId.args;
if (itemId.type === 'componentProp') {
if (isComponent || specialProps.has(name)) {
item.kind = 5 satisfies typeof vscode.CompletionItemKind.Field;
}
}
else if (isEvent) {
item.kind = 23 satisfies typeof vscode.CompletionItemKind.Event;
if (name.startsWith('vnode-')) {
tokens.push('\u0004');
}
}

if (componentName !== '*') {
if (
item.label === 'class'
|| item.label === 'ref'
|| item.label.endsWith(':class')
|| item.label.endsWith(':ref')
) {
item.sortText = '\u0000' + (item.sortText ?? item.label);
if (
isComponent
|| (isComponent && isEvent)
|| specialProps.has(name)
) {
tokens.push('\u0000');

if (item.label.startsWith(':')) {
tokens.push('\u0001');
}
else if (item.label.startsWith('@')) {
tokens.push('\u0002');
}
else if (item.label.startsWith('v-bind:')) {
tokens.push('\u0003');
}
else if (item.label.startsWith('v-on:')) {
tokens.push('\u0004');
}
else {
item.sortText = '\u0000\u0000' + (item.sortText ?? item.label);
tokens.push('\u0000');
}
}

if (itemId.type === 'componentProp') {
if (componentName !== '*') {
item.kind = 5 satisfies typeof vscode.CompletionItemKind.Field;
if (specialProps.has(name)) {
tokens.push('\u0001');
}
else {
tokens.push('\u0000');
}
}
else {
item.kind = componentName !== '*' ? 3 satisfies typeof vscode.CompletionItemKind.Function : 23 satisfies typeof vscode.CompletionItemKind.Event;
}
}
else if (specialProps.has(item.label)) {
item.kind = 5 satisfies typeof vscode.CompletionItemKind.Field;
tokens.push('\u0000', '\u0000', '\u0001');
}
else if (
item.label === 'v-if'
|| item.label === 'v-else-if'
|| item.label === 'v-else'
|| item.label === 'v-for'
) {
item.kind = 14 satisfies typeof vscode.CompletionItemKind.Keyword;
item.sortText = '\u0003' + (item.sortText ?? item.label);
tokens.push('\u0003');
}
else if (item.label.startsWith('v-')) {
item.kind = 3 satisfies typeof vscode.CompletionItemKind.Function;
item.sortText = '\u0002' + (item.sortText ?? item.label);
tokens.push('\u0002');
}
else {
item.sortText = '\u0001' + (item.sortText ?? item.label);
tokens.push('\u0001');
}

item.sortText = tokens.join('') + (item.sortText ?? item.label);
}

updateExtraCustomData([]);
Expand Down Expand Up @@ -888,7 +943,7 @@ export function create(
}
};

function createInternalItemId(type: 'componentEvent' | 'componentProp' | 'specialTag', args: string[]) {
function createInternalItemId(type: InternalItemId, args: string[]) {
return '__VLS_::' + type + '::' + args.join(',');
}

Expand All @@ -900,7 +955,7 @@ function readInternalItemId(key: string) {
if (isInternalItemId(key)) {
const strs = key.split('::');
return {
type: strs[1] as 'componentEvent' | 'componentProp' | 'specialTag',
type: strs[1] as InternalItemId,
args: strs[2].split(','),
};
}
Expand All @@ -917,3 +972,16 @@ function getReplacement(list: html.CompletionList, doc: TextDocument) {
}
}
}

function tryGetEventName(
itemId: ReturnType<typeof readInternalItemId> & {}
): [isEvent: boolean, name: string] {
const name = hyphenateAttr(itemId.args[1]);
if (name.startsWith('on-')) {
return [true, name.slice('on-'.length)];
}
else if (itemId.type === 'componentEvent') {
return [true, name];
}
return [false, name];
}