Skip to content
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

Upgrade Docusaurus and dev dependencies #1787

Merged
merged 1 commit into from
Jan 21, 2025
Merged

Conversation

esimkowitz
Copy link
Member

@esimkowitz esimkowitz commented Jan 21, 2025

This removes another blocker to full React 19 support, among other things. It also adds the new @docusaurus/plugin-svgr plugin, which is now required to load SVG assets.

The last blocker to React 19 is @monaco-editor/react, which has added support in its release candidate for 4.7.0 and will hopefully release to stable soon.

Copy link
Contributor

coderabbitai bot commented Jan 21, 2025

Walkthrough

The pull request introduces updates to the documentation site configuration and project dependencies. In the Docusaurus configuration (docs/docusaurus.config.ts), a new plugin @docusaurus/plugin-svgr was added, enabling SVG file imports as React components. The docs/package.json and root package.json files underwent comprehensive dependency updates, primarily upgrading Docusaurus-related packages from version 3.6.3 to 3.7.0. Additionally, various development dependencies such as ESLint, TypeScript, and testing tools were incrementally updated to their latest versions. The changes aim to ensure compatibility, incorporate recent improvements, and enhance the project's dependency management.


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 631a2e5 and fae11b4.

⛔ Files ignored due to path filters (1)
  • yarn.lock is excluded by !**/yarn.lock, !**/*.lock
📒 Files selected for processing (3)
  • docs/docusaurus.config.ts (1 hunks)
  • docs/package.json (3 hunks)
  • package.json (3 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (5)
  • GitHub Check: Analyze (javascript-typescript)
  • GitHub Check: Build for TestDriver.ai
  • GitHub Check: merge-gatekeeper
  • GitHub Check: Build Docsite
  • GitHub Check: Analyze (go)
🔇 Additional comments (5)
docs/docusaurus.config.ts (1)

63-63: LGTM! Plugin addition for SVG support.

The addition of @docusaurus/plugin-svgr enables importing SVG files as React components, enhancing the documentation's visual capabilities.

Let's verify the plugin is properly configured in package.json:

✅ Verification successful

Plugin properly configured in both config and dependencies

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Verify plugin dependency exists in package.json
rg '"@docusaurus/plugin-svgr":\s*"\^3\.7\.0"' docs/package.json

Length of output: 110

docs/package.json (3)

18-25: LGTM! Consistent Docusaurus package updates.

All Docusaurus packages have been updated to version 3.7.0, maintaining version consistency across the framework.


27-27: Good practice: Using commit hash for better version control.

Pinning @waveterm/docusaurus-og to a specific commit hash improves reproducibility and version control.


Line range hint 39-59: LGTM! Dev dependencies updated to latest versions.

Development dependencies have been updated to their latest versions, including TypeScript, ESLint, and related packages.

Let's verify the compatibility of the updated versions:

✅ Verification successful

All dependency versions are compatible and up-to-date

The updated dependencies are using their latest available versions, and all peer dependency requirements are satisfied, particularly between TypeScript 5.7.3, ESLint 9.18.0, and typescript-eslint 8.21.0.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check for any reported incompatibilities between the updated packages
yarn why typescript eslint typescript-eslint

Length of output: 652


Script:

#!/bin/bash
# Check package information from npm registry
echo "Checking TypeScript..."
curl -s "https://registry.npmjs.org/typescript/latest" | jq -r '.version'

echo -e "\nChecking ESLint..."
curl -s "https://registry.npmjs.org/eslint/latest" | jq -r '.version'

echo -e "\nChecking typescript-eslint..."
curl -s "https://registry.npmjs.org/typescript-eslint/latest" | jq -r '.version'
curl -s "https://registry.npmjs.org/typescript-eslint/latest" | jq -r '.peerDependencies'

echo -e "\nChecking @docusaurus/core..."
curl -s "https://registry.npmjs.org/@docusaurus/core/latest" | jq -r '.version'

Length of output: 736

package.json (1)

31-32: LGTM! Comprehensive dev dependency updates.

Development dependencies have been updated to their latest versions, including:

  • Build tools: vite (6.0.11), vitest (3.0.3)
  • Linting: eslint (9.18.0), typescript-eslint (8.21.0)
  • Type definitions and other tools

Let's verify the compatibility of the updated build tools:

Also applies to: 46-46, 60-60, 64-65, 70-70, 77-79, 84-84

✅ Verification successful

Dependencies are compatible and well-configured

The updated dependencies show compatible version combinations:

  • Vite 6.x and Vitest 3.x work together as expected
  • TypeScript 5.7.x is compatible with all related dev tools
  • Configuration files show proper integration without version conflicts
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check for any reported incompatibilities between vite and vitest
yarn why vite vitest

# Verify typescript version compatibility with updated dependencies
yarn why typescript

Length of output: 1256


Script:

#!/bin/bash
# Check package.json for peer dependencies and version requirements
cat package.json | jq '.peerDependencies, .dependencies, .devDependencies'

# Look for configuration files
fd -e config.ts -e config.js -e config.mjs vite vitest
fd tsconfig.json

# Check if there are any explicit version requirements in configs
rg -A 5 "vite|vitest|typescript" -g "*.config.*"

Length of output: 7329

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@esimkowitz esimkowitz merged commit 2155ec3 into main Jan 21, 2025
9 of 10 checks passed
@esimkowitz esimkowitz deleted the evan/docusaurus-upgrade branch January 21, 2025 21:43
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.

1 participant