chore: Remove all deprecated code

BREAKING CHANGE: Removed all deprecated APIs:
- Removed `list` prompt alias (use `select` instead)
- Removed `helpMode` theme property (use `theme.style.keysHelpTip` instead)
- Removed `instructions` config property (use `theme.style.keysHelpTip` instead)
- Removed `cancel()` method on prompt return types (use AbortSignal instead)

This removes 9 deprecated items across 6 packages:
- packages/inquirer: Removed `list` alias
- packages/search: Removed `helpMode` and `instructions`
- packages/checkbox: Removed `helpMode` and `instructions`
- packages/select: Removed `helpMode` and `instructions`
- packages/type: Removed `cancel()` method
- packages/testing: Removed `cancel()` method

Also updated tests to use new APIs and removed deprecated feature
references from documentation.

Author: SBoudrias

packages/checkbox/README.md

@@ -166,7 +166,7 @@ type Theme = {
 
 This function allows you to customize the keyboard shortcuts help tip displayed below the prompt. It receives an array of key-action pairs and should return a formatted string. You can also hook here to localize the labels to different languages.
 
-It can also returns `undefined` to hide the help tip entirely. This is the replacement for the deprecated theme option `helpMode: 'never'`.
+It can also returns `undefined` to hide the help tip entirely.
 
 ```js
 theme: {

packages/checkbox/checkbox.test.ts

@@ -616,56 +616,6 @@ describe('checkbox prompt', () => {
     await expect(answer).resolves.not.toContain(unselect);
   });
 
-  it('allow disabling help tip', async () => {
-    const { answer, events, getScreen } = await render(checkbox, {
-      message: 'Select a number',
-      choices: numberedChoices,
-      instructions: false,
-    });
-
-    expect(getScreen()).toMatchInlineSnapshot(`
-      "? Select a number
-      ❯◯ 1
-       ◯ 2
-       ◯ 3
-       ◯ 4
-       ◯ 5
-       ◯ 6
-       ◯ 7"
-    `);
-
-    events.keypress('enter');
-    await expect(answer).resolves.toEqual([]);
-    expect(getScreen()).toMatchInlineSnapshot('"✔ Select a number"');
-  });
-
-  it('allow customizing help tip', async () => {
-    const { answer, events, getScreen } = await render(checkbox, {
-      message: 'Select a number',
-      choices: numberedChoices,
-      instructions:
-        ' (Pulse <space> para seleccionar, <a> para alternar todos, <i> para invertir selección, y <enter> para continuar)',
-    });
-
-    expect(getScreen()).toMatchInlineSnapshot(`
-      "? Select a number
-      ❯◯ 1
-       ◯ 2
-       ◯ 3
-       ◯ 4
-       ◯ 5
-       ◯ 6
-       ◯ 7
-
-       (Pulse <space> para seleccionar, <a> para alternar todos, <i> para invertir
-      selección, y <enter> para continuar)"
-    `);
-
-    events.keypress('enter');
-    await expect(answer).resolves.toEqual([]);
-    expect(getScreen()).toMatchInlineSnapshot('"✔ Select a number"');
-  });
-
   it('throws if all choices are disabled', async () => {
     const { answer } = await render(checkbox, {
       message: 'Select a number',
@@ -969,14 +919,13 @@ describe('checkbox prompt', () => {
     });
   });
 
-  describe('theme: helpMode', () => {
+  describe('theme: keysHelpTip', () => {
     const scrollTip = '↑↓ navigate • space select • a all • i invert • ⏎ submit';
 
-    it('helpMode: auto', async () => {
+    it('keysHelpTip: show help by default', async () => {
       const { answer, events, getScreen } = await render(checkbox, {
         message: 'Select a number',
         choices: numberedChoices,
-        theme: { helpMode: 'auto' },
       });
 
       expect(getScreen()).toMatchInlineSnapshot(`
@@ -994,45 +943,21 @@ describe('checkbox prompt', () => {
       expect(getScreen()).toContain(scrollTip);
 
       events.keypress('down');
-      expect(getScreen()).toMatchInlineSnapshot(`
-        "? Select a number
-         ◯ 1
-        ❯◯ 2
-         ◯ 3
-         ◯ 4
-         ◯ 5
-         ◯ 6
-         ◯ 7
-
-        ↑↓ navigate • space select • a all • i invert • ⏎ submit"
-      `);
-      expect(getScreen()).toContain(scrollTip);
-
       events.keypress('space');
-      expect(getScreen()).toMatchInlineSnapshot(`
-        "? Select a number
-         ◯ 1
-        ❯◉ 2
-         ◯ 3
-         ◯ 4
-         ◯ 5
-         ◯ 6
-         ◯ 7
-
-        ↑↓ navigate • space select • a all • i invert • ⏎ submit"
-      `);
-      expect(getScreen()).toContain(scrollTip);
-
       events.keypress('enter');
       await expect(answer).resolves.toEqual([2]);
       expect(getScreen()).toMatchInlineSnapshot(`"✔ Select a number 2"`);
     });
 
-    it('helpMode: always', async () => {
+    it('keysHelpTip: hide help when returning undefined', async () => {
       const { answer, events, getScreen } = await render(checkbox, {
         message: 'Select a number',
         choices: numberedChoices,
-        theme: { helpMode: 'always' },
+        theme: {
+          style: {
+            keysHelpTip: () => undefined,
+          },
+        },
       });
 
       expect(getScreen()).toMatchInlineSnapshot(`
@@ -1043,11 +968,9 @@ describe('checkbox prompt', () => {
          ◯ 4
          ◯ 5
          ◯ 6
-         ◯ 7
-
-        ↑↓ navigate • space select • a all • i invert • ⏎ submit"
+         ◯ 7"
       `);
-      expect(getScreen()).toContain(scrollTip);
+      expect(getScreen()).not.toContain(scrollTip);
 
       events.keypress('down');
       expect(getScreen()).toMatchInlineSnapshot(`
@@ -1058,11 +981,9 @@ describe('checkbox prompt', () => {
          ◯ 4
          ◯ 5
          ◯ 6
-         ◯ 7
-
-        ↑↓ navigate • space select • a all • i invert • ⏎ submit"
+         ◯ 7"
       `);
-      expect(getScreen()).toContain(scrollTip);
+      expect(getScreen()).not.toContain(scrollTip);
 
       events.keypress('space');
       expect(getScreen()).toMatchInlineSnapshot(`
@@ -1073,22 +994,25 @@ describe('checkbox prompt', () => {
          ◯ 4
          ◯ 5
          ◯ 6
-         ◯ 7
-
-        ↑↓ navigate • space select • a all • i invert • ⏎ submit"
+         ◯ 7"
       `);
-      expect(getScreen()).toContain(scrollTip);
+      expect(getScreen()).not.toContain(scrollTip);
 
       events.keypress('enter');
       await expect(answer).resolves.toEqual([2]);
       expect(getScreen()).toMatchInlineSnapshot(`"✔ Select a number 2"`);
     });
 
-    it('helpMode: never', async () => {
+    it('keysHelpTip: custom help text', async () => {
+      const customHelpText = 'Pulse <space> para seleccionar, y <enter> para continuar';
       const { answer, events, getScreen } = await render(checkbox, {
         message: 'Select a number',
         choices: numberedChoices,
-        theme: { helpMode: 'never' },
+        theme: {
+          style: {
+            keysHelpTip: () => customHelpText,
+          },
+        },
       });
 
       expect(getScreen()).toMatchInlineSnapshot(`
@@ -1099,36 +1023,14 @@ describe('checkbox prompt', () => {
          ◯ 4
          ◯ 5
          ◯ 6
-         ◯ 7"
-      `);
-      expect(getScreen()).not.toContain(scrollTip);
+         ◯ 7
 
-      events.keypress('down');
-      expect(getScreen()).toMatchInlineSnapshot(`
-        "? Select a number
-         ◯ 1
-        ❯◯ 2
-         ◯ 3
-         ◯ 4
-         ◯ 5
-         ◯ 6
-         ◯ 7"
+        Pulse <space> para seleccionar, y <enter> para continuar"
       `);
-      expect(getScreen()).not.toContain(scrollTip);
+      expect(getScreen()).toContain(customHelpText);
 
+      events.keypress('down');
       events.keypress('space');
-      expect(getScreen()).toMatchInlineSnapshot(`
-        "? Select a number
-         ◯ 1
-        ❯◉ 2
-         ◯ 3
-         ◯ 4
-         ◯ 5
-         ◯ 6
-         ◯ 7"
-      `);
-      expect(getScreen()).not.toContain(scrollTip);
-
       events.keypress('enter');
       await expect(answer).resolves.toEqual([2]);
       expect(getScreen()).toMatchInlineSnapshot(`"✔ Select a number 2"`);

packages/checkbox/src/index.ts

@@ -37,8 +37,6 @@ type CheckboxTheme = {
     description: (text: string) => string;
     keysHelpTip: (keys: [key: string, action: string][]) => string | undefined;
   };
-  /** @deprecated Use theme.style.keysHelpTip instead */
-  helpMode: 'always' | 'never' | 'auto';
   keybindings: ReadonlyArray<Keybinding>;
 };
 
@@ -63,7 +61,6 @@ const checkboxTheme: CheckboxTheme = {
         .map(([key, action]) => `${styleText('bold', key)} ${styleText('dim', action)}`)
         .join(styleText('dim', ' • ')),
   },
-  helpMode: 'always',
   keybindings: [],
 };
 
@@ -97,8 +94,6 @@ type CheckboxConfig<
   message: string;
   prefix?: string;
   pageSize?: number;
-  /** @deprecated Use theme.style.keysHelpTip instead */
-  instructions?: string | boolean;
   choices: ChoicesObject extends ReadonlyArray<string | Separator>
     ? ChoicesObject
     : ReadonlyArray<Choice<Value> | Separator>;
@@ -168,14 +163,7 @@ function normalizeChoices<Value>(
 
 export default createPrompt(
   <Value>(config: CheckboxConfig<Value>, done: (value: Array<Value>) => void) => {
-    const {
-      // eslint-disable-next-line @typescript-eslint/no-deprecated
-      instructions,
-      pageSize = 7,
-      loop = true,
-      required,
-      validate = () => true,
-    } = config;
+    const { pageSize = 7, loop = true, required, validate = () => true } = config;
     const shortcuts = { all: 'a', invert: 'i', ...config.shortcuts };
     const theme = makeTheme<CheckboxTheme>(checkboxTheme, config.theme);
     const { keybindings } = theme;
@@ -294,23 +282,15 @@ export default createPrompt(
       return [prefix, message, answer].filter(Boolean).join(' ');
     }
 
-    let helpLine: string | undefined;
-    // eslint-disable-next-line @typescript-eslint/no-deprecated
-    if (theme.helpMode !== 'never' && instructions !== false) {
-      if (typeof instructions === 'string') {
-        helpLine = instructions;
-      } else {
-        const keys: [string, string][] = [
-          ['↑↓', 'navigate'],
-          ['space', 'select'],
-        ];
-        if (shortcuts.all) keys.push([shortcuts.all, 'all']);
-        if (shortcuts.invert) keys.push([shortcuts.invert, 'invert']);
-        keys.push(['⏎', 'submit']);
-
-        helpLine = theme.style.keysHelpTip(keys);
-      }
-    }
+    const keys: [string, string][] = [
+      ['↑↓', 'navigate'],
+      ['space', 'select'],
+    ];
+    if (shortcuts.all) keys.push([shortcuts.all, 'all']);
+    if (shortcuts.invert) keys.push([shortcuts.invert, 'invert']);
+    keys.push(['⏎', 'submit']);
+
+    const helpLine = theme.style.keysHelpTip(keys);
 
     const lines = [
       [prefix, message].filter(Boolean).join(' '),

packages/core/core.test.ts

@@ -16,14 +16,13 @@ import {
   isSpaceKey,
   Separator,
   AbortPromptError,
-  CancelPromptError,
   ValidationError,
   HookError,
   type KeypressEvent,
   makeTheme,
   type Status,
 } from './src/index.ts';
-import { cursorHide, cursorShow, eraseLines } from '@inquirer/ansi';
+import { cursorShow, eraseLines } from '@inquirer/ansi';
 
 describe('createPrompt()', () => {
   it('onKeypress: allow to implement custom behavior on keypress', async () => {
@@ -463,34 +462,6 @@ describe('createPrompt()', () => {
     await expect(answer).resolves.toEqual('');
   });
 
-  it('allow cancelling the prompt', async () => {
-    const Prompt = (config: { message: string }, done: (value: string) => void) => {
-      useKeypress((key: KeypressEvent) => {
-        if (isEnterKey(key)) {
-          done('done');
-        }
-      });
-
-      return `${config.message} ${cursorHide}`;
-    };
-
-    const prompt = createPrompt(Prompt);
-    const { answer, events, getFullOutput } = await render(prompt, {
-      message: 'Question',
-    });
-
-    // eslint-disable-next-line @typescript-eslint/no-deprecated
-    answer.cancel();
-    events.keypress('enter');
-
-    await expect(answer).rejects.toThrow(CancelPromptError);
-
-    const output = getFullOutput();
-    expect(output).toContain(cursorHide);
-    expect(output).toContain(cursorShow);
-    expect(output.lastIndexOf(cursorHide)).toBeLessThan(output.lastIndexOf(cursorShow));
-  });
-
   it('allow cleaning the prompt after completion', async () => {
     const Prompt = (config: { message: string }, done: (value: string) => void) => {
       useKeypress((key: KeypressEvent) => {
@@ -586,30 +557,6 @@ describe('createPrompt()', () => {
   });
 });
 
-it('allow cancelling the prompt multiple times', async () => {
-  const Prompt = (config: { message: string }, done: (value: string) => void) => {
-    useKeypress((key: KeypressEvent) => {
-      if (isEnterKey(key)) {
-        done('done');
-      }
-    });
-
-    return config.message;
-  };
-
-  const prompt = createPrompt(Prompt);
-  const { answer, events } = await render(prompt, { message: 'Question' });
-
-  // eslint-disable-next-line @typescript-eslint/no-deprecated
-  answer.cancel();
-
-  // eslint-disable-next-line @typescript-eslint/no-deprecated
-  answer.cancel();
-  events.keypress('enter');
-
-  await expect(answer).rejects.toThrow(CancelPromptError);
-});
-
 it('allow aborting the prompt using signals', async () => {
   const Prompt = (config: { message: string }, done: (value: string) => void) => {
     useKeypress((key: KeypressEvent) => {