Add location to pickle (#308)

Co-authored-by: David Goss <david@davidgoss.co>

Author: mpkorstanje

CHANGELOG.md

@@ -6,6 +6,8 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
+### Added
+- Add `location` to `Pickle` ([#308](https://github.com/cucumber/messages/pull/308))
 
 ## [30.1.0] - 2025-10-08
 ### Added

cpp/include/messages/cucumber/messages/pickle.hpp

@@ -6,6 +6,7 @@
 
 #include <nlohmann/json.hpp>
 
+#include <cucumber/messages/location.hpp>
 #include <cucumber/messages/pickle_step.hpp>
 #include <cucumber/messages/pickle_tag.hpp>
 
@@ -34,6 +35,7 @@ struct pickle
 {
     std::string id;
     std::string uri;
+    std::optional<cucumber::messages::location> location;
     std::string name;
     std::string language;
     std::vector<cucumber::messages::pickle_step> steps;

cpp/src/lib/messages/cucumber/messages/pickle.cpp

@@ -12,6 +12,7 @@ pickle::to_string() const
 
     cucumber::messages::to_string(oss, "id=", id);
     cucumber::messages::to_string(oss, ", uri=", uri);
+    cucumber::messages::to_string(oss, ", location=", location);
     cucumber::messages::to_string(oss, ", name=", name);
     cucumber::messages::to_string(oss, ", language=", language);
     cucumber::messages::to_string(oss, ", steps=", steps);
@@ -26,6 +27,7 @@ pickle::to_json(json& j) const
 {
     cucumber::messages::to_json(j, camelize("id"), id);
     cucumber::messages::to_json(j, camelize("uri"), uri);
+    cucumber::messages::to_json(j, camelize("location"), location);
     cucumber::messages::to_json(j, camelize("name"), name);
     cucumber::messages::to_json(j, camelize("language"), language);
     cucumber::messages::to_json(j, camelize("steps"), steps);

dotnet/Cucumber.Messages/generated/Pickle.cs

@@ -35,6 +35,10 @@ public sealed class Pickle
      * The uri of the source file
      */
     public string Uri { get; private set; }
+    /**
+     * The location of this pickle in source file. A pickle constructed from `Examples` will point to the example row.
+     */
+    public Location Location { get; private set; }
     /**
      * The name of the pickle
      */
@@ -63,6 +67,7 @@ public sealed class Pickle
     public Pickle(
         string id,
         string uri,
+        Location location,
         string name,
         string language,
         List<PickleStep> steps,
@@ -74,6 +79,7 @@ List<string> astNodeIds
         this.Id = id;
         RequireNonNull<string>(uri, "Uri", "Pickle.Uri cannot be null");
         this.Uri = uri;
+        this.Location = location;
         RequireNonNull<string>(name, "Name", "Pickle.Name cannot be null");
         this.Name = name;
         RequireNonNull<string>(language, "Language", "Pickle.Language cannot be null");
@@ -94,6 +100,7 @@ public override bool Equals(Object o)
         return 
             Id.Equals(that.Id) &&         
             Uri.Equals(that.Uri) &&         
+            Object.Equals(Location, that.Location) &&         
             Name.Equals(that.Name) &&         
             Language.Equals(that.Language) &&         
             Steps.Equals(that.Steps) &&         
@@ -108,6 +115,8 @@ public override int GetHashCode()
           hash = hash * 31 + Id.GetHashCode();
         if (Uri != null)
           hash = hash * 31 + Uri.GetHashCode();
+        if (Location != null)
+          hash = hash * 31 + Location.GetHashCode();
         if (Name != null)
           hash = hash * 31 + Name.GetHashCode();
         if (Language != null)
@@ -126,6 +135,7 @@ public override string ToString()
         return "Pickle{" +
             "id=" + Id +
             ", uri=" + Uri +
+            ", location=" + Location +
             ", name=" + Name +
             ", language=" + Language +
             ", steps=" + Steps +

go/messages.go

@@ -218,6 +218,7 @@ type ParseError struct {
 type Pickle struct {
 	Id         string        `json:"id"`
 	Uri        string        `json:"uri"`
+	Location   *Location     `json:"location,omitempty"`
 	Name       string        `json:"name"`
 	Language   string        `json:"language"`
 	Steps      []*PickleStep `json:"steps"`

java/src/generated/java/io/cucumber/messages/types/Pickle.java

@@ -26,6 +26,7 @@
 public final class Pickle {
     private final String id;
     private final String uri;
+    private final Location location;
     private final String name;
     private final String language;
     private final java.util.List<PickleStep> steps;
@@ -35,6 +36,7 @@ public final class Pickle {
     public Pickle(
         String id,
         String uri,
+        Location location,
         String name,
         String language,
         java.util.List<PickleStep> steps,
@@ -43,6 +45,7 @@ public Pickle(
     ) {
         this.id = requireNonNull(id, "Pickle.id cannot be null");
         this.uri = requireNonNull(uri, "Pickle.uri cannot be null");
+        this.location = location;
         this.name = requireNonNull(name, "Pickle.name cannot be null");
         this.language = requireNonNull(language, "Pickle.language cannot be null");
         this.steps = unmodifiableList(new ArrayList<>(requireNonNull(steps, "Pickle.steps cannot be null")));
@@ -64,6 +67,13 @@ public String getUri() {
         return uri;
     }
 
+    /**
+      * The location of this pickle in source file. A pickle constructed from `Examples` will point to the example row.
+     */
+    public Optional<Location> getLocation() {
+        return Optional.ofNullable(location);
+    }
+
     /**
      * The name of the pickle
      */
@@ -110,6 +120,7 @@ public boolean equals(Object o) {
         return 
             id.equals(that.id) &&         
             uri.equals(that.uri) &&         
+            Objects.equals(location, that.location) &&         
             name.equals(that.name) &&         
             language.equals(that.language) &&         
             steps.equals(that.steps) &&         
@@ -122,6 +133,7 @@ public int hashCode() {
         return Objects.hash(
             id,
             uri,
+            location,
             name,
             language,
             steps,
@@ -135,6 +147,7 @@ public String toString() {
         return "Pickle{" +
             "id=" + id +
             ", uri=" + uri +
+            ", location=" + location +
             ", name=" + name +
             ", language=" + language +
             ", steps=" + steps +

javascript/src/messages.ts

@@ -421,6 +421,9 @@ export class Pickle {
 
   uri: string = ''
 
+  @Type(() => Location)
+  location?: Location
+
   name: string = ''
 
   language: string = ''

jsonschema/messages.md

@@ -1120,6 +1120,13 @@ A unique id for the pickle
 
 The uri of the source file
 
+#### Pickle.location 
+
+* Type: [Location](#location) 
+* Required: no 
+
+The location of this pickle in source file. A pickle constructed from `Examples` will point to the example row.
+
 #### Pickle.name 
 
 * Type: string 

jsonschema/relations.md

@@ -95,6 +95,7 @@ Meta ||..o| Ci: "has a"
 Ci ||..o| Git: "has a"
 ParameterType ||..o| SourceReference: "has a"
 ParseError ||..|| SourceReference: "has a"
+Pickle ||..o| Location: "has a"
 Pickle ||..|{ PickleStep: "has"
 Pickle ||..|{ PickleTag: "has"
 PickleStep ||..o| PickleStepArgument: "has a"

jsonschema/src/Pickle.json

@@ -156,6 +156,10 @@
       "description": "The uri of the source file",
       "type": "string"
     },
+    "location": {
+      "description": "The location of this pickle in source file. A pickle constructed from `Examples` will point to the example row.",
+      "$ref": "./Location.json"
+    },
     "name": {
       "description": "The name of the pickle",
       "type": "string"