bash 打印转义的文件内容

Question

我正在尝试使用转义的双引号打印文件内容。

# read file contents from ${filename}
# - escape double quotes
# - represent newlines as '\n' 
# print the result
echo "my file contents: \"${out}\""

例如，如果我的文件是

<empty line>
console.log("hello, world");
<empty line>

应该打印出来

my file contents: "\nconsole.log(\"hello, world\");\n"

我尝试将 printf 与 %q 格式说明符一起使用，但遇到了删除尾随空格的问题。

Answer 1

命令替换去除尾随换行符。您可以通过添加一个虚拟的非换行符然后剥离它来防止这种情况：

printf '\n\nfoo\n\n' > file

contents="$(cat "file"; printf x)"
contents="${contents%x}"

printf "The shell equivalent of the file contents is: %q\n" "$contents"

如果您尝试生成 JSON，则应改为使用 jq。

Answer 2

只做你明确要求的两个文字转换：

IFS= read -r -d '' content <file
content=${content//'"'/'\"'/}
content=${content//$'\n'/'\n'}
echo "file contents: $content"

也就是说，如果您尝试将任意内容表示为 JSON 字符串，则让完全兼容的 JSON 解析器/生成器来完成繁重的工作：

IFS= read -r -d '' content <file
echo "file contents: $(jq -n --arg content "$content" '$content')"

...或者，甚至更好（支持包含 bash 无法存储为字符串的内容的文件），让 jq 直接从输入文件中读取：

echo "file contents: $(jq -Rs . <file)"

Answer 3

在我看来，将任意多行文本转换为 printf 格式的最可靠方法是使用 bash 内置的 printf。

$ nl -ba testfile
     1
     2  console.log("hello, world");
     3
$ s="$(printf '%q' "$(cat testfile; printf x)")"
$ s="${s%x\'}"; s="${s#\$\'}"
$ echo "$s"
\nconsole.log("hello, world");\n\n

这具有处理所有个字符的优点，包括CR和制表符，而不仅仅是换行符。

请注意我们使用的有趣的命令扩展解决方法，以避免去除尾随的换行符。 （否则，我们只能s="$(printf '%q' "$(<testfile)")"。）

还要注意我们在echo 之前的行中所做的参数扩展。这是必需的，因为 bash 处理 %q 格式字符的方式，返回一个格式引用的字符串，而不仅仅是格式化的字符串。