fix: escape | using \\ in commit messages

redhat-plumbers-in-action · Jan 19, 2024 · 69c703f · 69c703f
1 parent 7f10fa8
commit 69c703f
Show file tree

Hide file tree

Showing 10 changed files with 37 additions and 10 deletions.
diff --git a/dist/commit.js b/dist/commit.js
diff --git a/dist/commit.js.map b/dist/commit.js.map
diff --git a/dist/index.js b/dist/index.js
diff --git a/dist/index.js.map b/dist/index.js.map
diff --git a/dist/util.d.ts b/dist/util.d.ts
diff --git a/dist/util.js b/dist/util.js
diff --git a/dist/util.js.map b/dist/util.js.map
diff --git a/src/commit.ts b/src/commit.ts
@@ -2,6 +2,7 @@ import { Endpoints } from '@octokit/types';
 import { z } from 'zod';
 
 import { SingleCommitMetadata } from './schema';
+import { escape } from './util';
 
 // subset of Endpoints['GET /repos/{owner}/{repo}/commits']['response']['data'][number]
 const commitDataSchema = z.object({
@@ -25,8 +26,8 @@ export class Commit {
     this.sha = parsedData.sha;
     this.url = parsedData.html_url;
     this.message = {
-      title: this.getTitle(parsedData.commit.message),
-      body: parsedData.commit.message,
+      title: escape(this.getTitle(parsedData.commit.message)),
+      body: escape(parsedData.commit.message),
       cherryPick: this.getCherryPicks(parsedData.commit.message),
     };
   }

diff --git a/src/util.ts b/src/util.ts
@@ -0,0 +1,3 @@
+export function escape(str: string): string {
+  return str.replace('|', '\\|');
+}
diff --git a/test/unit/util.test.ts b/test/unit/util.test.ts
@@ -0,0 +1,10 @@
+import { describe, expect, test } from 'vitest';
+
+import { escape } from '../../src/util';
+
+describe('Test utility functions', () => {
+  test('escape() can escape string', () => {
+    expect(escape('abc|def')).toBe('abc\\|def');
+    expect(escape('abcdef')).toBe('abcdef');
+  });
+});