From 53670cd1637ceb5c68225d370055bb1589f4697b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Christoph=20L=C3=A4ubrich?= <christoph@laeubi-soft.de>
Date: Sat, 27 Sep 2025 13:08:06 +0200
Subject: [PATCH] Add support to autoformat a gherking file

Fix https://github.com/cucumber/cucumber-eclipse/issues/544
Fix https://github.com/cucumber/cucumber-eclipse/issues/478
---
 .../META-INF/MANIFEST.MF                      |  4 +-
 io.cucumber.eclipse.editor/plugin.xml         | 58 +++++++++++++++++++
 .../format/EditorInputPropertyTester.java     | 32 ++++++++++
 .../editor/format/GherkingFormatHandler.java  | 45 ++++++++++++++
 .../cucumber.eclipse.targetdefinition.target  | 24 +++++++-
 5 files changed, 159 insertions(+), 4 deletions(-)
 create mode 100644 io.cucumber.eclipse.editor/src/io/cucumber/eclipse/editor/format/EditorInputPropertyTester.java
 create mode 100644 io.cucumber.eclipse.editor/src/io/cucumber/eclipse/editor/format/GherkingFormatHandler.java

diff --git a/io.cucumber.eclipse.editor/META-INF/MANIFEST.MF b/io.cucumber.eclipse.editor/META-INF/MANIFEST.MF
index f09c9fde..77a6d14a 100644
--- a/io.cucumber.eclipse.editor/META-INF/MANIFEST.MF
+++ b/io.cucumber.eclipse.editor/META-INF/MANIFEST.MF
@@ -34,7 +34,9 @@ Require-Bundle: org.eclipse.ui;bundle-version="3.5.0",
  org.eclipse.ui.console,
  org.eclipse.ui.workbench.texteditor,
  io.cucumber.tag-expressions,
- org.eclipse.unittest.ui;bundle-version="1.0.0"
+ org.eclipse.unittest.ui;bundle-version="1.0.0",
+ io.cucumber.gherkin-utils;bundle-version="9.0.0",
+ org.eclipse.core.expressions;bundle-version="3.9.500"
 Bundle-RequiredExecutionEnvironment: JavaSE-21
 Automatic-Module-Name: io.cucumber.eclipse.editor
 Bundle-ActivationPolicy: lazy
diff --git a/io.cucumber.eclipse.editor/plugin.xml b/io.cucumber.eclipse.editor/plugin.xml
index 41f94a91..b5f2f7f9 100644
--- a/io.cucumber.eclipse.editor/plugin.xml
+++ b/io.cucumber.eclipse.editor/plugin.xml
@@ -8,6 +8,64 @@
             editorId="org.eclipse.ui.genericeditor.GenericEditor">
       </editorContentTypeBinding>
    	</extension>
+   	
+   	<extension point="org.eclipse.ui.bindings">
+      <key sequence="M1+M2+F"
+            commandId="io.cucumber.eclipse.editor.format"
+            contextId="org.eclipse.ui.textEditorScope"
+            schemeId="org.eclipse.ui.defaultAcceleratorConfiguration" />
+    </extension>
+     <extension point="org.eclipse.ui.menus">
+      <menuContribution
+            allPopups="true"
+            locationURI="popup:org.eclipse.ui.genericeditor.source.menu?after=additions">
+         <command commandId="io.cucumber.eclipse.editor.format">
+            <visibleWhen>
+                <with variable="activeEditorInput">
+                  <adapt type="org.eclipse.core.resources.IResource">
+                     <test
+                           property="org.eclipse.core.resources.contentTypeId"
+                           value="io.cucumber.eclipse.editor.content-type.feature">
+                     </test>
+                  </adapt>
+               </with>
+            </visibleWhen>
+         </command>
+      </menuContribution>
+      </extension>
+    
+    <extension point="org.eclipse.ui.commands">
+      <command
+            categoryId="io.cucumber.eclipse.editor.category"
+            id="io.cucumber.eclipse.editor.format"
+            name="Format Feature File" />
+   </extension>
+
+   
+   <extension point="org.eclipse.ui.handlers">
+      <handler
+            class="io.cucumber.eclipse.editor.format.GherkingFormatHandler"
+            commandId="io.cucumber.eclipse.editor.format">
+         <activeWhen>
+			 <with variable="activePart">
+             <test property="io.cucumber.eclipse.editor.format.isGherkingDocument" value="true">
+               </test>
+            </with>
+         </activeWhen>
+      </handler>
+   	</extension>
+   	
+     <extension
+         point="org.eclipse.core.expressions.propertyTesters">
+      <propertyTester
+            class="io.cucumber.eclipse.editor.format.EditorInputPropertyTester"
+            id="io.cucumber.eclipse.editor.format.editorInputPropertyTester"
+            namespace="io.cucumber.eclipse.editor.format"
+            properties="isGherkingDocument"
+            type="org.eclipse.ui.IWorkbenchPart">
+      </propertyTester>
+   </extension>
+   	
 	 <extension
 	       point="org.eclipse.core.contenttype.contentTypes">
 	    <content-type
