feat(prompts): Add progressbar (#290)

Co-authored-by: Paul Valladares <[email protected]>

Author: MacFJA

.changeset/slimy-roses-own.md

@@ -0,0 +1,5 @@
+---
+"@clack/prompts": minor
+---
+
+Adds new `progress` prompt to display a progess-bar

examples/basic/package.json

@@ -11,6 +11,7 @@
   "scripts": {
     "start": "jiti ./index.ts",
     "stream": "jiti ./stream.ts",
+    "progress": "jiti ./progress.ts",
     "spinner": "jiti ./spinner.ts",
     "spinner-ci": "npx cross-env CI=\"true\" jiti ./spinner-ci.ts",
     "spinner-timer": "jiti ./spinner-timer.ts"

examples/basic/progress.ts

@@ -0,0 +1,34 @@
+import { setTimeout } from 'node:timers/promises';
+import * as p from '@clack/prompts';
+import type { ProgressResult } from '@clack/prompts';
+
+async function fakeProgress(progressbar: ProgressResult): Promise<void> {
+	await setTimeout(1000);
+	for (const i in Array(10).fill(1)) {
+		progressbar.advance();
+		await setTimeout(100 + Math.random() * 500);
+	}
+}
+
+async function demo() {
+	p.intro('progress start...');
+
+	const download = p.progress({ style: 'block', max: 10, size: 30 });
+	download.start('Downloading package');
+	await fakeProgress(download);
+	download.stop('Download completed');
+
+	const unarchive = p.progress({ style: 'heavy', max: 10, size: 30, indicator: undefined });
+	unarchive.start('Un-archiving');
+	await fakeProgress(unarchive);
+	unarchive.stop('Un-archiving completed');
+
+	const linking = p.progress({ style: 'light', max: 10, size: 30, indicator: 'timer' });
+	linking.start('Linking');
+	await fakeProgress(linking);
+	linking.stop('Package linked');
+
+	p.outro('progress stop...');
+}
+
+void demo();