clarify interfaces and types

src/search/Search.ts

@@ -28,10 +28,21 @@ class Search {
   }
 }
 
+/**
+ * Creates a search index that supports querying by term or tag expression, and
+ * returns an array of abridged Gherkin documents matching the query.
+ *
+ * @param gherkinQuery - query instance used internally for searching, with any
+ * documents already present being pre-populated in the search index
+ */
 export async function createSearch(gherkinQuery: GherkinQuery): Promise<Searchable> {
   const [tagSearch, textSearch] = await Promise.all([
     createTagSearch(gherkinQuery),
-    createTextSearch(gherkinQuery.getGherkinDocuments()),
+    createTextSearch(),
   ])
-  return new Search(tagSearch, textSearch)
+  const searchImpl = new Search(tagSearch, textSearch)
+  for (const doc of gherkinQuery.getGherkinDocuments()) {
+    await searchImpl.add(doc)
+  }
+  return searchImpl
 }

src/search/TagSearch.spec.ts

@@ -35,10 +35,13 @@ Feature: Solar System
         newId: messages.IdGenerator.incrementing(),
       }
     )
+    const tagSearch = await createTagSearch(gherkinQuery)
     for (const envelope of envelopes) {
       gherkinQuery.update(envelope)
     }
-    const tagSearch = await createTagSearch(gherkinQuery)
+    for (const document of gherkinQuery.getGherkinDocuments()) {
+      await tagSearch.add(document)
+    }
     return pretty((await tagSearch.search(query))[0])
   }
 

src/search/TagSearch.ts

@@ -70,9 +70,5 @@ class TagSearch {
 }
 
 export async function createTagSearch(gherkinQuery: GherkinQuery): Promise<Searchable> {
-  const tagSearchImpl = new TagSearch(gherkinQuery)
-  for (const document of gherkinQuery.getGherkinDocuments()) {
-    await tagSearchImpl.add(document)
-  }
-  return tagSearchImpl
+  return new TagSearch(gherkinQuery)
 }

src/search/TextSearch.spec.ts

@@ -34,7 +34,8 @@ describe('TextSearch', () => {
   beforeEach(async () => {
     const gherkinDocument = parse(source)
 
-    search = await createTextSearch([gherkinDocument])
+    search = await createTextSearch()
+    await search.add(gherkinDocument)
   })
 
   describe('Hit found in step', () => {

src/search/TextSearch.ts

@@ -71,9 +71,7 @@ class TextSearch {
   }
 }
 
-export async function createTextSearch(
-  gherkinDocuments: readonly GherkinDocument[]
-): Promise<Searchable> {
+export async function createTextSearch(): Promise<Searchable> {
   const [stepSearch, backgroundSearch, scenarioSearch, ruleSearch, featureSearch] =
     await Promise.all([
       createStepSearch(),
@@ -82,15 +80,5 @@ export async function createTextSearch(
       createScenarioLikeSearch<Rule>(),
       createFeatureSearch(),
     ])
-  const textSearchImpl = new TextSearch(
-    stepSearch,
-    backgroundSearch,
-    scenarioSearch,
-    ruleSearch,
-    featureSearch
-  )
-  for (const document of gherkinDocuments) {
-    await textSearchImpl.add(document)
-  }
-  return textSearchImpl
+  return new TextSearch(stepSearch, backgroundSearch, scenarioSearch, ruleSearch, featureSearch)
 }