Formatter: Allow line breaks between tags

[eglif-roche]

🤔 What's the problem you're trying to solve?

We use tags to add additional information to scenarios.

Example before formatting:

@TestCaseId:D54B3BA4-F45E-4B32-B461-F40F17C9F683
@SpecificationId:7302F799-FAE3-41E5-9377-2E33CE5127E7
@RequirementId:TRQ-1234
@Author:FooUser
@Reviewer:BarUser
Scenario: My fancy test
...

But the prettyTags method replaces the line breaks with spaces, which make the tags quite unreadable.

After formatting:

@TestCaseId:D54B3BA4-F45E-4B32-B461-F40F17C9F683 @SpecificationId:7302F799-FAE3-41E5-9377-2E33CE5127E7 @RequirementId:TRQ-1234 @Author:FooUser @Reviewer:BarUser
Scenario: My fancy test
...

✨ What's your proposed solution?

Either:

• Keep the existing formatting of tags and don't format them
• Always format tags with line breaks (but that would probably be a breaking change for some)
• Provide a way to configure the formatting behavior (similar to e.g. Prettier)

⛏ Have you considered any alternatives or workarounds?

No response

📚 Any additional context?

No response

[mpkorstanje]

Keep the existing formatting of tags and don't format them

I don't think the current GherkinDocument has enough fidelity to retain those line breaks.

Provide a way to configure the formatting behavior (similar to e.g. Prettier)

This would seem like a reasonable suggestion.

Adding a method:

    public static String prettyPrint(GherkinDocument gherkinDocument, Configuration configuration) {

Where the Configuration includes the Syntax and an option to put each tag on its own line should make that possible I think.

Would you like to send a pull request for that?

[mpkorstanje]

I don't think the current GherkinDocument has enough fidelity to retain those line breaks.

Ah. Tags have a location, so it should be possible to retain those positions.

https://github.com/cucumber/messages/blob/main/jsonschema/messages.md#taglocation