feat(generate): adds support for inline comments in rule lines

sverweij · Sep 2, 2023 · 67c2fa9 · 67c2fa9
1 parent 6da54a2
commit 67c2fa9
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 2 deletions.
diff --git a/dist/generate-codeowners.js b/dist/generate-codeowners.js
diff --git a/src/generate-codeowners.test.ts b/src/generate-codeowners.test.ts
@@ -208,6 +208,19 @@ tools/ @team-tgif`;
     );
   });
 
+  it("re-adds any inline comment", () => {
+    const lFixture = "no-plan-b/ @team    # this is a comment";
+    const lTeamMapFixture = {
+      team: ["b.a.barackus", "face", "hannibal", "murdock"],
+    };
+    const lExpected =
+      "no-plan-b/ @b.a.barackus @face @hannibal @murdock # this is a comment";
+    equal(
+      generateCodeOwnersFromString(lFixture, lTeamMapFixture, ""),
+      lExpected,
+    );
+  });
+
   it("writes the kitchensink", () => {
     const lTeamMap = readTeamMap(
       new URL("./__mocks__/virtual-teams.yml", import.meta.url).pathname,

diff --git a/src/generate-codeowners.ts b/src/generate-codeowners.ts
@@ -43,7 +43,12 @@ function generateLine(
     )
       .sort(compareUserNames)
       .join(" ");
-    return pCSTLine.filesPattern + pCSTLine.spaces + lUserNames;
+    return (
+      pCSTLine.filesPattern +
+      pCSTLine.spaces +
+      lUserNames +
+      (pCSTLine.inlineComment ? ` #${pCSTLine.inlineComment}` : "")
+    );
   }
   return pCSTLine.raw;
 }