Skip to content

fix(@clack/prompts): handle spinner.stop call when spinner.start was not called #242

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Minishlink
Copy link

Basic reproduction would be

const spin = spinner();
try {
  await doSomethingWithAnotherSpinnerInsideAndThrows();
  spin.start('loading do');
  await doSomething()
  spin.stop('success!')
} catch(error) {
  spin.stop('error!', 2)
  handleError(error)
}

Copy link

changeset-bot bot commented Feb 28, 2025

⚠️ No Changeset found

Latest commit: b78366c

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@DogPawHat
Copy link

Wouldn't it be better if it threw an error instead if stop was called before start?

if (!isSpinnerActive) {
	throw new Error('You can not stop the spinner if it is not active');
}

@Minishlink
Copy link
Author

I'd rather make .stop return early if !isSpinnerActive but I'm ok with this if you can access isSpinnerActive publicly

@43081j
Copy link
Collaborator

43081j commented Apr 16, 2025

i think we should return early like you say

so keep unblock as it is (because if we reach it, it must've been initialised), but change stop to return early:

if (!isSpinnerActive) {
  return;
}

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants