-
-
Notifications
You must be signed in to change notification settings - Fork 89
Fix vocab-tools generateCloner bug #541
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
Conversation
Summary of ChangesHello @moreal, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request resolves a JSDoc formatting error within the Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request successfully addresses the JSDoc bug in the generateCloner function, ensuring that the generated clone(...) function has valid JSDoc for the options parameter. Additionally, the introduction of new mise tasks for updating snapshots across different environments (Deno, Node.js, Bun) is a valuable improvement to the development workflow, making snapshot management more streamlined.
Codecov Report✅ All modified and coverable lines are covered by tests.
🚀 New features to boost your workflow:
|
98f8281 to
0a0e1fb
Compare
ca73d56 to
2a570ae
Compare
The generateCloner() generated codes used `@options` which is not a valid JSDoc tag. Changed to `@param options` which is the correct syntax for documenting function parameters. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <[email protected]>
🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <[email protected]>
2a570ae to
32ba8d5
Compare
dahlia
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks!
Summary
This pull request lets
generateCloner(in@fedify/vocab-tools) generateclone(...)function with valid JSDoc. The@optionsmay be for representing@param optionsbecause there is a parameter namedoptions.Related issue
I couldn't find related issue when searching with:
label:component/vocab label:component/vocab-tools"@options""JSDoc"Changes
generateClonerfunction in@fedify/vocab-toolsgenerateclone(...)function with@param optionsinstead@options.@fedify/vocab-toolsrun tests in Node.js with--experimental-transform-typesflag instead entering indistdirectory.@fedify/vocab-toolshave new scriptstest:update_snapshots,test:bun,test:bun:update_snapshots.mise task test:update_snapshots,mise task test:deno:update_snapshots,mise task test:node:update_snapshots,mise task test:bun:update_snapshotsto update snapshots easily.Benefits
It will let
@fedify/vocab-toolsgenerate codes withclone(...)function having valid JSDoc. It might be trivial but it is a good thing to serve codes with valid JSDoc.Checklist
@fedify/vocab-toolswill be newly introduced in Fedify 2.0. (not released yet)mise teston your machine?Additional notes
I added
test:bunandtest:bun:update_snapshotsbecause theclass.test.ts.snaplooks for testing Bun. Inclass.test.tsfile, there is also a logic to run tests in Bun.It is an experimental flag but other packages already used it (e.g.,
@fedify/amqp,@fedify/cli, etc).