devdocs: return results for empty query (#156)

I noticed the other providers have this behaviour and it feels nice.
sourcegraph · Jun 18, 2024 · 36e269c · 36e269c
1 parent 895aa83
commit 36e269c
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 17 deletions.
diff --git a/provider/devdocs/index.test.ts b/provider/devdocs/index.test.ts
@@ -8,6 +8,11 @@ import devdocs, { type Settings } from './index.js'
 const INTEGRATION = !!process.env.INTEGRATION
 
 describe('devdocs', () => {
+    const fixturesDir = path.join(__dirname, '__fixtures__')
+    const fixturesSettings = {
+        urls: [url.pathToFileURL(fixturesDir).toString()],
+    }
+
     test('meta', () => {
         expect(devdocs.meta({}, {})).toEqual({
             name: 'DevDocs',
@@ -55,12 +60,16 @@ describe('devdocs', () => {
         })
     })
 
-    test('test page type', async () => {
-        const fixturesDir = path.join(__dirname, '__fixtures__')
-        const settings = {
-            urls: [url.pathToFileURL(fixturesDir).toString()],
-        }
+    test('empty query returns results', async () => {
+        const settings = fixturesSettings
 
+        const mentions = await devdocs.mentions!({ query: '' }, settings)
+        expect(mentions).toBeInstanceOf(Array)
+        expect(mentions).toBeTruthy()
+    })
+
+    test('test page type', async () => {
+        const settings = fixturesSettings
         const mentionPath = path.join(fixturesDir, 'strconv', 'index')
         const item = await expectMentionItem({ query: 'strconv' }, settings, {
             title: 'strconv',
@@ -85,11 +94,7 @@ describe('devdocs', () => {
     })
 
     test('test hash type', async () => {
-        const fixturesDir = path.join(__dirname, '__fixtures__')
-        const settings = {
-            urls: [url.pathToFileURL(fixturesDir).toString()],
-        }
-
+        const settings = fixturesSettings
         const mentionURL = url.pathToFileURL(path.join(fixturesDir, 'io', 'index'))
         mentionURL.hash = '#TeeReader'
 
@@ -138,11 +143,7 @@ describe('devdocs', () => {
     })
 
     test('missing documentation has no results', async () => {
-        const fixturesDir = path.join(__dirname, '__fixtures__')
-        const settings = {
-            urls: [url.pathToFileURL(fixturesDir).toString()],
-        }
-
+        const settings = fixturesSettings
         const mentions = await devdocs.mentions!({ query: 'abortcontroller' }, settings)
         expect(mentions).toHaveLength(0)
     })

diff --git a/provider/devdocs/index.ts b/provider/devdocs/index.ts
@@ -48,11 +48,11 @@ const devdocs: Provider<Settings> = {
     },
 
     async mentions(params: MentionsParams, settings: Settings): Promise<MentionsResult> {
-        const query = params.query?.toLowerCase()
-        if (!query) {
+        if (params.query === undefined) {
             return []
         }
 
+        const query = params.query.toLowerCase()
         const urls = settings.urls ?? DEFAULT_URLS
 
         const indexes = await Promise.all(urls.map(url => getMentionIndex(url)))