[java] Improve comments prettyPrinting

[blacelle]

This follows the work from cucumber/common#2024 (Thanks @jamietanna ).

It proposes improvments for comments rendering. This is not perfect, but looks better than current behavior (especially over comments after a @Tag, Scenario, etc).

[blacelle]

This is contextual to the integration of this library into Spotless diffplug/spotless#1649

[xeger]

Just a quick note @blacelle that I'm working on a related PR for javascript/ and I've recently restored a bunch of *.feature test fixtures that the JS unit tests employ. These files existed in the monorepo, and got missed when gherkin-utils was moved into its own repo. They may be relevant to your PR.

[blacelle]

Thanks @xeger . This PR is ready since a month, but it seems there is no maintainer to review it.

[blacelle]

@mpkorstanje As you reviewed #16, please have a look to this PR. Thanks

[xeger]

I wonder if it would be useful to harmonize our test cases between languages. How this might look:

1. new directory testdata/pretty/before and testdata/pretty/after
2. @blacelle move our examples into before/foo.feature and after/foo.feature
3. we read these files from disk in our JS/Java test code, and both suites execute all examples

The benefit is, we ensure that both languages have identical treatment of comments when prettying. I am not sure how important this behavior is.

If interested, I can get this started on #16.

[blacelle]

The benefit is, we ensure that both languages have identical treatment of comments when prettying. I am not sure how important this behavior is.

This would definitely be a good thing.

---

I would be happy to follow this structure, preferable in a separate PR. But I do not get how to contribute to this repository as this PR seems stuck :S.

[xeger]

LGTM. The JS implementation has gotten out of sync with these improvements, but we can achieve parity once we have a shared body of testdata files to help us correlate between the languages' behavior.

[blacelle]

@xeger @aslakhellesoy How can I move forward with this PR?

[aslakhellesoy]

Hi @blacelle,

Thanks for your making your first contribution to Cucumber, and welcome to the Cucumber committers team! You can now push directly to this repo and all other repos under the cucumber organization! 🍾

In return for this generous offer we hope you will:

• ✅ Continue to use branches and pull requests. When someone on the core team approves a pull request (yours or someone else's), you're welcome to merge it yourself.
• 💚 Commit to setting a good example by following and upholding our code of conduct in your interactions with other collaborators and users.
• 💬 Join the community Slack channel to meet the rest of the team and make yourself at home.
• ℹ️ Don't feel obliged to help, just do what you can if you have the time and the energy.
• 🙋 Ask if you need anything. We're looking for feedback about how to make the project more welcoming, so please tell us!

On behalf of the Cucumber core team,
Aslak Hellesøy
Creator of Cucumber

[blacelle]

Thanks a lot @xeger

[xeger]

Thank you for your contribution. I'll work on releasing a new JAR over the weekend.