Merge pull request #697 from p-spacek/fix/completion-array-in-the-middle-of-the-empty-text

fix array completion in the middle of the empty text

Author: msivasubramaniaan

src/languageservice/services/yamlCompletion.ts

@@ -324,8 +324,20 @@ export class YamlCompletion {
         }
       }
 
-      const originalNode = node;
+      let originalNode = node;
       if (node) {
+        // when the array item value is null but the cursor is between '-' and null value (cursor is not at the end of the line)
+        if (isSeq(node) && node.items.length && isScalar(node.items[0]) && lineContent.includes('-')) {
+          const nullNode = node.items[0];
+          if (
+            nullNode.value === null && // value is null
+            nullNode.range[0] > offset // cursor is before null
+          ) {
+            node = nullNode;
+            originalNode = node;
+            overwriteRange.end.character += nullNode.range[2] - offset; // extend range to the end of the null element
+          }
+        }
         if (lineContent.length === 0) {
           node = currentDoc.internalDocument.contents as Node;
         } else {
@@ -642,7 +654,8 @@ export class YamlCompletion {
                     const indexOfSlash = sourceText.lastIndexOf('-', node.range[0] - 1);
                     if (indexOfSlash >= 0) {
                       // add one space to compensate the '-'
-                      identCompensation = ' ' + sourceText.slice(indexOfSlash + 1, node.range[0]);
+                      const overwriteChars = overwriteRange.end.character - overwriteRange.start.character;
+                      identCompensation = ' ' + sourceText.slice(indexOfSlash + 1, node.range[1] - overwriteChars);
                     }
                   }
                   identCompensation += this.arrayPrefixIndentation;

test/autoCompletion.test.ts

@@ -2366,10 +2366,44 @@ describe('Auto Completion Tests', () => {
       });
 
       const content = 'test:\n  - and\n  - - ';
-      const completion = await parseSetup(content, 19);
+
+      const completion = await parseSetup(content, 20);
+      expect(completion.items).lengthOf(1);
+      expect(completion.items[0]).eql(
+        createExpectedCompletion('and', 'and', 2, 6, 2, 6, 12, InsertTextFormat.Snippet, { documentation: undefined })
+      );
+    });
+
+    it('should follow $ref in additionalItems: extra space after cursor', async () => {
+      languageService.addSchema(SCHEMA_ID, {
+        type: 'object',
+        properties: {
+          test: {
+            $ref: '#/definitions/Recur',
+          },
+        },
+        definitions: {
+          Recur: {
+            type: 'array',
+            items: [
+              {
+                type: 'string',
+                enum: ['and'],
+              },
+            ],
+            additionalItems: {
+              $ref: '#/definitions/Recur',
+            },
+          },
+        },
+      });
+
+      const content = 'test:\n  - and\n  - -   ';
+
+      const completion = await parseSetup(content, 20);
       expect(completion.items).lengthOf(1);
       expect(completion.items[0]).eql(
-        createExpectedCompletion('and', 'and', 2, 4, 2, 5, 12, InsertTextFormat.Snippet, { documentation: undefined })
+        createExpectedCompletion('and', 'and', 2, 6, 2, 8, 12, InsertTextFormat.Snippet, { documentation: undefined })
       );
     });
 
@@ -2512,6 +2546,19 @@ describe('Auto Completion Tests', () => {
         .then(done, done);
     });
 
+    it('Simple array object completion without "-" befor array empty item', (done) => {
+      const schema = require(path.join(__dirname, './fixtures/testArrayCompletionSchema.json'));
+      languageService.addSchema(SCHEMA_ID, schema);
+      const content = 'test_simpleArrayObject:\n  \n  -';
+      const completion = parseSetup(content, 'test_simpleArrayObject:\n  '.length);
+      completion
+        .then(function (result) {
+          assert.equal(result.items.length, 1);
+          assert.equal(result.items[0].label, '- (array item)');
+        })
+        .then(done, done);
+    });
+
     it('Array anyOf two objects completion without "-" after array item', (done) => {
       const schema = require(path.join(__dirname, './fixtures/testArrayCompletionSchema.json'));
       languageService.addSchema(SCHEMA_ID, schema);

test/autoCompletionFix.test.ts

@@ -3,7 +3,7 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
-import { CompletionList, Position } from 'vscode-languageserver/node';
+import { CompletionList, Position, Range } from 'vscode-languageserver/node';
 import { LanguageHandlers } from '../src/languageserver/handlers/languageHandlers';
 import { LanguageService } from '../src/languageservice/yamlLanguageService';
 import { SettingsState, TextDocumentTestManager } from '../src/yamlSettings';
@@ -470,5 +470,36 @@ objB:
       expect(completion.items[1].label).to.be.equal('obj1');
       expect(completion.items[1].insertText).to.be.equal('obj1:\n  prop2: ${1:value}');
     });
+
+    it('should suggest object array when extra space is after cursor', async () => {
+      const schema: JSONSchema = {
+        properties: {
+          arrayObj: {
+            type: 'array',
+            items: {
+              type: 'object',
+              properties: {
+                item1: {
+                  type: 'string',
+                },
+                item2: {
+                  type: 'string',
+                },
+              },
+              required: ['item1', 'item2'],
+            },
+          },
+        },
+      };
+      languageService.addSchema(SCHEMA_ID, schema);
+      const content = 'arrayObj:\n  -   ';
+      const completion = await parseSetup(content, 1, 4);
+
+      expect(completion.items.length).equal(3);
+      expect(completion.items[1].textEdit).to.be.deep.equal({
+        newText: 'item1: $1\n  item2: $2',
+        range: Range.create(1, 4, 1, 6), // removes extra spaces after cursor
+      });
+    });
   });
 });