Keep descriptions when filtering objects

Author: vincent-psarga

src/components/gherkin/TableBody.tsx

@@ -1,6 +1,7 @@
 import React from 'react'
 import { messages } from '@cucumber/messages'
 import isNumber from './isNumber'
+import HighLight from '../app/HighLight'
 
 interface IProps {
   rows: messages.GherkinDocument.Feature.ITableRow[]
@@ -16,7 +17,7 @@ const TableBody: React.FunctionComponent<IProps> = ({ rows }) => {
               key={j}
               style={{ textAlign: isNumber(cell.value) ? 'right' : 'left' }}
             >
-              {cell.value}
+              <HighLight text={cell.value} />
             </td>
           ))}
         </tr>

src/pretty-formatter/pretty.ts

@@ -5,13 +5,20 @@ export default function pretty(
 ): string {
   const feature = gherkinDocument.feature
   let s = feature.keyword + ': ' + feature.name + '\n'
+  if (feature.description) {
+    s += feature.description + '\n'
+  }
   for (const child of feature.children) {
     if (child.background) {
       s += prettyStepContainer(child.background, '  ')
     } else if (child.scenario) {
       s += prettyStepContainer(child.scenario, '  ')
     } else if (child.rule) {
       s += `\n  ${child.rule.keyword}: ${child.rule.name}\n`
+      if (child.rule.description) {
+        s += child.rule.description + '\n'
+      }
+
       for (const ruleChild of child.rule.children) {
         if (ruleChild.background) {
           s += prettyStepContainer(ruleChild.background, '    ')
@@ -30,6 +37,9 @@ function prettyStepContainer(
   indent: string
 ): string {
   let s = `\n${indent}${stepContainer.keyword}: ${stepContainer.name}\n`
+  if (stepContainer.description) {
+    s += stepContainer.description + '\n\n'
+  }
   for (const step of stepContainer.steps) {
     s += `${indent}  ${step.keyword}${step.text}\n`
   }

src/search/AstWalker.ts

@@ -116,6 +116,7 @@ export default class AstWalker {
       language: feature.language,
       keyword: feature.keyword,
       name: feature.name,
+      description: feature.description ? feature.description : undefined,
     })
   }
 
@@ -229,6 +230,7 @@ export default class AstWalker {
       location: rule.location,
       keyword: rule.keyword,
       children: this.filterRuleChildren(rule.children, children),
+      description: rule.description ? rule.description : undefined,
     })
   }
 
@@ -308,6 +310,7 @@ export default class AstWalker {
       location: background.location,
       keyword: background.keyword,
       steps: background.steps.map((step) => this.copyStep(step)),
+      description: background.description ? background.description : undefined,
     })
   }
 
@@ -336,6 +339,7 @@ export default class AstWalker {
       examples: scenario.examples,
       steps: scenario.steps.map((step) => this.copyStep(step)),
       tags: scenario.tags,
+      description: scenario.description ? scenario.description : undefined,
     })
   }
 

test/search/AstWalkerTest.ts

@@ -63,6 +63,7 @@ describe('AstWalker', () => {
 
     it('filters one scenario', () => {
       const gherkinDocument = parse(`Feature: Solar System
+  The solar system is kind of a nice place
 
   Scenario: Saturn
     Given is the sixth planet from the Sun
@@ -78,6 +79,7 @@ describe('AstWalker', () => {
       const newGherkinDocument = walker.walkGherkinDocument(gherkinDocument)
       const newSource = pretty(newGherkinDocument)
       const expectedNewSource = `Feature: Solar System
+  The solar system is kind of a nice place
 
   Scenario: Earth
     Given is a planet with liquid water
@@ -161,6 +163,8 @@ describe('AstWalker', () => {
     Given space is real
 
   Rule: Galaxy
+    A galaxy is a place where big stuff floats
+
     Background: Milky Way
       Given it contains our system
 
@@ -183,6 +187,7 @@ describe('AstWalker', () => {
     Given space is real
 
   Rule: Galaxy
+    A galaxy is a place where big stuff floats
 
     Background: Milky Way
       Given it contains our system
@@ -198,6 +203,8 @@ describe('AstWalker', () => {
 
   Rule: Galaxy
     Background: Milky Way
+      The Milky way (with a capital) is not simply a snack
+
       Given it contains our system
 
   Rule: Black Hole
@@ -219,6 +226,8 @@ describe('AstWalker', () => {
   Rule: Galaxy
 
     Background: Milky Way
+      The Milky way (with a capital) is not simply a snack
+
       Given it contains our system
 
   Rule: Black Hole
@@ -241,6 +250,8 @@ describe('AstWalker', () => {
       Given it contains our system
 
     Scenario: Andromeda
+      Nebula Chain !!!
+
       Given it exists
 `)
 
@@ -258,6 +269,8 @@ describe('AstWalker', () => {
       Given it's a black hole
 
     Scenario: Andromeda
+      Nebula Chain !!!
+
       Given it exists
 `
       assert.strictEqual(newSource, expectedNewSource)