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

Build/go fast #616

Merged
merged 2 commits into from
Nov 26, 2024
Merged

Build/go fast #616

merged 2 commits into from
Nov 26, 2024

Conversation

ccamel
Copy link
Member

@ccamel ccamel commented Nov 26, 2024

Time to go faster - https://docusaurus.io/blog/releases/3.6#adoption-strategy

Summary by CodeRabbit

  • New Features

    • Introduced an experimental configuration option for enhanced performance in the Docusaurus application.
    • Added a new dependency to improve build efficiency.
  • Chores

    • Removed outdated Babel configuration file, streamlining project setup.

@ccamel ccamel self-assigned this Nov 26, 2024
Copy link

vercel bot commented Nov 26, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 26, 2024 6:54pm

Copy link
Contributor

coderabbitai bot commented Nov 26, 2024

Walkthrough

The changes involve the removal of the babel.config.js file, which contained Babel configuration for JavaScript transpilation. In contrast, the docusaurus.config.js file has been updated to include a new experimental configuration option, experimental_faster, set to true. Additionally, the package.json file has been modified to add a new dependency, @docusaurus/faster, at version ^3.6.3. These alterations indicate a shift in how the project handles JavaScript processing and introduces new configuration capabilities.

Changes

File Change Summary
babel.config.js File removed; previously defined Babel configuration.
docusaurus.config.js Added future: { experimental_faster: true } to config.
package.json Added dependency: "@docusaurus/faster": "^3.6.3" in dependencies.

Poem

In the garden where code does play,
A config was lost, but that's okay!
With faster paths now in sight,
New dependencies bring delight.
Hop along, let changes bloom,
In our code, there's always room! 🐇✨


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

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.

@bot-anik
Copy link
Member

Dependencies added

@docusaurus/faster

DescriptionDocusaurus experimental package exposing new modern dependencies to make the build faster.
LicenseMIT

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)
package.json (2)

32-32: LGTM! Good architectural improvement for build performance.

The addition of @docusaurus/faster aligns with Docusaurus 3.6's adoption strategy for improved build performance. This change, combined with the removal of babel.config.js, indicates a shift towards modern build tooling that should result in faster builds.


Line range hint 71-72: Align Docusaurus dev dependency versions

The Docusaurus type-related dev dependencies are on different versions:

  • @docusaurus/module-type-aliases: ^3.6.1
  • @docusaurus/types: ^3.5.2

While this might work, it's recommended to align all Docusaurus packages to the same major.minor version (3.6.3) to ensure type consistency.

  "devDependencies": {
-   "@docusaurus/module-type-aliases": "^3.6.1",
-   "@docusaurus/types": "^3.5.2",
+   "@docusaurus/module-type-aliases": "^3.6.3",
+   "@docusaurus/types": "^3.6.3",
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 460c744 and 415e2e8.

⛔ Files ignored due to path filters (1)
  • yarn.lock is excluded by !**/yarn.lock, !**/*.lock
📒 Files selected for processing (3)
  • babel.config.js (0 hunks)
  • docusaurus.config.js (1 hunks)
  • package.json (1 hunks)
💤 Files with no reviewable changes (1)
  • babel.config.js
✅ Files skipped from review due to trivial changes (1)
  • docusaurus.config.js

Copy link
Member

@bot-anik bot-anik left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Device URL
desktop http://localhost:3000/

Device URL
mobile http://localhost:3000/

Not what you expected? Are your scores flaky? GitHub runners could be the cause.
Try running on Foo instead

@ccamel
Copy link
Member Author

ccamel commented Nov 26, 2024

LGTM

@ccamel ccamel merged commit dbb8bda into main Nov 26, 2024
15 checks passed
@ccamel ccamel deleted the build/go-fast branch November 26, 2024 18:58
@ccamel
Copy link
Member Author

ccamel commented Nov 26, 2024

Nice!

Screenshot 2024-11-26 at 20 01 41

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.

2 participants