Keep comments in toml file

Environment:

nl.littlerobots.version-catalog-update: 0.2.1 com.github.ben-manes.versions: 0.41.0 Gradle: 7.3.2

libs.versions.toml:

[versions]
# An important explanation of choosing this version
externalDependency = "1.0-fix"

Scenario:

./gradlew versionCatalogUpdate --no-configuration-cache

Result:

libs.versions.toml:

[versions]
externalDependency = "<the latest version here>"

Expected behavior:

The plugin can’t know about semantics but shouldn’t erase it from the config. Here is the source of truth for versions. This is why we keep knowledge about versions here.

libs.versions.toml:

[versions]
# An important explanation of choosing this version
externalDependency = "<the latest version here>"

[eugene-krivobokov]

It’s a pity. It seems a blocker for us because we have loads of comments as described in expected behavior. I’d like to use it in automation with minimal human interaction.

As I understand, this might add some clarifications https://github.com/toml-lang/toml/issues/836 for the problem. Preserving comments looks technically possible but needs to be done in a parser.

[hvisser]

Thanks for that, I’ve checked out a few and they are either not compliant with the current toml spec and fail on parsing the syntax Gradle is using, or they skip comments. I did a quick check on ktoml and it seems that they also skip comments (and that project seems to be in an early state).

I’ll try the second pass route first, it might not be that bad as I thought initially given the restricted syntax of the Gradle toml file.