Merge pull request #48 from xgbuils/gherkin-6-prepare

preparing pickle-lint for supporting gherkin@6

package.json

@@ -78,7 +78,8 @@
     "eslint-config-google": "^0.13.0",
     "mocha": "6.1.4",
     "npm-check": "^5.9.0",
-    "nyc": "^14.1.1"
+    "nyc": "^14.1.1",
+    "sinon": "^7.3.2"
   },
   "bin": {
     "pickle-lint": "src/main.js"

src/linter/no-configurable-linter.js

@@ -12,19 +12,17 @@ class NoConfigurableLinter {
   }
 
   lint(file) {
-    try {
-      return this.parser.parse(file)
-        .then(({feature, languageKeywords}) => [{
-          feature,
-          languageKeywords,
-          file,
-        }]);
-    } catch (e) {
-      if (e.errors) {
-        return Promise.reject(processFatalErrors(e.errors));
-      }
-      return Promise.reject(e);
-    }
+    return this.parser.parse(file)
+      .then(({feature, languageKeywords}) => [{
+        feature,
+        languageKeywords,
+        file,
+      }], (e) => {
+        if (e.errors) {
+          return Promise.reject(processFatalErrors(e.errors));
+        }
+        return Promise.reject(e);
+      });
   }
 }
 

src/parser-adapter/index.js

@@ -1,13 +1,58 @@
 module.exports = (Gherkin) => {
-  const {Parser, DIALECTS} = Gherkin;
-  const parser = new Parser();
-  return {
-    parse({content}) {
-      const {feature = {}} = parser.parse(content);
-      return Promise.resolve({
-        languageKeywords: DIALECTS[feature.language],
-        feature,
-      });
-    },
-  };
+  if (Gherkin.Parser) {
+    const {Parser, DIALECTS} = Gherkin;
+    const parser = new Parser();
+    return {
+      parse({content}) {
+        try {
+          const {feature = {}} = parser.parse(content);
+          return Promise.resolve({
+            languageKeywords: DIALECTS[feature.language],
+            feature,
+          });
+        } catch (error) {
+          return Promise.reject(error);
+        }
+      },
+    };
+  } else {
+    const {fromPaths} = Gherkin;
+    return {
+      parse({path}) {
+        const stream = fromPaths([path], {
+          includeSource: false,
+          includePickles: false,
+        });
+
+        return new Promise((resolve, reject) => {
+          const gherkinDocuments = [];
+          const errors = [];
+          stream.on('error', (error) => {
+            reject(error);
+          });
+          stream.on('data', ({gherkinDocument, attachment}) => {
+            if (attachment) {
+              errors.push(attachment);
+            } else {
+              gherkinDocuments.push(gherkinDocument);
+            }
+          });
+          stream.on('end', () => {
+            if (errors.length > 0) {
+              reject(errors);
+            } else if (gherkinDocuments.length > 1) {
+              reject(new Error(
+                'Unexpected error: fromPaths function returns multiple gherkin documents'
+              ));
+            } else if (gherkinDocuments.length === 1) {
+              const [gherkinDocument] = gherkinDocuments;
+              resolve(gherkinDocument);
+            } else {
+              reject(new Error('Unexpected error: zero gherkin documents'));
+            }
+          });
+        });
+      },
+    };
+  }
 };

test/linter/no-configurable-linter/no-configurable-linter.js

@@ -238,7 +238,7 @@ describe('No Configurable File Linter', function() {
     };
     const wrongParser = {
       parse() {
-        throw e;
+        return Promise.reject(e);
       },
     };
     const wrongLinter = new NoConfigurableLinter(wrongParser);
@@ -258,7 +258,7 @@ describe('No Configurable File Linter', function() {
     const error = 'error';
     const wrongParser = {
       parse() {
-        throw error;
+        return Promise.reject(error);
       },
     };
     const wrongLinter = new NoConfigurableLinter(wrongParser);