Open
Conversation
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
Reviewed by Cursor Bugbot for commit 9087a9b. Configure here.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.

Description
Currently, JSDocs are not visible to end-users. This PR moves JSDocs to the export location so users can actually see them. It also adds a new mandatory step in CI -> all commands must have JSDocs defined.
BEFORE


AFTER
Checklist
npm testpass with this change (including linting)?Note
Low Risk
Mostly documentation-only refactors plus a new CI gate; runtime behavior should be unchanged, but PRs may start failing if any command registry export lacks an attached JSDoc block.
Overview
Moves user-facing JSDoc from individual command implementation files (e.g.,
parseCommandblocks) onto the exported command registry entries (notably the Bloom subcommandindex.tsregistries and manypackages/clientcommands), so docs show up where consumers import/inspect commands.Adds a lightweight
scripts/check-command-jsdoc.tsandnpm run check:command-jsdoc, plus a new PR GitHub Actions workflow (.github/workflows/jsdoc-check.yml) that runs the check to require JSDoc for each registry export entry.Reviewed by Cursor Bugbot for commit a61efe1. Bugbot is set up for automated code reviews on this repo. Configure here.