Allow to deserialize comments into classes

[bishiboosh]

For a project I'm working on, I need to check if a line has a comment above. Would there be any way (with a custom annotation or something) to actually have the comment in the class ?

(I can look into the current code but I figured you'd have at least some pointers)

[eav-eav-eav]

Sorry currently no and no ETA as stated in #9. It's hard to disambiguate the following situation afaik:

a = 0

# Foo

[[foo]]

Is the "Foo" comment for the whole array of tables or the first entry? Right now the parsing process is completely agnostic to the actual type and personally I'd like to keep it like this (which is why you can use the entries without introducing any custom type), so yeah. However for other types of values it seems feasible?

If you'd like to figure this part out, I'd recommend looking into the following parts:

• TomlElement and its descendants: know the basic components of a toml tree. TomlArray and TomlTable have an annotations field so the comments parsed from the string could be stored here.
• TreeNode and its descendants: know the intermediate representation in the parsing process. May add an annotations field to ArrayNode and KeyNodeas well.
• TomlElementParser: know how the parsing goes, with each type of token its own function (there's a function for comments too so could start from there).
• TomlElementEmitter: know how a TomlElement turns into the corresponding string representation.

[bishiboosh]

I'll try to look into it, having the info in annotations would indeed be sufficient for my use case. In regard to "to what line does the comment applies", this could be configured in the configuration imho. I'll try to find time to work on this when I can and I'll let you know.

[sproctor]

If you're still interested in this, I've published a version with this functionality. It's a drop-in replacement. It has round-trip comment support, TOML 1.1.0 compatible, and some other improvements. https://github.com/sproctor/tomlkt I've also created a PR here.

The artifact is at implementation("com.seanproctor:tomlkt:0.6.0")