Skip to content

Conversation

beberiche
Copy link
Contributor

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

Changes

  • Added debug as a direct dependency in fedify/docs to resolve module resolution failure.

Benefits

  • Fixes Uncaught SyntaxError when launching the VitePress dev server.
  • Ensures that Mermaid diagrams continue to render correctly.
  • Improves local development experience without compromising on plugin features.

Checklist

  • Did you add a changelog entry to the CHANGES.md?
  • Did you write some relevant docs about this change (if it's a new feature)?
  • Did you write a regression test to reproduce the bug (if it's a bug fix)?
  • Did you write some tests for this change (if it's a new feature)?
  • Did you run deno task test-all on your machine?

Additional Notes

The root cause is that vitepress-mermaid-plugin indirectly depends on debug, 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

  • ✅ Resolves the error
  • ❌ Disables Mermaid diagram rendering

2. Use pnpm install --shamefully-hoist

  • ✅ Recommended by plugin author
  • ❌ Ineffective in monorepo setup and may negatively impact performance due to full dependency flattening

After evaluation, directly adding debug was the most stable and minimal-impact solution.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a 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 the fedify/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 for vitepress-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

  1. 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.

@github-actions github-actions bot added priority/high High priority issues status/needs triage Needs triage type/bug Something isn't working labels Aug 2, 2025
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a 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.

Copy link
Contributor

github-actions bot commented Aug 2, 2025

The latest push to this pull request has been published to JSR and npm as a pre-release:

Package Version JSR npm
@fedify/fedify 1.8.1-pr.343.1230+25591b09 JSR npm
@fedify/cli 1.8.1-pr.343.1230+25591b09 JSR
@fedify/amqp 1.8.1-pr.343.1230+25591b09 JSR npm
@fedify/express 1.8.1-pr.343.1230+25591b09 JSR npm
@fedify/h3 1.8.1-pr.343.1230+25591b09 JSR npm
@fedify/nestjs 1.8.1-pr.343.1230+25591b09 npm
@fedify/postgres 1.8.1-pr.343.1230+25591b09 JSR npm
@fedify/redis 1.8.1-pr.343.1230+25591b09 JSR npm
@fedify/testing 1.8.1-pr.343.1230+25591b09 JSR npm

Copy link
Contributor

github-actions bot commented Aug 2, 2025

The docs for this pull request have been published:

https://20343936.fedify.pages.dev

@dahlia dahlia merged commit f748fcc into fedify-dev:main Aug 2, 2025
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority/high High priority issues status/needs triage Needs triage type/bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

VitePress dev server shows empty page with uncaught SyntaxError
2 participants