Welcome to Software Development on Codidact!
Will you help us build our independent community of developers helping developers? We're small and trying to grow. We welcome questions about all aspects of software development, from design to code to QA and more. Got questions? Got answers? Got code you'd like someone to review? Please join us.
Command to format code from repo into single markdown file
I'm trying to flatten a repository of Python code into a Markdown file where each file is formatted like:
relative/path/to/file1.py
# contents of file1.py
I'm using this command:
find . -name "*.py" -print0 | while read -d $'\0' file; do
echo "`"
echo "$file"
echo "`"
echo "```python"
cat "$file"
echo "```"
echo
done > all_code.md
But I'm getting this errors:
zsh: no such file or directory: \n echo ./tests/tests_formatter.py\n echo
zsh: no such file or directory: python\n cat ./tests/tests_formatter.py \n echo
I would appreciate any suggestions on getting this command or alternative commands to achieve the expected result.
2 answers
You are accessing this answer with a direct link, so it's being shown above all other answers regardless of its score. You can return to the normal view.
You need to use backslashes (\) to escape your grave accents (`). Otherwise, Bash tries to see them as enclosing a command, as you would do in a command like echo `which python3`.
So, with all the backslashes added in, your code will look like this:
find . -name "*.py" -print0 | while read -d $'\0' file; do
echo "\`$file\`"
echo "\`\`\`python"
cat "$file"
echo "\`\`\`"
echo
done > all_code.md
It now successfully outputs the Markdown to all_code.md.
0 comment threads
Sylvester's answer is great, but I wanted to point out that interpolation only happens in double-quoted strings ("), not in single-quoted ones (').
If you have lines that don't need any variable or command interpolation, you can single-quote and skip escapes:
find . -name "*.py" -print0 | while read -d $'\0' file; do
echo "\`$file\`"
echo '```python'
cat "$file"
echo '```'
echo
done > all_code.md
On the other hand, you may find code easier to read with the consistency of only one quoting mechanism and its escapes. That's personal preference.
0 comment threads
0 comment threads