Skip to content

feat: array value completion from contributions #276

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: array value completion from contributions #276

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
24 changes: 24 additions & 0 deletions src/services/jsonCompletion.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -525,6 +525,30 @@ export class JSONCompletion {
}
});
} else {
if (
node.parent?.type === 'array' && node.parent?.parent?.type === 'property' &&
(node.type === 'string' || node.type === 'number' || node.type === 'boolean' || node.type === 'null')
) {
const path = Parser.getNodePath(node);
const location = path.slice(0, -2);
const propertyKey = path[path.length - 2].toString();
this.contributions.forEach((contribution) => {
const collectPromise = contribution.collectValueCompletions(document.uri, location, propertyKey, collector);
if (collectPromise) {
collectionPromises.push(collectPromise);
}
});
} else if (node.type === 'array' && node.parent?.type === 'property') {
const path = Parser.getNodePath(node);
const location = path.slice(0, -1);
const propertyKey = path[path.length - 1].toString();
this.contributions.forEach((contribution) => {
const collectPromise = contribution.collectValueCompletions(document.uri, location, propertyKey, collector);
if (collectPromise) {
collectionPromises.push(collectPromise);
}
});
}
if (node.type === 'string' || node.type === 'number' || node.type === 'boolean' || node.type === 'null') {
node = node.parent;
}
Expand Down
45 changes: 42 additions & 3 deletions src/test/completion.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

import * as assert from 'assert';

import { getLanguageService, JSONSchema, TextDocument, ClientCapabilities, CompletionList, CompletionItemKind, Position, MarkupContent, TextEdit } from '../jsonLanguageService';
import { getLanguageService, JSONSchema, TextDocument, ClientCapabilities, CompletionList, CompletionItemKind, Position, MarkupContent, TextEdit, JSONWorkerContribution } from '../jsonLanguageService';
import { repeat } from '../utils/strings';
import { CompletionItemLabelDetails } from 'vscode-languageserver-types';

Expand Down Expand Up @@ -55,11 +55,11 @@ const assertCompletion = function (completions: CompletionList, expected: ItemDe

suite('JSON Completion', () => {

const testCompletionsFor = function (value: string, schema: JSONSchema | null, expected: { count?: number, items?: ItemDescription[] }, clientCapabilities = ClientCapabilities.LATEST): PromiseLike<void> {
const testCompletionsFor = function (value: string, schema: JSONSchema | null, expected: { count?: number, items?: ItemDescription[] }, clientCapabilities = ClientCapabilities.LATEST, contributions?: JSONWorkerContribution[]): PromiseLike<void> {
const offset = value.indexOf('|');
value = value.substr(0, offset) + value.substr(offset + 1);

const ls = getLanguageService({ clientCapabilities });
const ls = getLanguageService({ clientCapabilities, contributions });
if (schema) {
ls.configure({
schemas: [{
Expand Down Expand Up @@ -594,6 +594,45 @@ suite('JSON Completion', () => {
});
});

test('Complete array value with contribution', async function () {

const contribution: JSONWorkerContribution = {
async getInfoContribution(uri, location) {
return [];
},
collectPropertyCompletions(uri, location, currentWord, addValue, isLast, result) {
return Promise.resolve();
},
async collectValueCompletions(uri, location, propertyKey, result) {
assert.deepEqual(location, ['a']);
assert.deepEqual(propertyKey, 'b')
result.add({ label: '"x"', insertText: '"x"' });
result.add({ label: '"y"', insertText: '"y"' });
},
collectDefaultCompletions(uri, result) {
return Promise.resolve();
}
};
await testCompletionsFor('{ "a": { "b": [ | ] } }', null, {
items: [
{ label: '"x"', resultText: '{ "a": { "b": [ "x" ] } }' },
{ label: '"y"', resultText: '{ "a": { "b": [ "y" ] } }' }
]
}, ClientCapabilities.LATEST, [contribution]);
await testCompletionsFor('{ "a": { "b": [ "z", | ] } }', null, {
items: [
{ label: '"x"', resultText: '{ "a": { "b": [ "z", "x" ] } }' },
{ label: '"y"', resultText: '{ "a": { "b": [ "z", "y" ] } }' }
]
}, ClientCapabilities.LATEST, [contribution]);
await testCompletionsFor('{ "a": { "b": [ "z", "|" ] } }', null, {
items: [
{ label: '"x"', resultText: '{ "a": { "b": [ "z", "x" ] } }' },
{ label: '"y"', resultText: '{ "a": { "b": [ "z", "y" ] } }' }
]
}, ClientCapabilities.LATEST, [contribution]);
});


test('Complete value with schema: booleans, null', async function () {

Expand Down