diff --git a/io.cucumber.eclipse.editor/src/io/cucumber/eclipse/editor/format/EditorInputPropertyTester.java b/io.cucumber.eclipse.editor/src/io/cucumber/eclipse/editor/format/EditorInputPropertyTester.java
new file mode 100644
index 00000000..af56538f
--- /dev/null
+++ b/io.cucumber.eclipse.editor/src/io/cucumber/eclipse/editor/format/EditorInputPropertyTester.java
@@ -0,0 +1,32 @@
+package io.cucumber.eclipse.editor.format;
+
+import org.eclipse.core.expressions.PropertyTester;
+import org.eclipse.core.filebuffers.FileBuffers;
+import org.eclipse.core.filebuffers.ITextFileBuffer;
+import org.eclipse.core.filebuffers.LocationKind;
+import org.eclipse.ui.IEditorInput;
+import org.eclipse.ui.IEditorPart;
+import org.eclipse.ui.IFileEditorInput;
+
+import io.cucumber.eclipse.editor.document.GherkinEditorDocument;
+
+public class EditorInputPropertyTester extends PropertyTester {
+
+	@Override
+	public boolean test(Object receiver, String property, Object[] args, Object expectedValue) {
+		if (receiver instanceof IEditorPart part) {
+			if ("isGherkingDocument".equals(property)) {
+				IEditorInput editorInput = part.getEditorInput();
+				if (editorInput instanceof IFileEditorInput fileInput) {
+					ITextFileBuffer buffer = FileBuffers.getTextFileBufferManager()
+							.getTextFileBuffer(fileInput.getFile().getFullPath(), LocationKind.IFILE);
+					if (buffer != null) {
+						return GherkinEditorDocument.isCompatible(buffer.getDocument());
+					}
+				}
+			}
+		}
+		return false;
+	}
+
+}
diff --git a/io.cucumber.eclipse.editor/src/io/cucumber/eclipse/editor/format/GherkingFormatHandler.java b/io.cucumber.eclipse.editor/src/io/cucumber/eclipse/editor/format/GherkingFormatHandler.java
new file mode 100644
index 00000000..f1037b3f
--- /dev/null
+++ b/io.cucumber.eclipse.editor/src/io/cucumber/eclipse/editor/format/GherkingFormatHandler.java
@@ -0,0 +1,45 @@
+package io.cucumber.eclipse.editor.format;
+
+import java.util.Optional;
+
+import org.eclipse.core.commands.AbstractHandler;
+import org.eclipse.core.commands.ExecutionEvent;
+import org.eclipse.core.commands.ExecutionException;
+import org.eclipse.core.resources.IFile;
+import org.eclipse.ui.IEditorInput;
+import org.eclipse.ui.IEditorPart;
+import org.eclipse.ui.IFileEditorInput;
+import org.eclipse.ui.IWorkbenchPart;
+import org.eclipse.ui.handlers.HandlerUtil;
+
+import io.cucumber.eclipse.editor.document.GherkinEditorDocument;
+import io.cucumber.gherkin.utils.pretty.Pretty;
+import io.cucumber.gherkin.utils.pretty.Syntax;
+import io.cucumber.messages.types.GherkinDocument;
+
+public class GherkingFormatHandler extends AbstractHandler {
+
+	@Override
+	public Object execute(ExecutionEvent event) throws ExecutionException {
+		IWorkbenchPart part = HandlerUtil.getActivePartChecked(event);
+		if (part instanceof IEditorPart editor) {
+			IEditorInput editorInput = editor.getEditorInput();
+			if (editorInput instanceof IFileEditorInput fileInput) {
+				GherkinEditorDocument document = GherkinEditorDocument.get(fileInput.getFile());
+				if (document != null) {
+					formatDocument(document, fileInput.getFile());
+				}
+			}
+		}
+		return null;
+	}
+
+	private void formatDocument(GherkinEditorDocument document, IFile file) {
+		Optional<GherkinDocument> gherkinDocument = document.getGherkinDocument();
+		if (gherkinDocument.isEmpty()) {
+			return;
+		}
+		String prettyPrint = Pretty.prettyPrint(gherkinDocument.get(), Syntax.gherkin);
+		document.getDocument().set(prettyPrint);
+	}
+}
diff --git a/io.cucumber.eclipse.targetdefinition/cucumber.eclipse.targetdefinition.target b/io.cucumber.eclipse.targetdefinition/cucumber.eclipse.targetdefinition.target
index b8c08d73..e4ba2b88 100644
--- a/io.cucumber.eclipse.targetdefinition/cucumber.eclipse.targetdefinition.target
+++ b/io.cucumber.eclipse.targetdefinition/cucumber.eclipse.targetdefinition.target
@@ -17,7 +17,7 @@
 			<dependency>
 				<groupId>io.cucumber</groupId>
 				<artifactId>gherkin</artifactId>
