fix(add): preserve comment block before the next section on overwrite#1
Merged
Merged
Conversation
tomlkit parses standalone comments/blank lines between a tool's last sub-table and the following section header into that sub-table's body. Rebuilding the entry from scratch and assigning it dropped them, eating e.g. the comment block before [tool.prm2-harness] on a version bump. Capture the trailing whitespace/comment run from the old entry's deepest sub-table and re-attach it to the rebuilt entry before writing.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
TL;DR
ohbin addна перезаписи существующего[tool.ohbin.tools.<name>]проглатывалкомментарий-блок и пустую строку, шедшие после секции (т.е. принадлежащие
следующему заголовку). Реально словил на PRM2: bump
find-dup-defsстёркомментарий перед
[tool.prm2-harness].Корень
tomlkit парсит standalone-комментарии/пустые строки между последней под-таблицей
тула и следующим заголовком секции в
bodyсамой глубокой последнейпод-таблицы этого тула (
…assets.darwin-arm64).write_toolсобиралentryс нуля и делал
tools[name] = entry— старое поддерево вместе с этой тривиейвыбрасывалось.
Фикс
Перед перезаписью снимаем хвостовой run из whitespace/comment у глубочайшей
последней под-таблицы старого entry и переклеиваем его на пересобранный entry
(
_deepest_last_table+_detach_trailing_trivia). Layout (включаяпустую строку-разделитель) сохраняется 1-в-1.
Тесты
tests/test_add.py— новый файл:make lint-heavyчисто (ruff + pyright 0/0),make test-full— 51 passed.