diff --git a/.changeset/pre.json b/.changeset/pre.json index 03235bee..630dc592 100644 --- a/.changeset/pre.json +++ b/.changeset/pre.json @@ -41,6 +41,7 @@ "mean-years-remain", "moody-baboons-greet", "nasty-parrots-laugh", + "odd-bikes-nail", "orange-deers-battle", "rich-plants-call", "sharp-lemons-build", diff --git a/packages/prompts/CHANGELOG.md b/packages/prompts/CHANGELOG.md index 6be18f1d..4ef7897b 100644 --- a/packages/prompts/CHANGELOG.md +++ b/packages/prompts/CHANGELOG.md @@ -1,5 +1,33 @@ # @clack/prompts +## 1.0.0-alpha.7 + +### Minor Changes + +- 38019c7: Updates the API for stopping spinners and progress bars to be clearer + + Previously, both the spinner and progress bar components used a single `stop` method that accepted a code to indicate success, cancellation, or error. This update separates these into distinct methods: `stop()`, `cancel()`, and `error()`: + + ```diff + const spinner = prompts.spinner(); + spinner.start(); + + // Cancelling a spinner + - spinner.stop(undefined, 1); + + spinner.cancel(); + + // Stopping with an error + - spinner.stop(undefined, 2); + + spinner.error(); + ``` + + As before, you can pass a message to each method to customize the output displayed: + + ```js + spinner.cancel("Operation cancelled by user"); + progressBar.error("An error occurred during processing"); + ``` + ## 1.0.0-alpha.6 ### Minor Changes diff --git a/packages/prompts/package.json b/packages/prompts/package.json index 0a636349..30eed455 100644 --- a/packages/prompts/package.json +++ b/packages/prompts/package.json @@ -1,6 +1,6 @@ { "name": "@clack/prompts", - "version": "1.0.0-alpha.6", + "version": "1.0.0-alpha.7", "type": "module", "main": "./dist/index.mjs", "module": "./dist/index.mjs",