Merge pull request #19 from LonoxX/develop

fix: Escape YAML special characters in issue/PR titles #18

Author: LonoxX

src/file-manager.ts

@@ -11,7 +11,8 @@ import {
 	createPullRequestTemplateData,
 	processFilenameTemplate,
 	processContentTemplate,
-	extractNumberFromFilename
+	extractNumberFromFilename,
+	escapeYamlString
 } from "./util/templateUtils";
 
 export class FileManager {
@@ -599,7 +600,7 @@ export class FileManager {
 
 		// Fallback to default template
 		return `---
-title: "${escapeBody(issue.title, this.settings.escapeMode)}"
+title: "${escapeYamlString(issue.title)}"
 status: "${issue.state}"
 created: "${
 			this.settings.dateFormat !== ""
@@ -655,7 +656,7 @@ ${this.formatComments(comments, this.settings.escapeMode)}
 
 		// Fallback to default template
 		return `---
-title: "${escapeBody(pr.title, this.settings.escapeMode)}"
+title: "${escapeYamlString(pr.title)}"
 status: "${pr.state}"
 created: "${
 			this.settings.dateFormat !== ""

src/util/escapeUtils.ts

@@ -48,3 +48,13 @@ export function escapeBody(
 		.replace(/{{/g, "((")
 		.replace(/}}/g, "))");
 }
+
+/**
+ * Escape a string for use in YAML double-quoted strings
+ * @param str The string to escape
+ * @returns The escaped string
+ */
+export function escapeYamlString(str: string): string {
+	// In YAML double-quoted strings, we need to escape backslashes and double quotes
+	return str.replace(/\\/g, '\\\\').replace(/"/g, '\\"');
+}

src/util/templateUtils.ts

@@ -3,13 +3,14 @@
  */
 
 import { format } from "date-fns";
-import { escapeBody } from "./escapeUtils";
+import { escapeBody , escapeYamlString} from "./escapeUtils";
 
 /**
  * Represents the data available for template replacement
  */
 interface TemplateData {
 	title: string;
+	title_yaml: string;
 	number: number;
 	status: string;
 	author: string;
@@ -128,6 +129,7 @@ export function processTemplate(
 	// Available template variables:
 	const replacements: Record<string, string> = {
 		"{title}": data.title || "Untitled",
+		"{title_yaml}": data.title_yaml || "Untitled",
 		"{number}": data.number.toString(),
 		"{status}": data.status || "unknown",
 		"{state}": data.state || data.status || "unknown",
@@ -300,6 +302,7 @@ export function createIssueTemplateData(
 
 	return {
 		title: issue.title || "Untitled",
+		title_yaml: escapeYamlString(issue.title || "Untitled"),
 		number: issue.number,
 		status: issue.state || "unknown",
 		state: issue.state || "unknown",
@@ -344,6 +347,7 @@ export function createPullRequestTemplateData(
 
 	return {
 		title: pr.title || "Untitled",
+		title_yaml: escapeYamlString(pr.title || "Untitled"),
 		number: pr.number,
 		status: pr.state || "unknown",
 		state: pr.state || "unknown",
@@ -383,6 +387,7 @@ export function getTemplateHelp(): string {
 
 Basic Information:
 • {title} - Issue/PR title
+• {title_yaml} - Issue/PR title (YAML-escaped for use in frontmatter)
 • {number} - Issue/PR number
 • {status} / {state} - Current status (open, closed, etc.)
 • {author} - Username who created the issue/PR
@@ -454,6 +459,7 @@ export function extractNumberFromFilename(filename: string, template: string): s
 	// Replace template variables with regex patterns
 	pattern = pattern.replace(/\\?\{number\}/g, '(\\d+)');
 	pattern = pattern.replace(/\\?\{title\}/g, '.*?');
+	pattern = pattern.replace(/\\?\{title_yaml\}/g, '.*?');
 	pattern = pattern.replace(/\\?\{status\}/g, '\\w+');
 	pattern = pattern.replace(/\\?\{author\}/g, '[^\\s]+');
 	pattern = pattern.replace(/\\?\{assignee\}/g, '[^\\s]*');

templates/Template Variables Reference.md

@@ -5,6 +5,7 @@
 | Variable | Description | Example |
 |----------|-------------|---------|
 | `{title}` | Issue/PR title | "Fix login bug" |
+| `{title_yaml}` | Issue/PR title (YAML-escaped) | "Fix \"login\" bug" |
 | `{number}` | Issue/PR number | "123" |
 | `{status}` | Current status | "open", "closed" |
 | `{state}` | Synonym for status | "open", "closed" |

templates/default-issue-template.md

@@ -1,5 +1,5 @@
 ---
-title: "{title}"
+title: "{title_yaml}"
 status: "{status}"
 created: "{created}"
 url: "{url}"

templates/default-pr-template.md

@@ -1,5 +1,5 @@
 ---
-title: "{title}"
+title: "{title_yaml}"
 status: "{status}"
 created: "{created}"
 url: "{url}"

templates/detailed-template.md

@@ -1,5 +1,5 @@
 ---
-title: "{title}"
+title: "{title_yaml}"
 status: "{status}"
 type: "{type}"
 repository: "{repository}"

templates/minimal-template.md

@@ -1,5 +1,5 @@
 ---
-title: "{title}"
+title: "{title_yaml}"
 status: "{status}"
 created: "{created}"
 url: "{url}"