-
-
Notifications
You must be signed in to change notification settings - Fork 90
Add backward compatibility for @fedify/fedify/vocab module #549
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
The @fedify/vocab package was split out from @fedify/fedify in fedify-dev#517, but the original @fedify/fedify/vocab module was completely removed, breaking existing code. This change restores the @fedify/fedify/vocab module as a deprecated re-export of @fedify/vocab, allowing existing code to continue working while users gradually migrate to importing from @fedify/vocab directly. The module is marked with @deprecated JSDoc tags to guide users toward the migration. Changes include: - Created packages/fedify/src/vocab/mod.ts that re-exports all exports from @fedify/vocab with deprecation notice - Added ./vocab export to deno.json for Deno environment - Added ./vocab export to package.json for Node.js/Bun - Added ./src/vocab/mod.ts to tsdown build entry points - Updated CHANGES.md to document the deprecation Related to fedify-dev#437 and fedify-dev#517.
Summary of ChangesHello @dahlia, 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 addresses a breaking change introduced by the previous split of the vocabulary module into a standalone 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 effectively restores backward compatibility for the @fedify/fedify/vocab module by re-introducing it as a deprecated re-export of the new @fedify/vocab package. The implementation is clean and thorough. The new module correctly re-exports from @fedify/vocab and is well-documented with a @deprecated JSDoc tag to guide users. All necessary configuration files (deno.json, package.json, tsdown.config.ts) have been updated correctly, and the changelog (CHANGES.md) clearly communicates the change. The pull request is well-executed and I have no suggestions for improvement.
Codecov Report✅ All modified and coverable lines are covered by tests. 🚀 New features to boost your workflow:
|
2chanhaeng
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.
LGTM!
Summary
Restores the
@fedify/fedify/vocabmodule as a deprecated re-export of@fedify/vocabto maintain backward compatibility after the vocabulary split in #517.The
@fedify/vocabpackage was split out from@fedify/fedifyin #517, but the original@fedify/fedify/vocabmodule was completely removed. This broke existing code that imports from@fedify/fedify/vocab.This PR adds back the module as a deprecated wrapper that re-exports everything from
@fedify/vocab, allowing existing code to continue working while users migrate to the new package.Related issues
@fedify/fedifyinto@fedify/vocab#517Changes
packages/fedify/src/vocab/mod.tsthat re-exports all exports from@fedify/vocabwith@deprecatedJSDoc tags./vocabexport topackages/fedify/deno.jsonfor Deno environment./vocabexport topackages/fedify/package.jsonfor Node.js/Bun environments./src/vocab/mod.tstopackages/fedify/tsdown.config.tsbuild entry pointsCHANGES.mdto document the deprecation in both@fedify/fedifyand@fedify/vocabsectionsBenefits
@fedify/fedify/vocabcontinues to work without breaking@fedify/vocabat their own pace@deprecatedtags guide users toward the new packageMigration guide (for users)
Users are encouraged to migrate from:
To:
The old import path will continue to work but will show deprecation warnings in IDEs and documentation.
Checklist
deno task test-allon your machine?