Fix one-space-between-tags rule not detecting errors in Examples nodes

gherkin-lint · May 12, 2019 · 8ef092b · 8ef092b
1 parent 803a040
commit 8ef092b
Show file tree

Hide file tree

Showing 4 changed files with 53 additions and 32 deletions.
diff --git a/src/rules/one-space-between-tags.js b/src/rules/one-space-between-tags.js
@@ -3,15 +3,35 @@ const _ = require('lodash');
 var rule = 'one-space-between-tags';
 
 function run(feature) {
-  if (!feature || Object.keys(feature).length === 0) {
-    return [];
-  }
   var errors = [];
+
+  testTags(feature, errors);
+
+  if (feature.children) {
+    feature.children.forEach(function(child) {
+
+      testTags(child, errors);
+
+      if (child.examples) {
+        child.examples.forEach(function(example) {
+          testTags(example, errors);
+        });
+      }
+    });
+  }
+  return errors;
+}
 
-  function testTags(allTags) {
-    _(allTags).groupBy('location.line').sortBy('location.column')
-      .forEach(function(tags) {
-        _.range(tags.length - 1).map(function(i) {
+function testTags(node, errors) {
+  if (!node.tags) {
+    return;
+  }
+  _(node.tags)
+    .groupBy('location.line')
+    .sortBy('location.column')
+    .forEach(function(tags) {
+      _.range(tags.length - 1)
+        .map(function(i) {
           if (tags[i].location.column + tags[i].name.length < tags[i + 1].location.column - 1) {
             errors.push({
               line: tags[i].location.line,
@@ -21,17 +41,7 @@ function run(feature) {
             });
           }
         });
-      });
-  }
-
-  testTags(feature.tags);
-  feature.children.forEach(function(child) {
-    if (child.type === 'Scenario' || child.type === 'ScenarioOutline') {
-      testTags(child.tags);
-    }
-  });
-
-  return errors;
+    });
 }
 
 module.exports = {

diff --git a/test/rules/one-space-between-tags/NoViolations.feature b/test/rules/one-space-between-tags/NoViolations.feature
@@ -13,6 +13,7 @@ Scenario: This is a Scenario with good tag spacing
 @scenariotag5 @scenariotag6
 Scenario Outline: This is a Scenario Outline with good tag spacing
   Then this is a then step <foo>
+@examplestag1 @examplestag2
 Examples:
   | foo |
   | bar |
diff --git a/test/rules/one-space-between-tags/Violations.feature b/test/rules/one-space-between-tags/Violations.feature
@@ -1,6 +1,6 @@
 @featuretag1  @featuretag2
 @featuretag3
-Feature: Feature with good tag spacing
+Feature: Feature with bad tag spacing
 
 Background:
   Given I have a Background
@@ -13,6 +13,7 @@ Scenario: This is a Scenario with bad tag spacing
 @scenariotag5   @scenariotag6
 Scenario Outline: This is a Scenario Outline with bad tag spacing
   Then this is a then step <foo>
+@examplestag1   @examplestag2
 Examples:
   | foo |
   | bar |
diff --git a/test/rules/one-space-between-tags/one-space-between-tags.js b/test/rules/one-space-between-tags/one-space-between-tags.js
@@ -9,18 +9,27 @@ describe('One Space Between Tags Rule', function() {
   });
 
   it('detects errors for tags on features, scenarios, and scenario outlines', function() {
-    runTest('one-space-between-tags/Violations.feature', {}, [{
-      line: 1,
-      messageElements: {left: '@featuretag1', right: '@featuretag2'}
-    }, {
-      line: 9,
-      messageElements: {left: '@scenariotag3', right: '@scenariotag4'}
-    }, {
-      line: 9,
-      messageElements: {left: '@scenariotag4', right: '@scenariotag5'}
-    }, {
-      line: 13,
-      messageElements: {left: '@scenariotag5', right: '@scenariotag6'}
-    }]);
+    runTest('one-space-between-tags/Violations.feature', {}, [
+      {
+        line: 1,
+        messageElements: {left: '@featuretag1', right: '@featuretag2'}
+      }, 
+      {
+        line: 9,
+        messageElements: {left: '@scenariotag3', right: '@scenariotag4'}
+      }, 
+      {
+        line: 9,
+        messageElements: {left: '@scenariotag4', right: '@scenariotag5'}
+      }, 
+      {
+        line: 13,
+        messageElements: {left: '@scenariotag5', right: '@scenariotag6'}
+      }, 
+      {
+        line: 16,
+        messageElements: {left: '@examplestag1', right: '@examplestag2'}
+      }
+    ]);
   });
 });