Fix comments lost when load() auto-saves new fields#1
Open
lt-name wants to merge 1 commit intoWaterdogPE:masterfrom
Open
Fix comments lost when load() auto-saves new fields#1lt-name wants to merge 1 commit intoWaterdogPE:masterfrom
lt-name wants to merge 1 commit intoWaterdogPE:masterfrom
Conversation
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.
Summary
load()orreload()detects new fields not present in the YAML file, it callssaveToYaml()directly to persist them. At that point thecommentsmap is empty, causing the rewritten file to lose all@Comment/@Commentsannotation-based comments.internalSave()into a reusablecollectComments(Class)method, and invoke it before everysaveToYaml()call ininternalLoad().save(boolean): alwaysclearComments()first, then conditionallycollectComments(). This corrects two side issues:save(false)previously still wrote comments (becauseinternalSavere-added them after clear), and repeatedsave()calls accumulated duplicate comments.Changes
YamlConfig.javacollectComments(Class)— recursively walks fields, resolves path (CONFIG_MODE + @path), and populates the comments map from @Comment/@Comments annotations.internalSave()— removed inline comment collection (now handled bycollectComments).internalLoad()— addedclearComments()+collectComments(getClass())beforesaveToYaml().save(boolean withComments)— changed toclearComments()unconditionally, thencollectComments()only whenwithComments=true.