Workaround for write_file failures caused by special characters (apostrophes, backticks, template literals) by using a Python heredoc script executed via shell.
复制下面这句话,粘贴给 Claude Code、Codex、Cursor 等 AI 编程工具,它会读取安装说明并在你确认后完成安装。
请阅读 https://ai.atlankj.com/install/asset/gh-write-special-chars-heredoc-70efe3bfecce ,按照其中的说明把「write-special-chars-heredoc」安装到你(当前 AI 工具)中。执行前先告诉我将运行的命令和写入的位置,等我确认。
查看 AI 将读取的安装说明正在读取 GitHub 原文…
内容来自 GitHub 原始文件,由原作者维护。在 GitHub 查看
The write_file tool may fail with [ERROR] unknown error when file content
contains special characters such as:
')`)`${variable}`) common in TypeScript/JavaScriptThis is especially common when writing TypeScript, JavaScript, shell scripts, or any source file with string interpolation syntax.
Write a small Python script to /tmp/ that uses triple-quoted strings to
embed the file content, then execute it with python3.
"""...""")./tmp/ — its content is plain enough
that write_file will succeed (no problematic characters in the wrapper).run_shell: python3 /tmp/write_<name>.py| Character | How to handle |
|---|---|
Backslash \ | Escape as \\ |
Triple double-quote """ | Escape as \"\"\" or use ''' strings instead |
Everything else (backticks, $, ', {}) | No escaping needed |
#!/usr/bin/env python3
content = """
<YOUR FILE CONTENT HERE>
""".lstrip("\n")
with open("/path/to/target/file.ts", "w") as f:
f.write(content)
print("File written successfully.")
Suppose you need to write a TypeScript file with template literals and
apostrophes that causes write_file to fail:
Step 1 — Write the Python helper to /tmp/:
Use write_file with path /tmp/write_greeting.py and content:
#!/usr/bin/env python3
content = """
export function greet(name: string): string {
const msg = `Hello, ${name}! It's a great day.`;
console.log(`Greeting: ${msg}`);
return msg;
}
""".lstrip("\n")
with open("/app/src/greeting.ts", "w") as f:
f.write(content)
print("Written: /app/src/greeting.ts")
Step 2 — Execute the helper:
python3 /tmp/write_greeting.py
Step 3 — Verify:
cat /app/src/greeting.ts
write_file returns [ERROR] unknown error for a specific file.For writing several problematic files in one pass, consolidate them into a single Python script:
#!/usr/bin/env python3
import os
files = {
"/app/src/component.tsx": """
import React from 'react';
const App = () => (
<div className={`container`}>
<h1>It's working!</h1>
</div>
);
export default App;
""".lstrip("\n"),
"/app/src/utils.ts": """
export const format = (val: number) => `Value: ${val.toFixed(2)}`;
""".lstrip("\n"),
}
for path, content in files.items():
os.makedirs(os.path.dirname(path), exist_ok=True)
with open(path, "w") as f:
f.write(content)
print(f"Written: {path}")
.py file can be inspected if needed.rm /tmp/write_*.py after all files are written.