Skip to content

Commit a1be171

Browse files
p-spacekp-spacek
authored
fix: array item with existing property (#25)
* fix: array item with existing property * fix: some PR comments * chore: add another test and fix failing tests
1 parent a8bcc54 commit a1be171

File tree

3 files changed

+199
-23
lines changed

3 files changed

+199
-23
lines changed

‎src/languageservice/services/yamlCompletion.ts

+21-15
Original file line numberDiff line numberDiff line change
@@ -308,11 +308,11 @@ export class YamlCompletion {
308308

309309
this.arrayPrefixIndentation = '';
310310
let overwriteRange: Range = null;
311+
const isOnlyHyphen = lineContent.match(/^\s*(-)\s*($|#)/);
311312
if (areOnlySpacesAfterPosition) {
312313
overwriteRange = Range.create(position, Position.create(position.line, lineContent.length));
313314
const isOnlyWhitespace = lineContent.trim().length === 0;
314-
const isOnlyDash = lineContent.match(/^\s*(-)\s*$/);
315-
if (node && isScalar(node) && !isOnlyWhitespace && !isOnlyDash) {
315+
if (node && isScalar(node) && !isOnlyWhitespace && !isOnlyHyphen) {
316316
const lineToPosition = lineContent.substring(0, position.character);
317317
const matches =
318318
// get indentation of unfinished property (between indent and cursor)
@@ -522,6 +522,12 @@ export class YamlCompletion {
522522
if (node) {
523523
if (lineContent.length === 0) {
524524
node = currentDoc.internalDocument.contents as Node;
525+
} else if (isSeq(node) && isOnlyHyphen) {
526+
const index = this.findItemAtOffset(node, document, offset);
527+
const item = node.items[index];
528+
if (isNode(item)) {
529+
node = item;
530+
}
525531
} else {
526532
const parent = currentDoc.getParent(node);
527533
if (parent) {
@@ -886,19 +892,19 @@ export class YamlCompletion {
886892
const propertySchema = schemaProperties[key];
887893

888894
if (typeof propertySchema === 'object' && !propertySchema.deprecationMessage && !propertySchema.doNotSuggest) {
889-
let identCompensation = '';
895+
let indentCompensation = '';
890896
if (nodeParent && isSeq(nodeParent) && node.items.length <= 1 && !hasOnlyWhitespace) {
891-
// because there is a slash '-' to prevent the properties generated to have the correct
892-
// indent
893-
const sourceText = textBuffer.getText();
894-
const indexOfSlash = sourceText.lastIndexOf('-', node.range[0] - 1);
895-
if (indexOfSlash >= 0) {
896-
// add one space to compensate the '-'
897-
const overwriteChars = overwriteRange.end.character - overwriteRange.start.character;
898-
identCompensation = ' ' + sourceText.slice(indexOfSlash + 1, node.range[1] - overwriteChars);
897+
// because there is a slash '-' to prevent the properties generated to have the correct indent
898+
const fromLastHyphenToPosition = lineContent.slice(
899+
lineContent.lastIndexOf('-'),
900+
overwriteRange.start.character
901+
);
902+
const hyphenFollowedByEmpty = fromLastHyphenToPosition.match(/-([ \t]*)/);
903+
if (hyphenFollowedByEmpty) {
904+
indentCompensation = ' ' + hyphenFollowedByEmpty[1];
899905
}
900906
}
901-
identCompensation += this.arrayPrefixIndentation;
907+
indentCompensation += this.arrayPrefixIndentation;
902908

903909
// if check that current node has last pair with "null" value and key witch match key from schema,
904910
// and if schema has array definition it add completion item for array item creation
@@ -929,7 +935,7 @@ export class YamlCompletion {
929935
key,
930936
propertySchema,
931937
separatorAfter,
932-
identCompensation + this.indentation
938+
indentCompensation + this.indentation
933939
);
934940
}
935941
const isNodeNull =
@@ -956,13 +962,13 @@ export class YamlCompletion {
956962
key,
957963
propertySchema,
958964
separatorAfter,
959-
identCompensation + this.indentation
965+
indentCompensation + this.indentation
960966
),
961967
insertTextFormat: InsertTextFormat.Snippet,
962968
documentation: this.fromMarkup(propertySchema.markdownDescription) || propertySchema.description || '',
963969
parent: {
964970
schema: schema.schema,
965-
indent: identCompensation,
971+
indent: indentCompensation,
966972
},
967973
});
968974
}

‎test/autoCompletionFix.test.ts

+97
Original file line numberDiff line numberDiff line change
@@ -902,6 +902,30 @@ objB:
902902
})
903903
);
904904
});
905+
it('indent compensation for partial key with trailing spaces', async () => {
906+
const schema: JSONSchema = {
907+
type: 'object',
908+
properties: {
909+
array: {
910+
type: 'array',
911+
items: {
912+
type: 'object',
913+
properties: {
914+
obj1: {
915+
type: 'object',
916+
},
917+
},
918+
},
919+
},
920+
},
921+
};
922+
schemaProvider.addSchema(SCHEMA_ID, schema);
923+
const content = 'array:\n - obj| | ';
924+
const completion = await parseCaret(content);
925+
926+
expect(completion.items.length).equal(1);
927+
expect(completion.items[0].insertText).eql('obj1:\n ');
928+
});
905929

906930
describe('partial value with trailing spaces', () => {
907931
it('partial value with trailing spaces', async () => {
@@ -1122,6 +1146,41 @@ objB:
11221146
expect(result.items.length).to.be.equal(1);
11231147
expect(result.items[0].insertText).to.be.equal('objA:\n itemA: ');
11241148
});
1149+
1150+
it('array completion - should suggest correct indent when extra spaces after cursor followed by with different array item', async () => {
1151+
schemaProvider.addSchema(SCHEMA_ID, {
1152+
type: 'object',
1153+
properties: {
1154+
test: {
1155+
type: 'array',
1156+
items: {
1157+
type: 'object',
1158+
properties: {
1159+
objA: {
1160+
type: 'object',
1161+
required: ['itemA'],
1162+
properties: {
1163+
itemA: {
1164+
type: 'string',
1165+
},
1166+
},
1167+
},
1168+
},
1169+
},
1170+
},
1171+
},
1172+
});
1173+
const content = `
1174+
test:
1175+
- | |
1176+
- objA:
1177+
itemA: test`;
1178+
const result = await parseCaret(content);
1179+
1180+
expect(result.items.length).to.be.equal(1);
1181+
expect(result.items[0].insertText).to.be.equal('objA:\n itemA: ');
1182+
});
1183+
11251184
it('array of arrays completion - should suggest correct indent when extra spaces after cursor', async () => {
11261185
schemaProvider.addSchema(SCHEMA_ID, {
11271186
type: 'object',
@@ -1198,6 +1257,44 @@ objB:
11981257
expect(result.items.length).to.be.equal(1);
11991258
expect(result.items[0].insertText).to.be.equal('objA:\n itemA: ');
12001259
});
1260+
1261+
describe('array item with existing property', () => {
1262+
const schema: JSONSchema = {
1263+
type: 'object',
1264+
properties: {
1265+
array1: {
1266+
type: 'array',
1267+
items: {
1268+
type: 'object',
1269+
properties: {
1270+
objA: {
1271+
type: 'object',
1272+
},
1273+
propB: {
1274+
const: 'test',
1275+
},
1276+
},
1277+
},
1278+
},
1279+
},
1280+
};
1281+
it('should get extra space compensation for the 1st prop in array object item', async () => {
1282+
schemaProvider.addSchema(SCHEMA_ID, schema);
1283+
const content = 'array1:\n - |\n| propB: test';
1284+
const result = await parseCaret(content);
1285+
1286+
expect(result.items.length).to.be.equal(1);
1287+
expect(result.items[0].insertText).to.be.equal('objA:\n ');
1288+
});
1289+
it('should get extra space compensation for the 1st prop in array object item - extra spaces', async () => {
1290+
schemaProvider.addSchema(SCHEMA_ID, schema);
1291+
const content = 'array1:\n - | | \n propB: test';
1292+
const result = await parseCaret(content);
1293+
1294+
expect(result.items.length).to.be.equal(1);
1295+
expect(result.items[0].insertText).to.be.equal('objA:\n ');
1296+
});
1297+
});
12011298
}); //'extra space after cursor'
12021299

12031300
it('should suggest from additionalProperties', async () => {

‎test/yaml-documents.test.ts

+81-8
Original file line numberDiff line numberDiff line change
@@ -211,16 +211,89 @@ objB:
211211
expect(((result as YAMLMap).items[0].key as Scalar).value).eqls('bar');
212212
});
213213

214-
it('Find closes node: array', () => {
215-
const doc = setupTextDocument('foo:\n - bar: aaa\n ');
216-
const yamlDoc = documents.getYamlDocument(doc);
217-
const textBuffer = new TextBuffer(doc);
214+
describe('Array', () => {
215+
// Problem in `getNodeFromPosition` function. This method doesn't give proper results for arrays
216+
// for example, this yaml return nodes:
217+
// foo:
218+
// - # foo object is returned (should be foo[0])
219+
// # foo object is returned (should be foo[0])
220+
// item1: aaaf
221+
// # foo[0] object is returned (OK)
222+
// - # foo object is returned (should be foo[1])
223+
// # foo[!!0!!] object is returned (should be foo[1])
224+
// item2: bbb
225+
// # foo[1] object is returned (OK)
226+
227+
it('Find closes node: array', () => {
228+
const doc = setupTextDocument('foo:\n - bar: aaa\n ');
229+
const yamlDoc = documents.getYamlDocument(doc);
230+
const textBuffer = new TextBuffer(doc);
231+
232+
const result = yamlDoc.documents[0].findClosestNode(20, textBuffer);
233+
234+
expect(result).is.not.undefined;
235+
expect(isSeq(result)).is.true;
236+
expect((((result as YAMLSeq).items[0] as YAMLMap).items[0].key as Scalar).value).eqls('bar');
237+
});
238+
it.skip('Find first array item node', () => {
239+
const doc = setupTextDocument(`foo:
240+
-
241+
item1: aaa
242+
`);
243+
const yamlDoc = documents.getYamlDocument(doc);
244+
const textBuffer = new TextBuffer(doc);
245+
246+
const result = yamlDoc.documents[0].findClosestNode(9, textBuffer);
247+
248+
expect(result).is.not.undefined;
249+
expect(isMap(result)).is.true;
250+
expect(((result as YAMLMap).items[0].key as Scalar).value).eqls('item1');
251+
});
252+
it.skip('Find first array item node - extra indent', () => {
253+
const doc = setupTextDocument(`foo:
254+
-
255+
256+
item1: aaa
257+
`);
258+
const yamlDoc = documents.getYamlDocument(doc);
259+
const textBuffer = new TextBuffer(doc);
260+
261+
const result = yamlDoc.documents[0].findClosestNode(9, textBuffer);
262+
263+
expect(result).is.not.undefined;
264+
expect(isMap(result)).is.true;
265+
expect(((result as YAMLMap).items[0].key as Scalar).value).eqls('item1');
266+
});
267+
268+
it.skip('Find second array item node', () => {
269+
const doc = setupTextDocument(`foo:
270+
- item1: aaa
271+
-
272+
item2: bbb`);
273+
const yamlDoc = documents.getYamlDocument(doc);
274+
const textBuffer = new TextBuffer(doc);
275+
276+
const result = yamlDoc.documents[0].findClosestNode(24, textBuffer);
277+
278+
expect(result).is.not.undefined;
279+
expect(isMap(result)).is.true;
280+
expect(((result as YAMLMap).items[0].key as Scalar).value).eqls('item2');
281+
});
282+
it.skip('Find second array item node: - extra indent', () => {
283+
const doc = setupTextDocument(`foo:
284+
- item1: aaa
285+
-
286+
287+
item2: bbb`);
288+
const yamlDoc = documents.getYamlDocument(doc);
289+
const textBuffer = new TextBuffer(doc);
218290

219-
const result = yamlDoc.documents[0].findClosestNode(20, textBuffer);
291+
const result = yamlDoc.documents[0].findClosestNode(28, textBuffer);
220292

221-
expect(result).is.not.undefined;
222-
expect(isSeq(result)).is.true;
223-
expect((((result as YAMLSeq).items[0] as YAMLMap).items[0].key as Scalar).value).eqls('bar');
293+
expect(result).is.not.undefined;
294+
expect(isMap(result)).is.true;
295+
expect(((result as YAMLMap).items[0].key as Scalar).value).eqls('item2');
296+
});
224297
});
225298

226299
it('Find closes node: root map', () => {

0 commit comments

Comments
 (0)