Feature/gherkin by blacelle · Pull Request #1649 · diffplug/spotless

blacelle · 2023-04-01T18:25:24Z

This follows the work in #928 (thanks @jamietanna).

It is reworked to:

be synced with main
Rely on gherkin-utils core module
Lost ability to customize the indentation through this Gherkin formatter. It should remain available through standard Spotless indentation
Added maven integration

As part of diffplug#907, we want to be able to format our Gherkin source files automagically. To do this, we can utilise the upstream gherkin-formatter project to do the heavy lifting, and add a few test cases within this project to make sure that functionality looks correct. We're calling this a `simple` formatter as it doesn't allow much to be configured other than the indentation size in spaces.

As we've created a Gherkin formatter as part of diffplug#907, we should make it possible to use it natively in Gradle, which requires we add it as a new supported type in `SpotlessExtension`.

jamietanna · 2023-04-01T18:53:23Z

Thanks for this, but note that there are some issues upstream with how it treats certain things like whitespace and tables, which is also what blocked my original PR with my library 😅

nedtwigg · 2023-04-05T18:28:43Z

@blacelle Would you like me to merge this now, or do you want to wait for cucumber/gherkin-utils#20?

nedtwigg

Instead of gherkin { simple(), I would name it gherkin { gherkinUtils().

blacelle · 2023-04-05T19:00:29Z

I would prefer merging at your earliest convenience. Let me implement the requested changes.

blacelle · 2023-04-05T19:10:46Z

This should be OK. Thanks @nedtwigg

…s merged.

nedtwigg · 2023-04-06T03:50:29Z

Published in plugin-gradle 6.18.0 and plugin-maven 2.36.0.

This MR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [flow-bin](https://github.com/flowtype/flow-bin) ([changelog](https://github.com/facebook/flow/blob/master/Changelog.md)) | devDependencies | minor | [`^0.206.0` -> `^0.214.0`](https://renovatebot.com/diffs/npm/flow-bin/0.206.0/0.214.0) | | [org.liquibase.ext:liquibase-hibernate5](https://github.com/liquibase/liquibase-hibernate/wiki) ([source](https://github.com/liquibase/liquibase-hibernate)) | build | minor | `4.21.1` -> `4.22.0` | | [org.liquibase:liquibase-maven-plugin](http://www.liquibase.org/liquibase-maven-plugin) ([source](https://github.com/liquibase/liquibase)) | build | minor | `4.21.1` -> `4.23.0` | | [com.vladsch.flexmark:flexmark-all](https://github.com/vsch/flexmark-java) | compile | patch | `0.64.4` -> `0.64.8` | | [com.diffplug.spotless:spotless-maven-plugin](https://github.com/diffplug/spotless) | build | minor | `2.36.0` -> `2.38.0` | --- ### Release Notes <details> <summary>flowtype/flow-bin</summary> ### [`v0.214.0`](flow/flow-bin@a8d35e6...ca11e28) [Compare Source](flow/flow-bin@a8d35e6...ca11e28) ### [`v0.213.1`](flow/flow-bin@656b64a...a8d35e6) [Compare Source](flow/flow-bin@656b64a...a8d35e6) ### [`v0.213.0`](flow/flow-bin@733e908...656b64a) [Compare Source](flow/flow-bin@733e908...656b64a) ### [`v0.212.0`](flow/flow-bin@d057186...733e908) [Compare Source](flow/flow-bin@d057186...733e908) ### [`v0.211.1`](flow/flow-bin@669f2d7...d057186) [Compare Source](flow/flow-bin@669f2d7...d057186) ### [`v0.211.0`](flow/flow-bin@c0f5f12...669f2d7) [Compare Source](flow/flow-bin@c0f5f12...669f2d7) ### [`v0.210.2`](flow/flow-bin@6dbf435...c0f5f12) [Compare Source](flow/flow-bin@6dbf435...c0f5f12) ### [`v0.210.1`](flow/flow-bin@572b4ff...6dbf435) [Compare Source](flow/flow-bin@572b4ff...6dbf435) ### [`v0.210.0`](flow/flow-bin@026a117...572b4ff) [Compare Source](flow/flow-bin@026a117...572b4ff) ### [`v0.209.0`](flow/flow-bin@b1689a0...026a117) [Compare Source](flow/flow-bin@b1689a0...026a117) ### [`v0.208.1`](flow/flow-bin@1e8564c...b1689a0) [Compare Source](flow/flow-bin@1e8564c...b1689a0) ### [`v0.208.0`](flow/flow-bin@97db57b...1e8564c) [Compare Source](flow/flow-bin@97db57b...1e8564c) ### [`v0.207.0`](flow/flow-bin@7bf1c0e...97db57b) [Compare Source](flow/flow-bin@7bf1c0e...97db57b) </details> <details> <summary>liquibase/liquibase-hibernate</summary> ### [`v4.22.0`](https://github.com/liquibase/liquibase-hibernate/releases/tag/v4.22.0) [Compare Source](liquibase/liquibase-hibernate@v4.21.1...v4.22.0) Support for Liquibase 4.22.0. #### What's Changed - Fix diff changelog is removing unique constraint since 4.21.0 (hibernate6 + postgresql) by [@filipelautert](https://github.com/filipelautert) in liquibase/liquibase-hibernate#480 - add Support for Hibernate EnversSettings revision_field_name and revision_type_field_name by [@lorenzbaier](https://github.com/lorenzbaier) in liquibase/liquibase-hibernate#488 - Bump spring.version from 6.0.8 to 6.0.9 by [@dependabot](https://github.com/dependabot) in liquibase/liquibase-hibernate#490 #### New Contributors - [@lorenzbaier](https://github.com/lorenzbaier) made their first contribution in liquibase/liquibase-hibernate#488 **Full Changelog**: liquibase/liquibase-hibernate@v4.21.0...v4.22.0 </details> <details> <summary>liquibase/liquibase</summary> ### [`v4.23.0`](https://github.com/liquibase/liquibase/blob/HEAD/changelog.txt#Liquibase-4230-is-a-major-release) [Compare Source](liquibase/liquibase@v4.22.0...v4.23.0) ### [`v4.22.0`](https://github.com/liquibase/liquibase/blob/HEAD/changelog.txt#Liquibase-v4220-is-a-major-release) [Compare Source](liquibase/liquibase@v4.21.1...v4.22.0) </details> <details> <summary>vsch/flexmark-java</summary> ### [`v0.64.6`](vsch/flexmark-java@0.64.4...0.64.6) [Compare Source](vsch/flexmark-java@0.64.4...0.64.6) </details> <details> <summary>diffplug/spotless</summary> ### [`v2.38.0`](https://github.com/diffplug/spotless/blob/HEAD/CHANGES.md#2380---2023-04-06) ##### Added - Support configuration of mirrors for P2 repositories in `EquoBasedStepBuilder` ([#1629](diffplug/spotless#1629)). - The `style` option in Palantir Java Format ([#1654](diffplug/spotless#1654)). - Added formatter for Gherkin feature files ([#1649](diffplug/spotless#1649)). ##### Changes - **POTENTIALLY BREAKING** Converted `googleJavaFormat` to a compile-only dependency and drop support for versions < `1.8`. ([#1630](diffplug/spotless#1630)) - Bump default `cleanthat` version to latest `2.6` -> `2.13`. ([#1589](diffplug/spotless#1589) and [#1661](diffplug/spotless#1661)) - Bump default `diktat` version `1.2.4.2` -> `1.2.5`. ([#1631](diffplug/spotless#1631)) - Bump default `flexmark` version `0.62.2` -> `0.64.0`. ([#1302](diffplug/spotless#1302)) - Bump default `googleJavaFormat` version `1.15.0` -> `1.16.0`. ([#1630](diffplug/spotless#1630)) - Bump default `scalafmt` version `3.7.1` -> `3.7.3`. ([#1584](diffplug/spotless#1584)) - Bump default Eclipse formatters for the 2023-03 release. ([#1662](diffplug/spotless#1662)) - JDT and GrEclipse `4.26` -> `4.27` - Improve GrEclipse error reporting. ([#1660](diffplug/spotless#1660)) - CDT `11.0` -> `11.1` ### [`v2.37.0`](https://github.com/diffplug/spotless/blob/HEAD/CHANGES.md#2370---2023-03-13) ##### Added - You can now put the filename into a license header template with `$FILE`. ([#1605](diffplug/spotless#1605) fixes [#1147](diffplug/spotless#1147)) ##### Changes - We are now opting in to Gradle's new stable configuration cache. ([#1591](diffplug/spotless#1591)) - Adopt [Equo Solstice OSGi and p2 shim](https://github.com/equodev/equo-ide/tree/main/solstice) to update all Eclipse-based plugins. ([#1524](diffplug/spotless#1524)) - Eclipse JDT now supports `4.9` through `4.26`. Also we now recommend dropping the last `.0`, e.g. `4.26` instead of `4.26.0`, you'll get warnings to help you switch. - Eclipse Groovy now supports `4.18` through `4.26`. Also we now recommend dropping the last `.0`, e.g. `4.26` instead of `4.26.0`, you'll get warnings to help you switch. - Eclipse CDT now supports `10.6` through `11.0`. - Eclipse WTP is still WIP at [#1622](diffplug/spotless#1622). </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever MR is behind base branch, or you tick the rebase/retry checkbox. 👻 **Immortal**: This MR will be recreated if closed unmerged. Get [config help](https://github.com/renovatebot/renovate/discussions) if that's undesired. --- - [ ] If you want to rebase/retry this MR, check this box --- This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).

jamietannaand others added 5 commits September 7, 2021 08:48

Add Gradle bindings for Gherkin formatter
184aa5e
As we've created a Gherkin formatter as part of diffplug#907, we should make it possible to use it natively in Gradle, which requires we add it as a new supported type in `SpotlessExtension`.

Add Gherkin formatter changes to CHANGES
6f0a35c

Merge remote-tracking branch 'origin/main' into feature/gherkin
8d19346

Rework based on Gherkin-utils
39e4095

blacelle commented Apr 1, 2023
View reviewed changes

Comment thread.editorconfig

Fix MD related files
1023d8c

blacelle mentioned this pull request Apr 2, 2023
[java] Improve comments prettyPrinting cucumber/gherkin-utils#20
Merged

blacelle added 3 commits April 2, 2023 13:03

Fix tests
3a1652a

Fix style
7661516

Fix spotbugs
9076bfb

nedtwigg mentioned this pull request Apr 5, 2023
Implement Gherkin formatting plugin #928
Closed

nedtwigg requested changes Apr 5, 2023
View reviewed changes

Comment threadplugin-gradle/README.md
Comment threadplugin-maven/CHANGES.md Outdated
Comment threadCHANGES.md Outdated

blacelle added 3 commits April 5, 2023 23:02

Merge remote-tracking branch 'origin/main' into feature/gherkin
551e4b8

Rename simple to gherkinUtils
86fc942

Add link to homepage and changelog
9bc36a0

blacelle requested a review from nedtwigg April 5, 2023 19:10

nedtwigg added 5 commits April 5, 2023 14:13

Rename all the GherkinSimple classes to GherkinUtils.
ac4884e

Missing header update in plugin-maven/README.
aefa8c8

Update the root README table.
8a4cee9

Rename the test to match the rest.
0514546

Terrible trailing space is needed untilcucumber/gherkin-utils#20get…
5bf01af
…s merged.

nedtwigg approved these changes Apr 5, 2023
View reviewed changes

Merge branch 'main' into feature/gherkin
77190d4

nedtwigg enabled auto-merge April 5, 2023 22:01

nedtwigg merged commit 4ca8189 into diffplug:mainApr 5, 2023

blacelle deleted the feature/gherkin branch April 6, 2023 04:40

jamietanna mentioned this pull request May 5, 2023
Implement Gherkin formatting plugin #907
Closed

nedtwigg mentioned this pull request May 17, 2023
Use custom source sets and compile-only dependencies instead of reflection #524
Closed

nedtwigg mentioned this pull request Jun 2, 2026
Add asciidoc formatter for AsciiDoc files #2955
Closed

Navigation Menu

Uh oh!

Feature/gherkin - #1649

Feature/gherkin#1649
nedtwigg merged 18 commits into
diffplug:mainfrom
blacelle:feature/gherkin

blacelle commented Apr 1, 2023

Uh oh!

Uh oh!

jamietanna commented Apr 1, 2023

Uh oh!

nedtwigg commented Apr 5, 2023

Uh oh!

nedtwigg left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

blacelle commented Apr 5, 2023•
edited
Loading

Uh oh!

blacelle commented Apr 5, 2023

Uh oh!

nedtwigg commented Apr 6, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

blacelle commented Apr 1, 2023

Uh oh!

Uh oh!

jamietanna commented Apr 1, 2023

Uh oh!

nedtwigg commented Apr 5, 2023

Uh oh!

nedtwigg left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

blacelle commented Apr 5, 2023• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

blacelle commented Apr 5, 2023

Uh oh!

nedtwigg commented Apr 6, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

blacelle commented Apr 5, 2023•
edited
Loading