feat(@clack/prompts): new method spinner.message(msg: string) (#112)

Author: cpreston321

.changeset/loud-bugs-move.md

@@ -0,0 +1,5 @@
+---
+'@clack/prompts': minor
+---
+
+added a new method called `spinner.message(msg: string)`

examples/basic/package.json

@@ -9,7 +9,8 @@
     "picocolors": "^1.0.0"
   },
   "scripts": {
-    "start": "jiti ./index.ts"
+    "start": "jiti ./index.ts",
+    "spinner": "jiti ./spinner.ts"
   },
   "devDependencies": {
     "jiti": "^1.17.0"

examples/basic/spinner.ts

@@ -0,0 +1,22 @@
+import * as p from '@clack/prompts';
+
+p.intro('spinner start...');
+
+const spin = p.spinner();
+const total = 10000;
+let progress = 0;
+spin.start();
+
+new Promise((resolve) => {
+	const timer = setInterval(() => {
+		progress = Math.min(total, progress + 100);
+		if (progress >= total) {
+			clearInterval(timer);
+			resolve(true);
+		}
+		spin.message(`Loading packages [${progress}/${total}]`); // <===
+	}, 100);
+}).then(() => {
+	spin.stop(`Done`);
+	p.outro('spinner stop...');
+});

packages/prompts/src/index.ts

@@ -640,9 +640,11 @@ const frames = unicode ? ['◒', '◐', '◓', '◑'] : ['•', 'o', 'O', '0'];
 export const spinner = () => {
 	let unblock: () => void;
 	let loop: NodeJS.Timer;
+	let message = '';
 	const delay = unicode ? 80 : 120;
 	return {
-		start(message = '') {
+		start(msg = '') {
+			this.message(msg);
 			message = message.replace(/\.?\.?\.$/, '');
 			unblock = block();
 			process.stdout.write(`${color.gray(S_BAR)}\n${color.magenta('○')}  ${message}\n`);
@@ -660,7 +662,11 @@ export const spinner = () => {
 				dot = dot === frames.length ? 0 : dot + 0.125;
 			}, delay);
 		},
-		stop(message = '') {
+		message(msg = '') {
+			message = msg ?? message;
+		},
+		stop(msg = '') {
+			this.message(msg);
 			process.stdout.write(cursor.move(-999, -2));
 			process.stdout.write(erase.down(2));
 			clearInterval(loop);