oh-my-fish/tools/generate-themes-doc.fish
2021-01-24 10:04:51 -08:00

105 lines
3.3 KiB
Fish
Executable File

#!/usr/bin/env fish
# This is meant to be run from the root:
#
# ./tools/generate-themes-doc.fish > docs/NewThemes.md
#
# Prior to running it, check out packages-main repository alongside oh-my-fish.
# If it's checked out at another location, you can specify it with the only
# optional argument
#
# ./tools/generate-themes-doc.fish /full-or-rel-path/packages-main > docs/NewThemes.md
#
set TOC_TBL_COLS 7
if [ $argv ]
set packages "$argv/packages"
else
set packages "../packages-main/packages"
end
type -q gsed; and alias sed gsed
type -q gmktemp; and alias mktemp gmktemp
set temp_theme_contents (mktemp /tmp/fish.Themes.Content.XXXXX.md)
set temp_theme_toc (mktemp /tmp/fish.Themes.TOC.XXXXX.md)
function __write_theme_readme -a name raw_content readme
set -l escaped_raw_content (echo $raw_content | sed -r s"#[\/]#\\\/#gi")
curl -s "$raw_content/$readme" | \
sed -r 's/^#(.*)$/###\1/gi' | \
sed -r 's/^=+$//gi' | \
sed -r 's/^!\[(.*)\]\(([^h][^t][^t].*)\)$/![\1]('$escaped_raw_content'\/\2)/gi' | \
sed -r 's/\[([^\]+)\]\[([a-zA-Z0-9]+)\]/[\1][THEMES-NAMESPACE-'"$name"'-\2]/gi' | \
sed -r 's/\[([a-zA-Z0-9]+)\]: (.+)/[THEMES-NAMESPACE-'"$name"'-\1]: \2/gi' \
>> $temp_theme_contents
echo "" >> $temp_theme_contents
echo "" >> $temp_theme_contents
end
function __find_readme -a raw_content
for readme in "README.md" "readme.md"
if curl -Ifs "$raw_content/$readme" > /dev/null
echo $readme
break
end
end
end
function __write_toc
set -l total (count $argv)
echo "Processing $total themes..." >&2
set -l table_rows (math "ceil($total / $TOC_TBL_COLS)")
echo "Creating a $table_rows-row table" >&2
echo "<details>" >> $temp_theme_toc
echo "<summary><big><strong>Expand for a table of themes</strong></big></summary>" >> $temp_theme_toc
echo "<table>" >> $temp_theme_toc
for row in (seq $table_rows)
echo "<tr>" >> $temp_theme_toc
for col in (seq $TOC_TBL_COLS)
set -l idx (math "($col - 1) * $table_rows + $row")
test -z "$argv[$idx]"
and echo " <td>&nbsp;</td>" >> $temp_theme_toc
and continue
set -l name (basename $argv[$idx])
echo " <td><a href=\"#$name\">$name</a></td>" >> $temp_theme_toc
end
echo "</tr>" >> $temp_theme_toc
end
echo "</table>" >> $temp_theme_toc
echo "</details>" >> $temp_theme_toc
echo -e "\n***" >> $temp_theme_toc
end
echo -e "# Available themes\n" > $temp_theme_toc
echo -e "<!-- ATTENTION: This file is auto-generated! Changes will be lost! -->\n" >> $temp_theme_toc
set -l themes (command grep -r -l "type = theme" $packages | sort)
__write_toc $themes
for theme in $themes
set -l name (basename $theme)
set -l url (grep repository $theme | string replace "repository = " "")
set -l raw_content (echo $url | sed -r 's#\.git$#/#i; s#https://github.com/([-.a-z0-9]+)/([-.a-z0-9]+)#https://raw.githubusercontent.com/\1/\2/master#i')
set -l readme (__find_readme $raw_content)
echo "# [$name]("$url")" >> $temp_theme_contents
if [ $readme ]
echo "Fetching readme for $name" >&2
__write_theme_readme $name $raw_content $readme
else
echo "FAILED: No readme for $name" >&2
echo "See $url for details" >> $temp_theme_contents
end
end
echo "" >> $temp_theme_toc
cat $temp_theme_contents >> $temp_theme_toc
rm -f $theme_doc
cat $temp_theme_toc
echo "All done!" >&2
rm $temp_theme_contents
rm $temp_theme_toc