-				<version>33.0.0</version>
+				<version>33.1.0</version>
 				<type>jar</type>
 			</dependency>
 		</dependencies>
@@ -35,7 +35,7 @@ Export-Package:        *;version="${version}";-noimport:=true
 			<dependency>
 				<groupId>io.cucumber</groupId>
 				<artifactId>cucumber-java</artifactId>
-				<version>7.26.0</version>
+				<version>7.29.0</version>
 				<type>jar</type>
 			</dependency>
 		</dependencies>
@@ -53,7 +53,7 @@ Export-Package:        *;version="${version}";-noimport:=true
 			<dependency>
 				<groupId>io.cucumber</groupId>
 				<artifactId>cucumber-core</artifactId>
-				<version>7.26.0</version>
+				<version>7.29.0</version>
 				<type>jar</type>
 			</dependency>
 		</dependencies>
@@ -100,6 +100,24 @@ Export-Package:        *;version="${version}";-noimport:=true
 			</dependency>
 		</dependencies>
 	</location>
+	<location includeDependencyDepth="infinite" includeDependencyScopes="compile" includeSource="true" missingManifest="generate" type="Maven">
+		<dependencies>
+			<dependency>
+				<groupId>io.cucumber</groupId>
+				<artifactId>gherkin-utils</artifactId>
+				<version>9.0.0</version>
+				<type>jar</type>
+			</dependency>
+		</dependencies>
+		<instructions><![CDATA[
+Bundle-Name:           ${mvnGroupId}:${mvnArtifactId}:${mvnVersion}
+version:               ${version_cleanup;${mvnVersion}}
+Bundle-SymbolicName:   ${mvnGroupId}.${mvnArtifactId}
+Bundle-Version:        ${version}
+Import-Package:        !sun.*,io.cucumber.messages.internal.com.google.gson*,!io.cucumber.messages.internal.*,!org.checkerframework.*,*
+Export-Package:        *;version="${version}";-noimport:=true
+]]></instructions>
+	</location>
 </locations>
 	<targetJRE path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-21"/>
 </target>
\ No newline at end of file