YAML comments support #410
Conversation
|
Thanks for this contribution! I would love to have full support for reading comments back from configuration files, but I think this could be a decent stopgap until that work is complete. |
|
I wasn't aware that comments are also supposed to be read back. I might change the way the comments are read back for map keys a bit, but the general concept is there. Edit: made the changes |
|
Any update on this? |
|
no |
Sorry, should've asked differently: "What's stopping this from getting merged?" |
|
time |
This comment was marked as spam.
This comment was marked as spam.
format/yaml/src/main/java/org/spongepowered/configurate/yaml/YamlConstructor.java
Outdated
Show resolved
Hide resolved
| @Override | ||
| protected Object constructObjectNoCheck(final Node yamlNode) { | ||
| //noinspection DataFlowIssue guarenteed NonNull by getSingleData, which load(Reader) uses | ||
| final CommentedConfigurationNode node = CommentedConfigurationNode.root(this.options); |
There was a problem hiding this comment.
I'm really not a fan of the fact that by creating a new root node here, we effectively construct two nodes per node when loading in a file
There was a problem hiding this comment.
You're then mainly talking about the mapping part right? When looking at the differences between a root node and a .node node it looks like only the path and parent differs.
We could add a method that works essentially like attachIfNecessary / parentEnsureAttached, but allows you to set the parent & path as well.
This comment was marked as spam.
This comment was marked as spam.
| protected void loadInternal(final CommentedConfigurationNode node, final BufferedReader reader) { | ||
| node.raw(this.yaml.get().load(reader)); | ||
| // the constructor needs ConfigurationOptions for the to be created nodes | ||
| // and since it's a thread-local, this won't cause any issues | ||
| this.constructor.get().options = node.options(); | ||
| node.from(this.yaml.get().load(reader)); |
There was a problem hiding this comment.
There is a regression here: load returns null when the file is empty, which ConfigurationNode#from can't receive.
This adds support for YAML comments.
Let me know if you want to see changes.