test: add tests for labels/hints in select

Author: 43081j

packages/prompts/src/__snapshots__/index.test.ts.snap

@@ -169,6 +169,31 @@ exports[`prompts (isCI = false) > multiselect > can cancel 1`] = `
 ]
 `;
 
+exports[`prompts (isCI = false) > multiselect > can render option hints 1`] = `
+[
+  "[?25l",
+  "│
+◆  foo
+│  ◻ opt0 (Hint 0)
+│  ◻ opt1
+└
+",
+  "",
+  "",
+  "",
+  "│  ◼ opt0 (Hint 0)",
+  "",
+  "",
+  "",
+  "",
+  "◇  foo
+│  opt0",
+  "
+",
+  "[?25h",
+]
+`;
+
 exports[`prompts (isCI = false) > multiselect > can set cursorAt to preselect an option 1`] = `
 [
   "[?25l",
@@ -194,6 +219,31 @@ exports[`prompts (isCI = false) > multiselect > can set cursorAt to preselect an
 ]
 `;
 
+exports[`prompts (isCI = false) > multiselect > can set custom labels 1`] = `
+[
+  "[?25l",
+  "│
+◆  foo
+│  ◻ Option 0
+│  ◻ Option 1
+└
+",
+  "",
+  "",
+  "",
+  "│  ◼ Option 0",
+  "",
+  "",
+  "",
+  "",
+  "◇  foo
+│  Option 0",
+  "
+",
+  "[?25h",
+]
+`;
+
 exports[`prompts (isCI = false) > multiselect > can set initial values 1`] = `
 [
   "[?25l",
@@ -1244,6 +1294,31 @@ exports[`prompts (isCI = true) > multiselect > can cancel 1`] = `
 ]
 `;
 
+exports[`prompts (isCI = true) > multiselect > can render option hints 1`] = `
+[
+  "[?25l",
+  "│
+◆  foo
+│  ◻ opt0 (Hint 0)
+│  ◻ opt1
+└
+",
+  "",
+  "",
+  "",
+  "│  ◼ opt0 (Hint 0)",
+  "",
+  "",
+  "",
+  "",
+  "◇  foo
+│  opt0",
+  "
+",
+  "[?25h",
+]
+`;
+
 exports[`prompts (isCI = true) > multiselect > can set cursorAt to preselect an option 1`] = `
 [
   "[?25l",
@@ -1269,6 +1344,31 @@ exports[`prompts (isCI = true) > multiselect > can set cursorAt to preselect an
 ]
 `;
 
+exports[`prompts (isCI = true) > multiselect > can set custom labels 1`] = `
+[
+  "[?25l",
+  "│
+◆  foo
+│  ◻ Option 0
+│  ◻ Option 1
+└
+",
+  "",
+  "",
+  "",
+  "│  ◼ Option 0",
+  "",
+  "",
+  "",
+  "",
+  "◇  foo
+│  Option 0",
+  "
+",
+  "[?25h",
+]
+`;
+
 exports[`prompts (isCI = true) > multiselect > can set initial values 1`] = `
 [
   "[?25l",

packages/prompts/src/index.test.ts

@@ -749,5 +749,45 @@ describe.each(['true', 'false'])('prompts (isCI = %s)', (isCI) => {
 			expect(value).toEqual(['opt0']);
 			expect(output.buffer).toMatchSnapshot();
 		});
+
+		test('can set custom labels', async () => {
+			const result = prompts.multiselect({
+				message: 'foo',
+				options: [
+					{ value: 'opt0', label: 'Option 0' },
+					{ value: 'opt1', label: 'Option 1' },
+				],
+				input,
+				output,
+			});
+
+			input.emit('keypress', '', { name: 'space' });
+			input.emit('keypress', '', { name: 'return' });
+
+			const value = await result;
+
+			expect(value).toEqual(['opt0']);
+			expect(output.buffer).toMatchSnapshot();
+		});
+
+		test('can render option hints', async () => {
+			const result = prompts.multiselect({
+				message: 'foo',
+				options: [
+					{ value: 'opt0', hint: 'Hint 0' },
+					{ value: 'opt1', hint: 'Hint 1' },
+				],
+				input,
+				output,
+			});
+
+			input.emit('keypress', '', { name: 'space' });
+			input.emit('keypress', '', { name: 'return' });
+
+			const value = await result;
+
+			expect(value).toEqual(['opt0']);
+			expect(output.buffer).toMatchSnapshot();
+		});
 	});
 });