Track maintainers found that they wanted to add comments to the tests.toml file to e.g. indicate why a test was not included.
Unfortunately, running configlet sync would re-generate the entire file so any manually added comments were lost.

In this PR we're updating the format of tests.toml files to support adding comments.
We do this by creating a separate table for each test case which has description and include fields.
Tracks are then free to add additional fields, like a comment field, but also any other fields they feel might be useful to them.

configlet has not yet been updated to support this new format, but we hope to do this soon. Sorry for the inconvenience.

For more information, see this discussion: exercism/configlet#186

Implementation

The PR expects the tests.toml files to be in their original format:

# <description>
"<uuid>" = <include>

This is transformed to:

[<uuid>]
description = "<description>"
include = <include>

Example

# one factor has multiples within limit
"361e4e50-c89b-4f60-95ef-5bc5c595490a" = true

becomes

[361e4e50-c89b-4f60-95ef-5bc5c595490a]
description = "one factor has multiples within limit"
include = true

Existing comments

As some tracks have manually added comments to tests, we try to detect them by assuming they are either:

• Added as a line comment before the description (we'll ignore empty lines)
• Added as an inline comment after boolean include value

For any such manually detected comments, we'll add a comment field.

Tracking

exercism/v3-launch#22