vitest-cucumber-plugin 0.1.3 → 0.1.5

package/CONTRIBUTING.md

@@ -36,7 +36,16 @@ branching model.  The 'main' branch the release branch and is only pushed to dur
 
 ## Doing a release
 
-1. git flow release start <version>
-1. Update version number in package.json
-1. Add the release notes to [RELEASE_NOTES.md](RELEASE_NOTES.md).
-1. git flow release finish <version>
+1. ```$ VERSION=<version>```
+1. ```$ git flow release start v$VERSION```
+1. ```$ npm pkg set version=$VERSION```
+1. ```$ sed -i "1s/^/* v$VERSION : \!\!\! ADD RELEASE NOTE HERE \!\!\!\n/" RELEASE_NOTES.md```
+1. ```$ emacs -nw RELEASE_NOTES.md```
+2. ```$ npm test```
+1. ```$ git add . ; git commit -m v$VERSION```
+3. ```$ git flow release finish v$VERSION```
+4. ```$ git push```
+5. ```$ git checkout main```
+6. ```$ git push```
+7. ```$ git push origin v$VERSION```
+8. ```$ npm publish```

package/README.md

@@ -5,7 +5,7 @@ Plugin for [Vitest](https://vitest.dev/) to allow tests to be written in [Cucumb
 ## Installation
 
 ```
-$ npm install --save-dev SamZiegler/vitest-cucumber-plugin
+$ npm install --save-dev vitest-cucumber-plugin
 ```
 
 ## Usage
@@ -109,5 +109,4 @@ work, but this configuration isn't tested.
 This plugin is not yet feature complete.  Here is the list of features from Cucumber which aren't yet implemented:
 * Rule keyword
 * Doc strings
-* Data Table escape characters
 * Boolean expression support for tags

package/RELEASE_NOTES.md

@@ -1,3 +1,5 @@
+* v0.1.5 : Implemented escape characters for Data Tables
+* v0.1.4 : Changed README to point to RPM registry
 * v0.1.3 : Import modules from generated code to make sure they are processed correctly
 * v0.1.2 : Set default log level to warn and make it configurable
 * v0.1.1 : Use root dir from the config to find step_definitions dir

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "vitest-cucumber-plugin",
-    "version": "0.1.3",
+    "version": "0.1.5",
     "description": "Plugin for Vitest which allows for tests to be written in Cucumber format.",
     "keywords": [
         "vite",
@@ -30,5 +30,5 @@
         "@types/lodash": "^4.14.194",
         "rollup": "^3.20.7"
     },
-    "repository" : "https://github.com/SamZiegler/vitest-cucumber-plugin.git"
+    "repository": "https://github.com/SamZiegler/vitest-cucumber-plugin.git"
 }

package/src/gherkin.js

@@ -40,9 +40,12 @@ const log = pino();
 
 log.level = 'warn';
 
+const setLogLevel = (logLevel) => { log.level = logLevel; };
+
 var logger = /*#__PURE__*/Object.freeze({
 	__proto__: null,
-	log: log
+	log: log,
+	setLogLevel: setLogLevel
 });
 
 var require$$2 = /*@__PURE__*/getAugmentedNamespace(logger);
@@ -63,10 +66,12 @@ var require$$2 = /*@__PURE__*/getAugmentedNamespace(logger);
 	  colon : ':',
 	  step : '*',
 	  pipe : '|',
