fix: hyphen for array item

redhat-developer · Oct 13, 2023 · 8e4d05f · 8e4d05f
1 parent f7df5fc
commit 8e4d05f
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 5 deletions.
diff --git a/src/languageservice/services/yamlCompletion.ts b/src/languageservice/services/yamlCompletion.ts
@@ -814,7 +814,7 @@ export class YamlCompletion {
             collector,
             {},
             'property',
-            Array.isArray(nodeParent.items)
+            Array.isArray(nodeParent.items) && !isInArray
           );
         }
 
@@ -1424,10 +1424,11 @@ export class YamlCompletion {
         } else if (schema.enumDescriptions && i < schema.enumDescriptions.length) {
           documentation = schema.enumDescriptions[i];
         }
+        const insertText = (isArray ? '- ' : '') + this.getInsertTextForValue(enm, separatorAfter, schema.type);
         collector.add({
           kind: this.getSuggestionKind(schema.type),
           label: this.getLabelForValue(enm),
-          insertText: this.getInsertTextForValue(enm, separatorAfter, schema.type),
+          insertText,
           insertTextFormat: InsertTextFormat.Snippet,
           documentation: documentation,
         });

diff --git a/test/autoCompletion.test.ts b/test/autoCompletion.test.ts
@@ -1488,7 +1488,7 @@ describe('Auto Completion Tests', () => {
           .then(done, done);
       });
 
-      it('Array of enum autocomplete on 2nd position without `-`', (done) => {
+      it('Array of enum autocomplete on 2nd position without `-` should auto add `-` and `- (array item)`', (done) => {
         schemaProvider.addSchema(SCHEMA_ID, {
           type: 'object',
           properties: {
@@ -1508,7 +1508,7 @@ describe('Auto Completion Tests', () => {
               result.items.map((i) => ({ label: i.label, insertText: i.insertText })),
               [
                 {
-                  insertText: 'Test',
+                  insertText: '- Test', // auto added `- `
                   label: 'Test',
                 },
                 {

diff --git a/test/defaultSnippets.test.ts b/test/defaultSnippets.test.ts
@@ -240,6 +240,19 @@ describe('Default Snippet Tests', () => {
         .then(done, done);
     });
 
+    it('Snippet in string schema should autocomplete on same line (snippet is defined in body property)', (done) => {
+      const content = 'arrayStringValueSnippet:\n - |\n|';
+      const completion = parseSetup(content);
+      completion
+        .then(function (result) {
+          assert.deepEqual(
+            result.items.map((i) => ({ label: i.label, insertText: i.insertText })),
+            [{ insertText: 'banana', label: 'Banana' }]
+          );
+        })
+        .then(done, done);
+    });
+
     it('Snippet in boolean schema should autocomplete on same line', (done) => {
       const content = 'boolean: | |'; // len: 10, pos: 9
       const completion = parseSetup(content);
@@ -273,7 +286,7 @@ describe('Default Snippet Tests', () => {
       const completion = parseSetup(content);
       completion
         .then(function (result) {
-          assert.equal(result.items.length, 15); // This is just checking the total number of snippets in the defaultSnippets.json
+          assert.equal(result.items.length, 16); // This is just checking the total number of snippets in the defaultSnippets.json
           assert.equal(result.items[4].label, 'longSnippet');
           // eslint-disable-next-line
           assert.equal(

diff --git a/test/fixtures/defaultSnippets.json b/test/fixtures/defaultSnippets.json
@@ -110,6 +110,18 @@
         }
       ]
     },
+    "arrayStringValueSnippet": {
+      "type": "array",
+      "items": {
+        "type": "string",
+        "defaultSnippets": [
+          {
+            "label": "Banana",
+            "body": "banana"
+          }
+        ]
+      }
+    },
     "arrayObjectSnippet": {
       "type": "object",
       "defaultSnippets": [