docs: trim block comment on shellWord helper

This commit is contained in:
Mauricio Siu
2026-07-19 21:36:25 -06:00
parent 97cd7d1009
commit fcec9d43a6

View File

@@ -1,10 +1,6 @@
import { quote } from "shell-quote";
/**
* Escapes a single value so it can be safely interpolated as one argument into
* a `/bin/sh -c` command string (both local `execAsync` and remote SSH
* `execAsyncRemote`). User-controlled fields such as git URLs, branch names,
* repository owners and SSH hostnames must never reach a shell unescaped.
*/
// Escapes a value so it is safe to interpolate as a single argument into a
// /bin/sh -c command string (local execAsync and remote SSH execAsyncRemote).
export const shellWord = (value: string | number | null | undefined): string =>
quote([String(value ?? "")]);