CLI-216 fix: use String.raw to avoid escaping backslashes in unix-agent-hook-templates from #136

[sonarqube-agent]

Addresses quality gate issues from #136.

Replaced concatenated template literal with String.raw to eliminate unnecessary backslash escaping in the unix-agent-hook-templates.ts file. This improves code readability and reduces error-prone double-escaping while resolving the SonarQube code smell.

View Project in SonarCloud

---

Fixed Issues

typescript:S7780 - `String.raw` should be used to avoid escaping `\`. • MINOR • View issue

Location: src/cli/commands/integrate/_common/unix-agent-hook-templates.ts:59

What changed

This hunk replaces a concatenated template literal containing multiple escaped backslashes (e.g., \\, \", \t, \r, \n) with a single String.raw template literal. By using String.raw, backslashes are treated literally and no longer need to be double-escaped, which directly resolves the code smell about using String.raw to avoid escaping \ in the file unix-agent-hook-templates.ts. The resulting code is more readable and less error-prone, as the awk script content is now expressed with single backslashes matching the intended output, and the awkward string concatenation trick (splitting the string to include a literal double-quote) is also eliminated.

--- a/src/cli/commands/integrate/_common/unix-agent-hook-templates.ts
+++ b/src/cli/commands/integrate/_common/unix-agent-hook-templates.ts
@@ -56,5 +56,1 @@ function sqaaHookOutputJsonEscapeAwk(): string {
-  return (
-    `BEGIN{ORS=""} {gsub(/\\/, "\\\\"); gsub(/"/, "\\` +
-    `"` +
-    `"); gsub(/${tab}/, "\\t"); gsub(/${cr}/, "\\r"); if(NR>1) printf "\\n"; print}`
-  );
+  return String.raw`BEGIN{ORS=""} {gsub(/\/, "\\"); gsub(/"/, "\""); gsub(/${tab}/, "\t"); gsub(/${cr}/, "\r"); if(NR>1) printf "\n"; print}`;

Have a suggestion or found an issue? Share your feedback here.

---

SonarQube Remediation Agent uses AI. Check for mistakes.

DISCLAIMER: Remediation Agent will not be triggered again on this (self authored) PR

[hashicorp-vault-sonar-prod]

CLI-216

[sonar-review-alpha]

Summary

Single-file refactor using String.raw to resolve a SonarQube code smell. Replaces a concatenated template literal in the awk script generator with a cleaner String.raw expression. The generated awk output is functionally identical; the change is purely for code clarity and to eliminate unnecessary escaping complexity.

What reviewers should know

Where to focus: Only the sqaaHookOutputJsonEscapeAwk() function is affected. What to verify: The key difference is backslash handling—the old code used double backslashes (\\\\, \\n, \\t, etc.) to produce single backslashes in the output; the new code uses single backslashes directly within String.raw. Confirm the awk script output is identical between old and new. Why the change works: String.raw treats backslashes as literals, eliminating the escaping gymnastics and the string concatenation workaround (the triple-part \\ + \" + \" split) that existed to avoid escaping a literal double-quote. The change is low-risk—no runtime behavior changes, only code readability.

---

• Generate Walkthrough
• Generate Diagram

🗣️ Give feedback

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues
0 Dependency risks

Measures
0 Security Hotspots
100.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[sonar-review-alpha]

Conclusion: Clean, correct refactor. The generated awk string is byte-for-byte identical to the old concatenated approach — the fix is safe to merge pending the stale comment below.

🗣️ Give feedback

[sonar-review-alpha]

The comment says "Split gsub(/"/,...) so we avoid unnecessary \" escapes" and describes the string-concatenation trick, but that trick no longer exists — String.raw handles it directly. The comment now describes removed code and will mislead future readers.

Suggested change

	// Split gsub(/"/, ...) so we avoid unnecessary `\"` escapes (typescript:S6535); keep same awk source as legacy template literals.
	// String.raw avoids double-escaping backslashes and the `\"` issue (typescript:S6535, S7780); ${tab}/${cr} interpolation still works normally.

• Mark as noise

[kussberg]

is broken at the first gsub — it would produce an invalid awk script.