feat: property snippets by p-spacek · Pull Request #1041 · redhat-developer/yaml-language-server

p-spacek · 2025-03-21T09:28:15Z

What does this PR do?

This PR solves many intellisense issues in defaultSnippets
It should be ok to invoke intellisense in all these combinations: yaml cursor position, different types of schemas, and different types of snippets themselves.

should support all these combinations:

yaml position: after colon, in new line, in new line with hyphen, 2nd position of the item
schema type: object, array, anyOf, ...
snippets body type: array, object, array with primitives, simple value
snippetDefinition: in property, in array item

A new feature in this PR is to support property snippet intellisense

will insert the value from the snippet

A similar approach is used in different situations when the single snippet is used as a default value

This PR includes/replaces related changes from PRs:
#755
#901
and include some other snippet fixes - examples are in new tests

So if you accept this PR, we can close the 2 previous PRs

Let me know if I can add more info, please. It would be nice to include these changes in your repo.
We use snippets In our schemas a lot as a rich set of examples and sometimes as a replacement for autogenerated code structure. So, I believe that the code is well-tested.

What issues does this PR fix or reference?

no ref

Is it tested? How?

existing and a few new unit tests that combine the most probable combinations of the configurations
tested by QA in our separate branch

Some definitions that are already used in tests

    "snippets": {
      "properties": {
        "arrayStringSnippet": {
          "type": "object",
          "defaultSnippets": [
            {
              "label": "Array",
              "body": {
                "fruits": ["banana", "orange"]
              }
            }
          ]
        },
        "snippetObject": {
          "type": "object",
          "properties": {
            "item1": { "type": "string" }
          },
          "required": ["item1"],
          "defaultSnippets": [
            {
              "label": "labelSnippetObject",
              "body": {
                "item1": "value",
                "item2": {
                  "item3": "value nested"
                }
              }
            }
          ]
        },
        "snippetArray": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "item1": { "type": "string" }
            }
          },
          "defaultSnippets": [
            {
              "label": "labelSnippetArray",
              "body": {
                "item1": "value",
                "item2": "value2"
              }
            }
          ]
        },
        "snippetArray2": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": true,
            "defaultSnippets": [
              {
                "label": "labelSnippetArray",
                "body": {
                  "item1": "value",
                  "item2": "value2"
                }
              }
            ]
          }
        },
        "snippetArrayComplex": {
          "type": "array",
          "items": {
            "type": "object",
            "defaultSnippets": [
              {
                "body": [
                  {
                    "item1": "value",
                    "item2": {
                      "item2.1": "value3"
                    }
                  },
                  {
                    "item3": [
                      {
                        "item4": "value4",
                        "item5": "value4",
                        "item6": ["value6", "value7"]
                      }
                    ]
                  }
                ]
              }
            ]
          }
        },
        "snippetAnyOfArray": {
          "anyOf": [
            {
              "items": {
                "type": "object",
                "properties": {
                  "item1": { "type": "string" }
                }
              }
            },
            {
              "type": "object"
            }
          ],

          "defaultSnippets": [
            {
              "label": "labelSnippetAnyOfArray",
              "body": [
                {
                  "item1": "value",
                  "item2": "value"
                }
              ]
            }
          ]
        },
        "snippetAnyOfObject": {
          "anyOf": [
            {
              "items": {
                "type": "object",
                "properties": {
                  "item1": { "type": "string" }
                }
              }
            },
            {
              "type": "object"
            }
          ],

          "defaultSnippets": [
            {
              "label": "labelSnippetAnyOfArray",
              "body": {
                "item1": "value",
                "item2": "value"
              }
            }
          ]
        },
        "snippetArray2Objects": {
          "type": "array",
          "items": {
            "type": "object"
          },
          "defaultSnippets": [
            {
              "body": [
                {
                  "item1": "value",
                  "item2": "value2"
                },
                {
                  "item3": "value"
                }
              ]
            }
          ]
        },
        "snippetArrayPrimitives": {
          "type": "array",
          "items": {
            "type": ["string", "boolean", "number", "null"],
            "defaultSnippets": [
              {
                "body": ["value", 5, null, false]
              }
            ]
          }
        }
      }
    }

