Skip to content

tools/format-changelog: Upgrade line-unwrapping to handle nested lists #1875

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

tools/format-changelog: Upgrade line-unwrapping to handle nested lists #1875

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
24 changes: 23 additions & 1 deletion tools/format-changelog
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,29 @@ extract_highlights() {

# Undo line-wrapping.
unwrap() {
fmt --tagged-paragraph --width=2000
# Implemented by rewrapping paragraphs in Vim.
# (Emacs works equally well, interactively; but seems more annoying
# to integrate into a CLI pipeline.)

local vim_markdown_settings=/usr/share/vim/vim90/ftplugin/markdown.vim
if [ ! -r "${vim_markdown_settings}" ]; then
# On Debian, this file is installed by the package `vim-runtime`.
# We can generalize this as needed to find where other systems put it.
# Upstream is here:
# https://github.com/tpope/vim-markdown/blob/f9f845f28/ftplugin/markdown.vim
# The parts we actually use are the variables `comments`,
# `formatoptions`, and `formatlistpat`.
echo >&2 "error: Could not find spec for rewrapping Markdown."
echo >&2 " See comments in the source code in tools/format-changelog."
exit 1
fi

# The Vim command "gq" rewraps paragraphs; "G" makes it do so
# from the current point to the end, and "gg" first goes to the start.
vim -es /dev/stdin \
'+set textwidth=2000' \
"+source ${vim_markdown_settings}" \
'+normal gggqG' '+%print' '+:q!'
}

# Print changelog entry, with line-wrapping removed.
Expand Down