Skip to content

Add script that writes types into js doc declarations - #201

Merged
Shrinks99 merged 8 commits into
mainfrom
hover-in-code-help
Oct 19, 2026
Merged

Shrinks99 merged 8 commits into
mainfrom
hover-in-code-help

Conversation

@Shrinks99

Copy link
Copy Markdown
Member

As much as I like our docs, I wish I didn't have to look at them as much :)

Changes

  • Adds descriptions in IDE overlays, auto-generated from props
Screenshot 2026-10-17 at 3 40 23 AM

@matthewmr-eqty matthewmr-eqty left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Really nice. I built it and checked the hovers on Button, Badge, Card and ScrollArea, and all 181 exported components get a list. One small thing inline, not blocking.

Comment thread packages/ui/src/scripts/document-props.js
Comment thread packages/ui/src/scripts/document-props.js Outdated

@matthewmr-eqty matthewmr-eqty left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Really nice. I built it and checked the hovers on Button, Badge, Card and ScrollArea, and all 181 exported components get a list. One small thing inline, not blocking.

Comment thread packages/ui/src/scripts/document-props.js
Comment thread packages/ui/src/scripts/document-props.js Outdated

@tmccoy14 tmccoy14 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

The script runs cleanly in build:lib and documents 181 components, and the output is right for most of them. I left four inline comments: two cases where the hover is wrong or blank, one formatting inconsistency, and the missing tests.


Generated by Claude Code

Comment thread packages/ui/src/scripts/document-props.js
Comment thread packages/ui/src/scripts/document-props.js
Comment thread packages/ui/src/scripts/document-props.js Outdated
Comment thread packages/ui/src/scripts/document-props.js
@Shrinks99

Shrinks99 commented Oct 19, 2026 •

Copy link
Copy Markdown
Member Author

Added tests and fixed the above issues. Also ran another round of Claude review and didn't find anything I deemed needed fixing.

I think as a follow up it would be good to generate the props table in each mdx file based on this info and in-line all the comments too. Not doing in this PR but would be good for the future if we have some time :)

@Shrinks99
Shrinks99 merged commit 3ea8fc0 into main Oct 19, 2026
1 check passed
@Shrinks99
Shrinks99 deleted the hover-in-code-help branch October 19, 2026 19:32
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