…-yaml-language-server into fix/suggest-hyphen-in-arrays

…y' into feat/property-snippets

… yaml - because it's properties from the parent object

src/languageservice/services/yamlCompletion.ts

-  private getInsertTextForArray(schema: any, separatorAfter: string, insertIndex = 1, indent = this.indentation): InsertText {
+  private getInsertTextForArray(
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    schema: any,


coveralls · 2025-03-21T09:31:15Z

coverage: 84.415% (+0.2%) from 84.178%
when pulling 4e05825 on jigx-com:feat/property-snippets
into 2a2e614 on redhat-developer:main.

p-spacek · 2025-03-21T09:29:09Z

src/languageservice/services/yamlCompletion.ts

-        return `${resultText}\n${indent}- ${
-          this.getInsertTextForArray(propertySchema.items, separatorAfter, 1, indent).insertText
-        }`;
+        let insertText = this.getInsertTextForArray(propertySchema.items, separatorAfter, collector, 1, indent).insertText;


fix a few existing issues with snippet indentation

p-spacek · 2025-03-21T09:30:01Z

src/languageservice/services/yamlCompletion.ts

    insertIndex = 1
  ): InsertText {
    let insertText = '';
+    if (Array.isArray(schema.defaultSnippets) && schema.defaultSnippets.length === 1) {


The main purpose of this PR is to add snippets to the object

p-spacek · 2025-03-21T09:30:31Z

src/languageservice/services/yamlCompletion.ts

-                }
-                arrayTemplate = arrayInsertLines.join('\n');
-              }
+              const arrayInsertResult = this.getInsertTextForArray(


refactor and fix indentation
use new addIndentationToMultilineString function

p-spacek · 2025-03-21T09:31:43Z

src/languageservice/services/yamlCompletion.ts

            continue;
          }
+
+          if ((arrayDepth === 0 && type === 'array') || isArray) {


refactor, uses a new collector.context concept to distinguish between different scenarios
It wasn't possible to detect if a hyphen was missing or if the cursor was after the colon in the schema array
The previous implementation knows only about schema and a few input parameters (add a new line, add indent, array Depth), but it's useful to know what the current line looks like

p-spacek · 2025-03-21T09:35:13Z

src/languageservice/utils/json.ts

      for (let i = 0; i < obj.length; i++) {
        let pseudoObj = obj[i];
-        if (typeof obj[i] !== 'object') {
+        if (typeof obj[i] !== 'object' || obj[i] === null) {


fix the null issue when the snippet contains null as a value
it crashed when the snippet looks like this body: ["string", 5, null]

p-spacek · 2025-03-21T09:36:03Z

src/languageservice/utils/strings.ts

  return offset;
 }
+
+export function addIndentationToMultilineString(text: string, firstIndent: string, nextIndent: string): string {


Unified function to indent multiline strings, this logic was written multiple times before.

p-spacek · 2025-03-21T09:37:34Z

src/languageservice/services/yamlCompletion.ts

  getNumberOfProposals(): number;
  result: CompletionList;
  proposed: { [key: string]: CompletionItem };
+  context: {


The collector is sent to each internal function, so let's add some context data so we can distinguish between some specific yaml situation

p-spacek · 2025-04-14T08:15:40Z

Hello @msivasubramaniaan , would it be possible to process this task?
I am ready to help if anything

msivasubramaniaan

LGTM

msivasubramaniaan · 2025-04-22T12:19:31Z

@p-spacek Pls update the base

p-spacek · 2025-04-22T13:11:40Z

@msivasubramaniaan I tried to add permission to my repo for you so you should be able to update the base yourselve.
So you don't need to ask me for updating the base.
I hope that it will work like this :)

rickcowan and others added 17 commits July 26, 2022 20:27

fix: default snippet in array

777d15d

Cleaned up collectDefaultSnippets call

9726605

Merge branch 'main' into fix/main-default-snippet-in-array

c6c9a2d

Merge branch 'main' into fix/main-default-snippet-in-array

2056485

Merge branch 'main' into fix/main-default-snippet-in-array

3c0e7b5

fix: suggest hyphen in array

519f984

fix: schemaProvider in test

d0872b1

fix: suggest hyphen in array

0432be8

fix: schemaProvider in test

86a72ed

Merge branch 'fix/suggest-hyphen-in-arrays' of github.com:jigx-com/rh…

f7df5fc

…-yaml-language-server into fix/suggest-hyphen-in-arrays

fix: hyphen for array item

8e4d05f

Merge branch 'main' into fix/suggest-hyphen-in-arrays

0e7c3ad

Merge branch 'main' into fix/suggest-hyphen-in-arrays

0f1b49a

feat: property snippets

e7ad867

Merge remote-tracking branch 'origin/fix/main-default-snippet-in-arra…

f1df123

…y' into feat/property-snippets

fix: object property snippet - should not check existing props in the…

d2d9bdd

… yaml - because it's properties from the parent object

Merge branch 'main' into feat/property-snippets

c7a1315

openshift-ci bot added the do-not-merge/work-in-progress label Mar 21, 2025

github-advanced-security bot found potential problems Mar 21, 2025

View reviewed changes

p-spacek commented Mar 21, 2025

View reviewed changes

p-spacek marked this pull request as ready for review March 21, 2025 09:39

p-spacek requested a review from msivasubramaniaan as a code owner March 21, 2025 09:39

openshift-ci bot removed the do-not-merge/work-in-progress label Mar 21, 2025

p-spacek marked this pull request as draft March 28, 2025 09:35

openshift-ci bot added the do-not-merge/work-in-progress label Mar 28, 2025

p-spacek added 4 commits April 1, 2025 10:53

fix: array snippets

a9aa9cc

fix: anyOfSnippets

9391764

fix: exclude existing props in array snippet

a5508d7

fix: array snippet for 2nd position without hyphen

c1c1d54

p-spacek marked this pull request as ready for review April 7, 2025 07:50

openshift-ci bot removed the do-not-merge/work-in-progress label Apr 7, 2025

msivasubramaniaan approved these changes Apr 22, 2025

View reviewed changes

Merge branch 'main' into feat/property-snippets

e2d85eb

Merge branch 'main' into feat/property-snippets

4e05825

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: property snippets#1041

feat: property snippets#1041
p-spacek wants to merge 23 commits intoredhat-developer:mainfrom
jigx-com:feat/property-snippets

p-spacek commented Mar 21, 2025 •

edited

Loading

Uh oh!

Check warning

coveralls commented Mar 21, 2025 •

edited

Loading

Uh oh!

p-spacek Mar 21, 2025

Uh oh!

p-spacek Mar 21, 2025

Uh oh!

p-spacek Mar 21, 2025

Uh oh!

p-spacek Mar 21, 2025

Uh oh!

p-spacek Mar 21, 2025

Uh oh!

p-spacek Mar 21, 2025

Uh oh!

p-spacek Mar 21, 2025

Uh oh!

p-spacek commented Apr 14, 2025

Uh oh!

msivasubramaniaan left a comment

Uh oh!

msivasubramaniaan commented Apr 22, 2025

Uh oh!

p-spacek commented Apr 22, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

p-spacek commented Mar 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this PR do?

What issues does this PR fix or reference?

Is it tested? How?

Uh oh!

Check warning

coveralls commented Mar 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

p-spacek Mar 21, 2025

Choose a reason for hiding this comment

Uh oh!

p-spacek Mar 21, 2025

Choose a reason for hiding this comment

Uh oh!

p-spacek Mar 21, 2025

Choose a reason for hiding this comment

Uh oh!

p-spacek Mar 21, 2025

Choose a reason for hiding this comment

Uh oh!

p-spacek Mar 21, 2025

Choose a reason for hiding this comment

Uh oh!

p-spacek Mar 21, 2025

Choose a reason for hiding this comment

Uh oh!

p-spacek Mar 21, 2025

Choose a reason for hiding this comment

Uh oh!

p-spacek commented Apr 14, 2025

Uh oh!

msivasubramaniaan left a comment

Choose a reason for hiding this comment

Uh oh!

msivasubramaniaan commented Apr 22, 2025

Uh oh!

p-spacek commented Apr 22, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

p-spacek commented Mar 21, 2025 •

edited

Loading

coveralls commented Mar 21, 2025 •

edited

Loading