-	  backSlash : '\\',
+	  escapedPipe : '\\|',
+	  escapedNewline : '\\n',
+	  escapedBackSlash : '\\\\',
 	  scenarioOutline : ['Scenario Outline','Scenario Template'],
 	  word : {
-	    match : /[^ \t\n:|\\]+/,
+	    match : /[^ \t\n\:\|\@\*]+/,
 	    type : moo.keywords({
 	      feature : 'Feature',
 	      examples : ['Examples','Scenarios'],
@@ -127,7 +132,15 @@ var require$$2 = /*@__PURE__*/getAugmentedNamespace(logger);
 	    {"name": "dataTable", "symbols": ["dataTable", "dataTableRow"], "postprocess": data => fp.concat(data[0],[data[1]])},
 	    {"name": "dataTableRow", "symbols": ["_", (lexer.has("pipe") ? {type: "pipe"} : pipe), "dataTableColumns", (lexer.has("newline") ? {type: "newline"} : newline)], "postprocess": data => data[2]},
 	    {"name": "dataTableColumns", "symbols": [], "postprocess": data => []},
-	    {"name": "dataTableColumns", "symbols": ["dataTableColumns", "text", (lexer.has("pipe") ? {type: "pipe"} : pipe)], "postprocess": data => fp.concat(data[0],data[1].trim())},
+	    {"name": "dataTableColumns", "symbols": ["dataTableColumns", "dataTableColumnText", (lexer.has("pipe") ? {type: "pipe"} : pipe)], "postprocess": data => fp.concat(data[0],data[1].trim())},
+	    {"name": "dataTableColumnText", "symbols": [], "postprocess": data => ''},
+	    {"name": "dataTableColumnText", "symbols": ["dataTableColumnText", "escapedColumnCharaters"], "postprocess": data => data[0]+data[1]},
+	    {"name": "dataTableColumnText", "symbols": ["dataTableColumnText", "keywords"], "postprocess": data => data[0]+data[1]},
+	    {"name": "dataTableColumnText", "symbols": ["dataTableColumnText", (lexer.has("word") ? {type: "word"} : word)], "postprocess": data => data[0]+data[1].value},
+	    {"name": "dataTableColumnText", "symbols": ["dataTableColumnText", (lexer.has("ws") ? {type: "ws"} : ws)], "postprocess": data => data[0]+data[1].value},
+	    {"name": "escapedColumnCharaters", "symbols": [(lexer.has("escapedPipe") ? {type: "escapedPipe"} : escapedPipe)], "postprocess": data => '|'},
+	    {"name": "escapedColumnCharaters", "symbols": [(lexer.has("escapedBackSlash") ? {type: "escapedBackSlash"} : escapedBackSlash)], "postprocess": data => '\\'},
+	    {"name": "escapedColumnCharaters", "symbols": [(lexer.has("escapedNewline") ? {type: "escapedNewline"} : escapedNewline)], "postprocess": data => '\n'},
 	    {"name": "steps", "symbols": ["stepAndTable", "moreSteps"], "postprocess": data => fp.concat(data[0],data[1])},
 	    {"name": "moreSteps", "symbols": [], "postprocess": data => []},
 	    {"name": "moreSteps", "symbols": ["moreSteps", "stepAndTable"], "postprocess": data => fp.concat(data[0],data[1])},
@@ -138,12 +151,17 @@ var require$$2 = /*@__PURE__*/getAugmentedNamespace(logger);
 	    {"name": "text", "symbols": [], "postprocess": data => ''},
 	    {"name": "text", "symbols": ["text", (lexer.has("word") ? {type: "word"} : word)], "postprocess": data => data[0]+data[1].value},
 	    {"name": "text", "symbols": ["text", (lexer.has("ws") ? {type: "ws"} : ws)], "postprocess": data => data[0]+data[1].value},
-	    {"name": "text", "symbols": ["text", (lexer.has("step") ? {type: "step"} : step)], "postprocess": data => data[0]+data[1].value},
-	    {"name": "text", "symbols": ["text", (lexer.has("colon") ? {type: "colon"} : colon)], "postprocess": data => data[0]+data[1].value},
-	    {"name": "text", "symbols": ["text", (lexer.has("example") ? {type: "example"} : example)], "postprocess": data => data[0]+data[1].value},
-	    {"name": "text", "symbols": ["text", (lexer.has("examples") ? {type: "examples"} : examples)], "postprocess": data => data[0]+data[1].value},
-	    {"name": "text", "symbols": ["text", (lexer.has("scenarioOutline") ? {type: "scenarioOutline"} : scenarioOutline)], "postprocess": data => data[0]+data[1].value},
-	    {"name": "text", "symbols": ["text", (lexer.has("background") ? {type: "background"} : background)], "postprocess": data => data[0]+data[1].value},
+	    {"name": "text", "symbols": ["text", "keywords"], "postprocess": data => data[0]+data[1]},
+	    {"name": "text", "symbols": ["text", (lexer.has("pipe") ? {type: "pipe"} : pipe)], "postprocess": data => data[0]+data[1].value},
+	    {"name": "text", "symbols": ["text", (lexer.has("escapedPipe") ? {type: "escapedPipe"} : escapedPipe)], "postprocess": data => data[0]+data[1].value},
+	    {"name": "text", "symbols": ["text", (lexer.has("escapedNewline") ? {type: "escapedNewline"} : escapedNewline)], "postprocess": data => data[0]+data[1].value},
+	    {"name": "text", "symbols": ["text", (lexer.has("escapedBackSlash") ? {type: "escapedBackSlash"} : escapedBackSlash)], "postprocess": data => data[0]+data[1].value},
+	    {"name": "keywords", "symbols": [(lexer.has("step") ? {type: "step"} : step)], "postprocess": data => data[0].value},
+	    {"name": "keywords", "symbols": [(lexer.has("colon") ? {type: "colon"} : colon)], "postprocess": data => data[0].value},
+	    {"name": "keywords", "symbols": [(lexer.has("example") ? {type: "example"} : example)], "postprocess": data => data[0].value},
+	    {"name": "keywords", "symbols": [(lexer.has("examples") ? {type: "examples"} : examples)], "postprocess": data => data[0].value},
+	    {"name": "keywords", "symbols": [(lexer.has("scenarioOutline") ? {type: "scenarioOutline"} : scenarioOutline)], "postprocess": data => data[0].value},
+	    {"name": "keywords", "symbols": [(lexer.has("background") ? {type: "background"} : background)], "postprocess": data => data[0].value},
 	    {"name": "bolText", "symbols": [(lexer.has("ws") ? {type: "ws"} : ws), (lexer.has("word") ? {type: "word"} : word)], "postprocess": data => data[1].value},
 	    {"name": "bolText", "symbols": [(lexer.has("word") ? {type: "word"} : word)], "postprocess": data => data[0].value},
 	    {"name": "freeform", "symbols": [], "postprocess": data => ''},

package/src/gherkin.ne

@@ -10,10 +10,12 @@ const lexer = moo.compile({
   colon : ':',
   step : '*',
   pipe : '|',
-  backSlash : '\\',
+  escapedPipe : '\\|',
+  escapedNewline : '\\n',
+  escapedBackSlash : '\\\\',
   scenarioOutline : ['Scenario Outline','Scenario Template'],
   word : {
-    match : /[^ \t\n:|\\]+/,
+    match : /[^ \t\n\:\|\@\*]+/,
     type : moo.keywords({
       feature : 'Feature',
       examples : ['Examples','Scenarios'],
@@ -90,7 +92,17 @@ dataTable -> null {% data => [] %}
 dataTableRow -> _ %pipe dataTableColumns %newline {% data => data[2] %}
 
 dataTableColumns -> null {% data => [] %}
-  | dataTableColumns text %pipe {% data => fp.concat(data[0],data[1].trim()) %}
+  | dataTableColumns dataTableColumnText %pipe {% data => fp.concat(data[0],data[1].trim()) %}
+
+dataTableColumnText -> null {% data => '' %}
+  | dataTableColumnText escapedColumnCharaters {% data => data[0]+data[1] %}
+  | dataTableColumnText keywords {% data => data[0]+data[1] %}
+  | dataTableColumnText %word {% data => data[0]+data[1].value %}
+  | dataTableColumnText %ws {% data => data[0]+data[1].value %}
+
+escapedColumnCharaters -> %escapedPipe {% data => '|' %}
+  | %escapedBackSlash {% data => '\\' %}
+  | %escapedNewline {% data => '\n' %}
 
 steps -> stepAndTable moreSteps {% data => fp.concat(data[0],data[1]) %}
 
@@ -106,12 +118,18 @@ stepKeyword -> %step {% (data) => { return { type : 'step', name : data[0].value
 text -> null {% data => '' %}
   | text %word {% data => data[0]+data[1].value %}
   | text %ws {% data => data[0]+data[1].value %}
-  | text %step {% data => data[0]+data[1].value %}
-  | text %colon {% data => data[0]+data[1].value %}
-  | text %example {% data => data[0]+data[1].value %}
-  | text %examples {% data => data[0]+data[1].value %}
-  | text %scenarioOutline {% data => data[0]+data[1].value %}
-  | text %background {% data => data[0]+data[1].value %}
+  | text keywords {% data => data[0]+data[1] %}
+  | text %pipe {% data => data[0]+data[1].value %}
+  | text %escapedPipe {% data => data[0]+data[1].value %}
+  | text %escapedNewline {% data => data[0]+data[1].value %}
+  | text %escapedBackSlash {% data => data[0]+data[1].value %}
+
+keywords -> %step {% data => data[0].value %}
+  | %colon {% data => data[0].value %}
+  | %example {% data => data[0].value %}
+  | %examples {% data => data[0].value %}
+  | %scenarioOutline {% data => data[0].value %}
+  | %background {% data => data[0].value %}
 
 bolText -> %ws %word {% data => data[1].value %}
   | %word {% data => data[0].value %}

package/src/gherkin.umd.js

@@ -14,10 +14,12 @@ const lexer = moo.compile({
   colon : ':',
   step : '*',
   pipe : '|',
-  backSlash : '\\',
+  escapedPipe : '\\|',
+  escapedNewline : '\\n',
+  escapedBackSlash : '\\\\',
   scenarioOutline : ['Scenario Outline','Scenario Template'],
   word : {
-    match : /[^ \t\n:|\\]+/,
+    match : /[^ \t\n\:\|\@\*]+/,
     type : moo.keywords({
       feature : 'Feature',
       examples : ['Examples','Scenarios'],
@@ -78,7 +80,15 @@ var grammar = {
     {"name": "dataTable", "symbols": ["dataTable", "dataTableRow"], "postprocess": data => fp.concat(data[0],[data[1]])},
     {"name": "dataTableRow", "symbols": ["_", (lexer.has("pipe") ? {type: "pipe"} : pipe), "dataTableColumns", (lexer.has("newline") ? {type: "newline"} : newline)], "postprocess": data => data[2]},
     {"name": "dataTableColumns", "symbols": [], "postprocess": data => []},
-    {"name": "dataTableColumns", "symbols": ["dataTableColumns", "text", (lexer.has("pipe") ? {type: "pipe"} : pipe)], "postprocess": data => fp.concat(data[0],data[1].trim())},
+    {"name": "dataTableColumns", "symbols": ["dataTableColumns", "dataTableColumnText", (lexer.has("pipe") ? {type: "pipe"} : pipe)], "postprocess": data => fp.concat(data[0],data[1].trim())},
+    {"name": "dataTableColumnText", "symbols": [], "postprocess": data => ''},
+    {"name": "dataTableColumnText", "symbols": ["dataTableColumnText", "escapedColumnCharaters"], "postprocess": data => data[0]+data[1]},
+    {"name": "dataTableColumnText", "symbols": ["dataTableColumnText", "keywords"], "postprocess": data => data[0]+data[1]},
+    {"name": "dataTableColumnText", "symbols": ["dataTableColumnText", (lexer.has("word") ? {type: "word"} : word)], "postprocess": data => data[0]+data[1].value},
+    {"name": "dataTableColumnText", "symbols": ["dataTableColumnText", (lexer.has("ws") ? {type: "ws"} : ws)], "postprocess": data => data[0]+data[1].value},
+    {"name": "escapedColumnCharaters", "symbols": [(lexer.has("escapedPipe") ? {type: "escapedPipe"} : escapedPipe)], "postprocess": data => '|'},
+    {"name": "escapedColumnCharaters", "symbols": [(lexer.has("escapedBackSlash") ? {type: "escapedBackSlash"} : escapedBackSlash)], "postprocess": data => '\\'},
+    {"name": "escapedColumnCharaters", "symbols": [(lexer.has("escapedNewline") ? {type: "escapedNewline"} : escapedNewline)], "postprocess": data => '\n'},
     {"name": "steps", "symbols": ["stepAndTable", "moreSteps"], "postprocess": data => fp.concat(data[0],data[1])},
     {"name": "moreSteps", "symbols": [], "postprocess": data => []},
     {"name": "moreSteps", "symbols": ["moreSteps", "stepAndTable"], "postprocess": data => fp.concat(data[0],data[1])},
@@ -89,12 +99,17 @@ var grammar = {
     {"name": "text", "symbols": [], "postprocess": data => ''},
     {"name": "text", "symbols": ["text", (lexer.has("word") ? {type: "word"} : word)], "postprocess": data => data[0]+data[1].value},
     {"name": "text", "symbols": ["text", (lexer.has("ws") ? {type: "ws"} : ws)], "postprocess": data => data[0]+data[1].value},
-    {"name": "text", "symbols": ["text", (lexer.has("step") ? {type: "step"} : step)], "postprocess": data => data[0]+data[1].value},
-    {"name": "text", "symbols": ["text", (lexer.has("colon") ? {type: "colon"} : colon)], "postprocess": data => data[0]+data[1].value},
-    {"name": "text", "symbols": ["text", (lexer.has("example") ? {type: "example"} : example)], "postprocess": data => data[0]+data[1].value},
-    {"name": "text", "symbols": ["text", (lexer.has("examples") ? {type: "examples"} : examples)], "postprocess": data => data[0]+data[1].value},
-    {"name": "text", "symbols": ["text", (lexer.has("scenarioOutline") ? {type: "scenarioOutline"} : scenarioOutline)], "postprocess": data => data[0]+data[1].value},
-    {"name": "text", "symbols": ["text", (lexer.has("background") ? {type: "background"} : background)], "postprocess": data => data[0]+data[1].value},
+    {"name": "text", "symbols": ["text", "keywords"], "postprocess": data => data[0]+data[1]},
+    {"name": "text", "symbols": ["text", (lexer.has("pipe") ? {type: "pipe"} : pipe)], "postprocess": data => data[0]+data[1].value},
+    {"name": "text", "symbols": ["text", (lexer.has("escapedPipe") ? {type: "escapedPipe"} : escapedPipe)], "postprocess": data => data[0]+data[1].value},
+    {"name": "text", "symbols": ["text", (lexer.has("escapedNewline") ? {type: "escapedNewline"} : escapedNewline)], "postprocess": data => data[0]+data[1].value},
+    {"name": "text", "symbols": ["text", (lexer.has("escapedBackSlash") ? {type: "escapedBackSlash"} : escapedBackSlash)], "postprocess": data => data[0]+data[1].value},
+    {"name": "keywords", "symbols": [(lexer.has("step") ? {type: "step"} : step)], "postprocess": data => data[0].value},
+    {"name": "keywords", "symbols": [(lexer.has("colon") ? {type: "colon"} : colon)], "postprocess": data => data[0].value},
+    {"name": "keywords", "symbols": [(lexer.has("example") ? {type: "example"} : example)], "postprocess": data => data[0].value},
+    {"name": "keywords", "symbols": [(lexer.has("examples") ? {type: "examples"} : examples)], "postprocess": data => data[0].value},
+    {"name": "keywords", "symbols": [(lexer.has("scenarioOutline") ? {type: "scenarioOutline"} : scenarioOutline)], "postprocess": data => data[0].value},
+    {"name": "keywords", "symbols": [(lexer.has("background") ? {type: "background"} : background)], "postprocess": data => data[0].value},
     {"name": "bolText", "symbols": [(lexer.has("ws") ? {type: "ws"} : ws), (lexer.has("word") ? {type: "word"} : word)], "postprocess": data => data[1].value},
     {"name": "bolText", "symbols": [(lexer.has("word") ? {type: "word"} : word)], "postprocess": data => data[0].value},
     {"name": "freeform", "symbols": [], "postprocess": data => ''},