Fix comment duplication in config files on 1.18 #483
Merged
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.
This PR fixes comment duplication in config files on 1.18 (#480) by only adding comments when the file is first created.
1.18 adds support for comments, and so it's no longer necessary to add comments every time the server starts. This was the reason for the "duplication" (not actually duplication, it was growing by one line at a time).
Initially I made our wrapper class inherit from YamlConfiguration (which is why I wanted #361 merged, it made that much easier imo), and then I initialized the config objects to either YamlConfiguration or our wrapper class, depending on the server's version. However, I learned afterwards that we still need to add comments when the file is first created, and that is where this solution came from.