Avoid comment duplication in block scalars (#164)

pascalre · Oct 22, 2023 · cd793e4 · cd793e4
1 parent 1238bc7
commit cd793e4
Show file tree

Hide file tree

Showing 3 changed files with 51 additions and 2 deletions.
diff --git a/src/processor/comment-processor.ts b/src/processor/comment-processor.ts
@@ -59,8 +59,16 @@ export class CommentProcessor {
   insert(comment: string[]) {
     const indexOfComment = this.getIndexOfString(comment[1])
     if (CommentProcessor.isCommentFound(indexOfComment)) {
-      const textAfter = this.text.slice(indexOfComment)
-      const textBefore = this.text.slice(0, indexOfComment)
+      this.insertIfNotContained(comment)
+    }
+  }
+
+  insertIfNotContained(comment: string[]) {
+    const indexOfComment = this.getIndexOfString(comment[1])
+    const textAfter = this.text.slice(indexOfComment)
+    const textBefore = this.text.slice(0, indexOfComment)
+
+    if (!textBefore.endsWith(`${comment[0]}\n`)) {
       this.text = `${textBefore}${comment[0]}\n${textAfter.trimEnd()}`
     }
   }

diff --git a/src/test/suite/controller/processor-controller.test.ts b/src/test/suite/controller/processor-controller.test.ts
@@ -129,4 +129,21 @@ suite("Test ProcessorController - preprocess() & postprocess()", () => {
 
     equal(processor.text, text)
   })
+
+  test("GitHub issue #164: Comment processor duplicates comments inside block scalars", () => {
+    const text =
+      "block:\n" +
+      "  - |\n" +
+      "    # comment 1\n" +
+      "    some command\n" +
+      "    # comment 2\n" +
+      "    some other command"
+      const processor = new ProcessorController(text)
+
+      processor.preprocess()
+      processor.postprocess()
+
+      equal(processor.text, text)
+
+    })
 })
diff --git a/src/test/suite/processor/comment-processor.test.ts b/src/test/suite/processor/comment-processor.test.ts
@@ -259,6 +259,30 @@ suite("Test CommentProcessor - isCommentFound()", () => {
   })
 })
 
+suite("Test CommentProcessor - insertIfNotContained()", () => {
+  test("when comment is already contained it should not be inserted", () => {
+    const text =
+      "block:\n" +
+      "  - |\n" +
+      "    # comment 1\n" +
+      "    some command"
+    const commentprocessor = new CommentProcessor(text)
+
+    commentprocessor.findComments()
+    equal(commentprocessor.store.length, 1)
+
+    commentprocessor.insertIfNotContained(commentprocessor.store[0])
+    equal(commentprocessor.text, text)
+
+    commentprocessor.text =
+      "block:\n" +
+      "  - |\n" +
+      "    some command"
+    commentprocessor.insertIfNotContained(commentprocessor.store[0])
+    equal(commentprocessor.text, text)
+    })
+})
+
 suite("Test CommentProcessor - Issue 45", () => {
   // https://github.com/pascalre/vscode-yaml-sort/issues/45#issuecomment-1329161613
   test("should fuzzy find comments", () => {