feat: make the cucumber json report optional, updated docs

badeball · Jul 23, 2019 · ff1f41f · ff1f41f
1 parent ea24fe8
commit ff1f41f
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -298,22 +298,22 @@ and add the following to the cypress-cucumber-preprocessor section in package.js
   "cypress-cucumber-preprocessor": {
     "cucumberJson": {
       "generate": true,
-      "outputFolder": "cucumber-json",
-      "filePrefix": "cucumber-",
-      "fileSuffix": ""
+      "outputFolder": "cypress/cucumber-json",
+      "filePrefix": "",
+      "fileSuffix": ".cucumber"
     }
   }
 ```
 
 Here:
 
-outputFolder: The folder to write the files to, defaults to ```./cypress/cucumber-json```
+outputFolder: The folder to write the files to, defaults to ```cypress/cucumber-json```
 
-filePrefix: A separate json file is generated for each feature based on the name of the feature file. All generated file names will be prefixed with this option if specified.
+filePrefix: A separate json file is generated for each feature based on the name of the feature file. All generated file names will be prefixed with this option if specified. Empty string (no prefix) by default.
 
 fileSuffix: A suffix to add to each generated filename, defaults to '.cucumber'
 
-generate: Flag, output cucumber.json or not, defaults to true.
+generate: Flag, output cucumber.json or not, defaults to false.
 
 
 ## Development

diff --git a/lib/loader.js b/lib/loader.js
@@ -31,7 +31,7 @@ module.exports = (spec, filePath = this.resourcePath) => {
   const cucumberJson =
     loaded && loaded.config && loaded.config.cucumberJson
       ? loaded.config.cucumberJson
-      : { generate: true };
+      : { generate: false };
 
   log("compiling", spec);
   log("cucumber.json", JSON.stringify(cucumberJson));