feat(@inquirer/search): Support providing custom instructions. Fix #1773

Author: SBoudrias

packages/search/search.test.ts

@@ -558,4 +558,38 @@ describe('search prompt', () => {
     events.keypress('enter');
     await expect(answer).resolves.toEqual('QC');
   });
+
+  it('supports custom instructions', async () => {
+    const { answer, events, getScreen } = await render(search, {
+      message: 'Select a Canadian province',
+      source: getListSearch(PROVINCES),
+      pageSize: 3,
+      instructions: {
+        navigation: 'Utiliser les flèches directionnelles',
+        pager: 'Utiliser les flèches pour révéler plus de choix',
+      },
+    });
+
+    // Test custom pager instruction when results exceed pageSize
+    expect(getScreen()).toMatchInlineSnapshot(`
+      "? Select a Canadian province 
+      ❯ Alberta
+        British Columbia
+        Manitoba
+      (Utiliser les flèches pour révéler plus de choix)"
+    `);
+
+    // Test custom navigation instruction when results fit in pageSize
+    events.type('New');
+    await Promise.resolve();
+    expect(getScreen()).toMatchInlineSnapshot(`
+      "? Select a Canadian province New
+      ❯ New Brunswick
+        Newfoundland and Labrador
+      (Utiliser les flèches directionnelles)"
+    `);
+
+    events.keypress('enter');
+    await expect(answer).resolves.toEqual('NB');
+  });
 });

packages/search/src/index.ts

@@ -71,6 +71,10 @@ type SearchConfig<
         | Promise<ReadonlyArray<Choice<Value> | Separator>>;
   validate?: (value: Value) => boolean | string | Promise<string | boolean>;
   pageSize?: number;
+  instructions?: {
+    navigation: string;
+    pager: string;
+  };
   theme?: PartialDeep<Theme<SearchTheme>>;
 };
 
@@ -226,8 +230,8 @@ export default createPrompt(
     ) {
       helpTip =
         searchResults.length > pageSize
-          ? `\n${theme.style.help('(Use arrow keys to reveal more choices)')}`
-          : `\n${theme.style.help('(Use arrow keys)')}`;
+          ? `\n${theme.style.help(`(${config.instructions?.pager ?? 'Use arrow keys to reveal more choices'})`)}`
+          : `\n${theme.style.help(`(${config.instructions?.navigation ?? 'Use arrow keys'})`)}`;
     }
 
     // TODO: What to do if no results are found? Should we display a message?