[claude]

Requested by David Babenko-Sanders · Slack thread

This replaces ora with yocto-spinner for the CLI spinner in src/bin.ts, the same change as electron/docs-parser#214. yocto-spinner has one small dependency (yoctocolors), while ora brings in 17 packages besides chalk, so the published package's runtime dependency tree drops by a net 15 packages. This repo's yarn.lock actually grows by 2 entries for now, because the @electron/docs-parser@^2.0.0 devDependency still depends on ora; the ora tree will leave the lockfile once a docs-parser release that includes #214 is picked up. The API maps directly: ora(text).start() becomes yoctoSpinner({ text }).start(), .text = stays the same, .succeed() becomes .success() and .fail() becomes .error(). The generated electron.d.ts is byte-identical, and the TTY output looks the same apart from spinner frames. Piped (non-TTY) output is a little different: yocto-spinner prints each text update as its own line, so the "Generating API in directory" step now appears in CI logs, and it colors the status symbol unless NO_COLOR is set.

---

Generated by Claude Code

[socket-security]

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Diff	Package	Supply Chain Security	Vulnerability	Quality	Maintenance	License
	yocto-spinner@​1.2.2

View full report

[dsanders11]

Cousin to electron/docs-parser#214 and we'll drop ora out of the lockfile once this repo picks up a newer release of @electron/docs-parser.

[claude]

Nothing blocking. The comments below are optional suggestions. There is no need to push a fix for them before merging.

Additional findings (outside the current diff — GitHub can't attach inline comments there):

• 🟡 src/bin.ts — When generation fails in an interactive terminal, users may be left with a hidden cursor after the CLI exits, which does not happen on the base branch. The .catch handler calls console.error(err) and process.exit(1) while the spinner is still running. As I recall it, yocto-spinner only restores the cursor on SIGINT/SIGTERM, not on 'exit', while ora's cli-cursor/restore-cursor did. Fix: stop the spinner before exiting, e.g. runner.error(chalk.red('Failed to generate definitions')) and then console.error(err) and process.exit(1).

  Why this was flagged

  I could not install yocto-spinner here to check its source, so this assumes, from my reading of yocto-spinner 1.2.2, that start() hides the cursor with '\u001B[?25l' on a TTY and that its only restore hooks are process.once('SIGINT') and process.once('SIGTERM'). The trigger is any failure in generateDefinitions, JSON.parse or writeFile, for example a malformed --api JSON file. That error goes to the .catch at src/bin.ts:77-80, which calls process.exit(1) without stopping runner. Calling process.exit fires 'exit', not a signal, so with yocto-spinner the cursor stays hidden in the user's shell and the last spinner frame stays on the line in front of the error. On the base branch, ora 8 hides the cursor through cli-cursor, which registers restore-cursor's signal-exit onExit hook, so the cursor came back on process.exit(1). The two argv-error paths are not affected because runner.error() stops the spinner first.

  Verification: Trigger: generation fails while the CLI runs in an interactive terminal. The handler at src/bin.ts:77-80 runs console.error(err); process.exit(1); and never calls runner.stop() or runner.error(). On the base branch, restore-cursor registers an onExit hook that writes \u001B[?25h, so ora's hidden cursor comes back. Nothing runs on 'exit', so process.exit(1) leaves the cursor hidden.

[claude]

Confirmed the cursor-restore finding (in a pseudo-TTY, a failing run left the cursor hidden with yocto-spinner but not with ora) and fixed it in 3eceda3 by stopping the spinner with an error mark before exiting; the handler now also covers read/parse failures of the --api file.

---

Generated by Claude Code

[claude]

Code review found no issues

No high-confidence issues detected in this change.

[erickzhao]

sure :)

[electron-npm-package-publisher]

🎉 This PR is included in version 10.0.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