@cucumber/messages - npm Package Compare versions

Comparing version 20.0.0 to 21.0.0

dist/cjs/src/IdGenerator.d.ts

@@ -1,4 +0,4 @@
-export declare type NewId = () => string;
+export type NewId = () => string;
 export declare function uuid(): NewId;
 export declare function incrementing(): NewId;
 //# sourceMappingURL=IdGenerator.d.ts.map

dist/cjs/src/messages.d.ts

@@ -35,2 +35,6 @@ import 'reflect-metadata';
 }
+export declare class Exception {
+    type: string;
+    message?: string;
+}
 export declare class GherkinDocument {
@@ -285,2 +289,3 @@ uri?: string;
     timestamp: Timestamp;
+    exception?: Exception;
 }
@@ -300,2 +305,3 @@ export declare class TestRunStarted {
     status: TestStepResultStatus;
+    exception?: Exception;
 }
@@ -302,0 +308,0 @@ export declare class TestStepStarted {

dist/cjs/src/messages.js

@@ -9,4 +9,4 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TestStepFinished = exports.TestRunStarted = exports.TestRunFinished = exports.TestCaseStarted = exports.TestCaseFinished = exports.TestStep = exports.StepMatchArgumentsList = exports.StepMatchArgument = exports.Group = exports.TestCase = exports.StepDefinitionPattern = exports.StepDefinition = exports.JavaStackTraceElement = exports.JavaMethod = exports.SourceReference = exports.Source = exports.PickleTag = exports.PickleTableRow = exports.PickleTableCell = exports.PickleTable = exports.PickleStepArgument = exports.PickleStep = exports.PickleDocString = exports.Pickle = exports.ParseError = exports.ParameterType = exports.Product = exports.Git = exports.Ci = exports.Meta = exports.Location = exports.Hook = exports.Tag = exports.TableRow = exports.TableCell = exports.Step = exports.Scenario = exports.RuleChild = exports.Rule = exports.FeatureChild = exports.Feature = exports.Examples = exports.DocString = exports.DataTable = exports.Comment = exports.Background = exports.GherkinDocument = exports.Envelope = exports.Duration = exports.Attachment = void 0;
-exports.TestStepResultStatus = exports.StepKeywordType = exports.StepDefinitionPatternType = exports.SourceMediaType = exports.PickleStepType = exports.AttachmentContentEncoding = exports.UndefinedParameterType = exports.Timestamp = exports.TestStepStarted = exports.TestStepResult = void 0;
+exports.TestRunStarted = exports.TestRunFinished = exports.TestCaseStarted = exports.TestCaseFinished = exports.TestStep = exports.StepMatchArgumentsList = exports.StepMatchArgument = exports.Group = exports.TestCase = exports.StepDefinitionPattern = exports.StepDefinition = exports.JavaStackTraceElement = exports.JavaMethod = exports.SourceReference = exports.Source = exports.PickleTag = exports.PickleTableRow = exports.PickleTableCell = exports.PickleTable = exports.PickleStepArgument = exports.PickleStep = exports.PickleDocString = exports.Pickle = exports.ParseError = exports.ParameterType = exports.Product = exports.Git = exports.Ci = exports.Meta = exports.Location = exports.Hook = exports.Tag = exports.TableRow = exports.TableCell = exports.Step = exports.Scenario = exports.RuleChild = exports.Rule = exports.FeatureChild = exports.Feature = exports.Examples = exports.DocString = exports.DataTable = exports.Comment = exports.Background = exports.GherkinDocument = exports.Exception = exports.Envelope = exports.Duration = exports.Attachment = void 0;
+exports.TestStepResultStatus = exports.StepKeywordType = exports.StepDefinitionPatternType = exports.SourceMediaType = exports.PickleStepType = exports.AttachmentContentEncoding = exports.UndefinedParameterType = exports.Timestamp = exports.TestStepStarted = exports.TestStepResult = exports.TestStepFinished = void 0;
 var class_transformer_1 = require("class-transformer");
@@ -91,2 +91,9 @@ require("reflect-metadata");
 exports.Envelope = Envelope;
+var Exception = /** @class */ (function () {
+    function Exception() {
+        this.type = '';
+    }
+    return Exception;
+}());
+exports.Exception = Exception;
 var GherkinDocument = /** @class */ (function () {
@@ -665,2 +672,5 @@ function GherkinDocument() {
     ], TestRunFinished.prototype, "timestamp", void 0);
+    __decorate([
+        (0, class_transformer_1.Type)(function () { return Exception; })
+    ], TestRunFinished.prototype, "exception", void 0);
     return TestRunFinished;
@@ -703,2 +713,5 @@ }());
     ], TestStepResult.prototype, "duration", void 0);
+    __decorate([
+        (0, class_transformer_1.Type)(function () { return Exception; })
+    ], TestStepResult.prototype, "exception", void 0);
     return TestStepResult;
@@ -705,0 +718,0 @@ }());

dist/cjs/src/version.d.ts

