Skip to content

Inline jsdoc#3250

Open
nkaradzhov wants to merge 5 commits intoredis:masterfrom
nkaradzhov:inline-jsdoc
Open

Inline jsdoc#3250
nkaradzhov wants to merge 5 commits intoredis:masterfrom
nkaradzhov:inline-jsdoc

Conversation

@nkaradzhov
Copy link
Copy Markdown
Collaborator

@nkaradzhov nkaradzhov commented Apr 23, 2026

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.

  • Move command JSDoc to command registry exports (packages/*/lib/commands/**/index.ts) and remove parseCommand JSDoc from command implementation files.
  • Remove internal @param parser docs from user-facing registry JSDoc.
  • Introduce a lightweight check script: npm run check:command-jsdoc.
  • Add a required PR CI workflow (JSDoc Check) that runs the new check.
  • Remove JSON_JSDOC_SYNC_PLAN.md.

BEFORE
image
AFTER
image


Checklist

  • Does npm test pass with this change (including linting)?
  • Is the new or changed code fully tested?
  • Is a documentation update included (if this change modifies existing APIs, or introduces new ones)?

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., parseCommand blocks) onto the exported command registry entries (notably the Bloom subcommand index.ts registries and many packages/client commands), so docs show up where consumers import/inspect commands.

Adds a lightweight scripts/check-command-jsdoc.ts and npm 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.

Copy link
Copy Markdown

@cursor cursor Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Fix All in Cursor

Reviewed by Cursor Bugbot for commit 9087a9b. Configure here.

Comment thread scripts/check-command-jsdoc.ts Outdated
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.

1 participant