Skip to content

script: check link format in Markdown files #2206

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jonatack merged 1 commit into from
Jul 10, 2026
+19 −2
Merged

script: check link format in Markdown files #2206

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 19 additions & 2 deletions scripts/link-format-chk.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,36 @@
# Distributed under the MIT software license, see the accompanying
# file COPYING or http://www.opensource.org/licenses/mit-license.php.
#
# Check wrong mediawiki link format
# Check wrong mediawiki and markdown link formats

ECODE=0
MEDIAWIKI_ECODE=0
while IFS= read -r fname; do
GRES=$(grep -nE '\]\((https?://|\.\./bip-|/bip-)' "$fname")
if [ "$GRES" != "" ]; then
if [ $ECODE -eq 0 ]; then
if [ $MEDIAWIKI_ECODE -eq 0 ]; then
>&2 echo "Github Mediawiki format writes links as [URL text], not as [text](URL):"
fi
MEDIAWIKI_ECODE=1
ECODE=1
while IFS= read -r line; do
echo "- ${fname#./}:$line"
done <<< "$GRES"
fi
done < <(find . -type f -name '*.mediawiki' | sort)

MARKDOWN_ECODE=0
while IFS= read -r fname; do
GRES=$(grep -nE '\[[[:space:]]*https?://[^][]*\]|\[\[(\.\./|/)?bip-[^][]*\]\]' "$fname")
if [ "$GRES" != "" ]; then
if [ $MARKDOWN_ECODE -eq 0 ]; then
>&2 echo "Github Markdown format writes links as [text](URL), not as [URL text] or [[URL|text]]:"
fi
MARKDOWN_ECODE=1
ECODE=1
while IFS= read -r line; do
echo "- ${fname#./}:$line"
done <<< "$GRES"
fi
done < <(find . -type f -name '*.md' | sort)
exit $ECODE