@@ -1,2 +0,2 @@
-export declare const version = "20.0.0";
+export declare const version = "21.0.0";
 //# sourceMappingURL=version.d.ts.map

dist/cjs/src/version.js

@@ -5,3 +5,3 @@ "use strict";
 // This file is automatically generated using npm scripts
-exports.version = '20.0.0';
+exports.version = '21.0.0';
 //# sourceMappingURL=version.js.map

dist/esm/src/IdGenerator.d.ts

@@ -1,4 +0,4 @@
-export declare type NewId = () => string;
+export type NewId = () => string;
 export declare function uuid(): NewId;
 export declare function incrementing(): NewId;
 //# sourceMappingURL=IdGenerator.d.ts.map

dist/esm/src/messages.d.ts

@@ -35,2 +35,6 @@ import 'reflect-metadata';
 }
+export declare class Exception {
+    type: string;
+    message?: string;
+}
 export declare class GherkinDocument {
@@ -285,2 +289,3 @@ uri?: string;
     timestamp: Timestamp;
+    exception?: Exception;
 }
@@ -300,2 +305,3 @@ export declare class TestRunStarted {
     status: TestStepResultStatus;
+    exception?: Exception;
 }
@@ -302,0 +308,0 @@ export declare class TestStepStarted {

dist/esm/src/messages.js

@@ -78,2 +78,7 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
 ], Envelope.prototype, "undefinedParameterType", void 0);
+export class Exception {
+    constructor() {
+        this.type = '';
+    }
+}
 export class GherkinDocument {
@@ -557,2 +562,5 @@ constructor() {
 ], TestRunFinished.prototype, "timestamp", void 0);
+__decorate([
+    Type(() => Exception)
+], TestRunFinished.prototype, "exception", void 0);
 export class TestRunStarted {
@@ -589,2 +597,5 @@ constructor() {
 ], TestStepResult.prototype, "duration", void 0);
+__decorate([
+    Type(() => Exception)
+], TestStepResult.prototype, "exception", void 0);
 export class TestStepStarted {
@@ -591,0 +602,0 @@ constructor() {

dist/esm/src/version.d.ts

@@ -1,2 +0,2 @@
-export declare const version = "20.0.0";
+export declare const version = "21.0.0";
 //# sourceMappingURL=version.d.ts.map

dist/esm/src/version.js

 // This file is automatically generated using npm scripts
-export const version = '20.0.0';
+export const version = '21.0.0';
 //# sourceMappingURL=version.js.map

package.json

 {
   "name": "@cucumber/messages",
-  "version": "20.0.0",
+  "version": "21.0.0",
   "description": "JSON schema-based messages for Cucumber's inter-process communication",
@@ -45,9 +45,9 @@ "type": "module",
   "devDependencies": {
-    "@types/mocha": "10.0.0",
-    "@types/node": "18.11.9",
+    "@types/mocha": "10.0.1",
+    "@types/node": "18.11.16",
     "copyfiles": "2.4.1",
-    "mocha": "10.1.0",
+    "mocha": "10.2.0",
     "shx": "^0.3.4",
     "ts-node": "10.9.1",
-    "typescript": "4.8.4"
+    "typescript": "4.9.4"
   },
@@ -54,0 +54,0 @@ "bugs": {

schema/TestRunFinished.json

@@ -11,7 +11,7 @@ {
     "message": {
-      "description": "Error message. Can be a stack trace from a failed `BeforeAll` or `AfterAll`.\n If there are undefined parameter types, the message is simply\n \"The following parameter type(s() are not defined: xxx, yyy\".\n The independent `UndefinedParameterType` messages can be used to generate\n snippets for those parameter types.",
+      "description": "An informative message about the test run. Typically additional information about failure, but not necessarily.",
       "type": "string"
     },
     "success": {
-      "description": "success = StrictModeEnabled ? (failed_count == 0 && ambiguous_count == 0 && undefined_count == 0 && pending_count == 0) : (failed_count == 0 && ambiguous_count == 0)",
+      "description": "A test run is successful if all steps are either passed or skipped, all before/after hooks passed and no other exceptions where thrown.",
       "type": "boolean"
@@ -22,2 +22,6 @@ },
       "description": "Timestamp when the TestRun is finished"
+    },
+    "exception": {
+      "$ref": "./Exception.json",
+      "description": "Any exception thrown during the test run, if any. Does not include exceptions thrown while executing steps."
     }
@@ -24,0 +28,0 @@ },

schema/TestStepFinished.json

@@ -17,3 +17,4 @@ {
         "message": {
-          "type": "string"
+          "type": "string",
+          "description": "An arbitrary bit of information that explains this result. This can be a stack trace of anything else."
         },
@@ -31,2 +32,6 @@ "status": {
           "type": "string"
+        },
+        "exception": {
+          "$ref": "./Exception.json",
+          "description": "Exception thrown while executing this step, if any."
         }
@@ -33,0 +38,0 @@ },

No alert changes

Improved metrics

Total package byte prevSize

249021

0.9%

Number of package files

109

0.93%

Lines of code

4292

1.51%

No dependency changes