-
-
Notifications
You must be signed in to change notification settings - Fork 84
deps: add debug package to fix VitePress dev server import error #343
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
deps: add debug package to fix VitePress dev server import error #343
Conversation
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.
Summary of Changes
Hello @beberiche, 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 critical dependency resolution bug affecting the VitePress development server within the fedify/docs
package. By directly adding a previously indirect dependency, it ensures the development environment functions as expected, resolving runtime errors and maintaining existing features.
Highlights
- Dependency Management: I've explicitly added the
debug
package as a direct dependency to thefedify/docs
package. This addresses a module resolution issue that was causing a runtime syntax error in the VitePress development server. - Bug Fix: This change resolves an
Uncaught SyntaxError
that occurred when launching the VitePress dev server. The root cause was an indirect dependency (debug
forvitepress-mermaid-plugin
) not being properly hoisted by pnpm in a monorepo environment. - Development Experience: By fixing this dependency issue, I've improved the local development experience. The VitePress dev server now starts correctly, and critical features like Mermaid diagram rendering remain functional.
Using Gemini Code Assist
The 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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command>
or @gemini-code-assist <command>
. Below is a summary of the supported commands.
Feature | Command | Description |
---|---|---|
Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
Help | /gemini help |
Displays a list of available commands. |
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 .gemini/
folder in the base of the repository. Detailed instructions can be found here.
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 or fill out our survey to provide feedback.
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
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
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 adds the debug
package as a direct dependency to resolve a VitePress dev server error. The review suggests using a specific, stable version of the debug
package to ensure build reproducibility.
The latest push to this pull request has been published to JSR and npm as a pre-release:
|
The docs for this pull request have been published: |
Summary
This PR adds the
debug
package directly to the fedify/docs package to resolve a vitepress dev runtime syntax error caused by a missing indirect dependency.Related Issue
SyntaxError
#330Changes
debug
as a direct dependency infedify/docs
to resolve module resolution failure.Benefits
Uncaught SyntaxError
when launching the VitePress dev server.Checklist
deno task test-all
on your machine?Additional Notes
The root cause is that
vitepress-mermaid-plugin
indirectly depends ondebug
, which isn't hoisted properly by pnpm, leading to module resolution errors in monorepo environments.See related discussion: vitepress-plugin-mermaid issue #87
Alternative solutions considered:
1. Remove
vitepress-mermaid-plugin
2. Use
pnpm install --shamefully-hoist
After evaluation, directly adding
debug
was the most stable and minimal-impact solution.