Also search in step docstring

Author: vincent-psarga

src/search/StepSearch.ts

@@ -5,12 +5,14 @@ interface SearchableStep {
   id: string
   keyword: string
   text: string
+  docstring?: string
 }
 
 export default class StepSearch {
   private readonly index = elasticlunr<SearchableStep>((ctx) => {
     ctx.addField('keyword')
     ctx.addField('text')
+    ctx.addField('docstring')
     ctx.setRef('id')
     ctx.saveDocument(true)
   })
@@ -21,6 +23,7 @@ export default class StepSearch {
       id: step.id,
       keyword: step.keyword,
       text: step.text,
+      docstring: this.docstringToString(step),
     }
 
     this.index.addDoc(doc)
@@ -32,9 +35,16 @@ export default class StepSearch {
       fields: {
         keyword: { bool: 'OR', expand: true, boost: 1 },
         text: { bool: 'OR', expand: true, boost: 2 },
+        docstring: { bool: 'OR', expand: true, boost: 1 },
       },
     })
 
     return results.map((result) => this.stepById.get(result.ref))
   }
+
+  private docstringToString(
+    step: messages.GherkinDocument.Feature.IStep
+  ): string {
+    return step.docString ? step.docString.content : ''
+  }
 }

test/search/StepSearchTest.ts

@@ -11,7 +11,7 @@ describe('StepSearch', () => {
     stepSearch = new StepSearch()
 
     steps = [
-      makeStep('Given', 'a passed step'),
+      makeStep('Given', 'a passed step', 'There is a docstring here'),
       makeStep('When', 'another passed step'),
       makeStep('Then', 'a failed step'),
     ]
@@ -50,5 +50,10 @@ describe('StepSearch', () => {
       // amongst them are 'Then' and 'When'.
       // See: http://elasticlunr.com/docs/stop_word_filter.js.html#resetStopWords
     })
+
+    it('returns step which DocString matches the query', () => {
+      const searchResults = stepSearch.search('docstring')
+      assert.deepStrictEqual(searchResults, [steps[0]])
+    })
   })
 })

test/search/utils.ts

@@ -52,14 +52,21 @@ function makeScenario(
 
 function makeStep(
   keyword: string,
-  text: string
+  text: string,
+  docstring = ''
 ): messages.GherkinDocument.Feature.IStep {
   const idGenerator = IdGenerator.uuid()
+  const docStringParam = docstring
+    ? messages.GherkinDocument.Feature.Step.DocString.create({
+        content: docstring,
+      })
+    : undefined
 
   return messages.GherkinDocument.Feature.Step.create({
     id: idGenerator(),
     keyword: keyword,
     text: text,
+    docString: docStringParam,
   })
 }