fix(loader): work with escaped characters (#249)

We will now parse and escape the stringified .feature file when putting it in the template literal -
otherwise the escaped characters got parsed and we were getting syntax errors

fix #106

Author: lgandecki

cypress/integration/DataTable.feature

@@ -8,4 +8,10 @@ Feature: Being a plugin handling DataTable scenario
       | number | another number |
       | 1      | 2              |
       | 3      | 4              |
-    Then I verify the datatable result is equal to 10
+    Then I verify the datatable result is equal to 10
+
+
+  Scenario: New line character
+    Given I have a table with some escaped characters in it
+      | foo      | bar      |
+      | foo\nfoo | bar\nbar |

cypress/support/step_definitions/dataTable.js

@@ -1,9 +1,10 @@
-/* global then, when */
+// eslint-disable-next-line import/no-extraneous-dependencies
+const { Given, When, Then } = require("cypress-cucumber-preprocessor/steps");
 
 // you can have external state, and also require things!
 let sum = 0;
 
-when("I add all following numbers:", dataTable => {
+When("I add all following numbers:", dataTable => {
   // console.log("a, ", dataTable.rawTable.slice(1))
   sum = dataTable.rawTable
     .slice(1)
@@ -14,6 +15,11 @@ when("I add all following numbers:", dataTable => {
     );
 });
 
-then("I verify the datatable result is equal to {int}", result => {
+Then("I verify the datatable result is equal to {int}", result => {
   expect(sum).to.equal(result);
 });
+
+Given("I have a table with some escaped characters in it", dataTable => {
+  console.log(dataTable);
+  // we don't need to do anything, just make sure it doesn't break
+});

lib/featuresLoader.js

@@ -3,6 +3,7 @@ const path = require("path");
 const fs = require("fs");
 const { Parser } = require("gherkin");
 const log = require("debug")("cypress:cucumber");
+const jsStringEscape = require("js-string-escape");
 
 const { getStepDefinitionsPaths } = require("./getStepDefinitionsPaths");
 const { cucumberTemplate } = require("./cucumberTemplate");
@@ -33,7 +34,9 @@ const createCucumber = (
             .find(fileSteps => fileSteps[filePath])
             [filePath].join("\n")}
             
-        createTestsFromFeature('${path.basename(filePath)}', \`${spec}\`);
+        createTestsFromFeature('${path.basename(filePath)}', \`${jsStringEscape(
+        spec
+      )}\`);
         })
         `
     )

lib/loader.js

@@ -1,9 +1,11 @@
 const log = require("debug")("cypress:cucumber");
 const path = require("path");
 const { Parser } = require("gherkin");
+const jsStringEscape = require("js-string-escape");
 const { getStepDefinitionsPaths } = require("./getStepDefinitionsPaths");
 const { cucumberTemplate } = require("./cucumberTemplate");
 const { getCucumberJsonConfig } = require("./getCucumberJsonConfig");
+
 // This is the template for the file that we will send back to cypress instead of the text of a
 // feature file
 const createCucumber = (filePath, cucumberJson, spec, toRequire, name) =>
@@ -13,7 +15,7 @@ const createCucumber = (filePath, cucumberJson, spec, toRequire, name) =>
   window.cucumberJson = ${JSON.stringify(cucumberJson)};
   describe(\`${name}\`, function() {
     ${toRequire.join("\n")}
-    createTestsFromFeature('${filePath}', \`${spec}\`);
+    createTestsFromFeature('${filePath}', \`${jsStringEscape(spec)}\`);
   });
   `;