Skip to content

Update biome configuration to version 2.0.0, adjust schema URL, and e…#401

Merged
paul-phan merged 1 commit into
mainfrom
june-2025
Jun 18, 2025
Merged

Update biome configuration to version 2.0.0, adjust schema URL, and e…#401
paul-phan merged 1 commit into
mainfrom
june-2025

Conversation

@paul-phan

@paul-phan paul-phan commented Jun 18, 2025

Copy link
Copy Markdown
Member

…nhance linter settings. Update package versions in package.json and pnpm-lock.yaml. Modify GitHub workflow to use stable Biome version. Add new dependencies and update CHANGELOG for version 1.3.0.

Summary by CodeRabbit

  • Chores
    • Upgraded Biome and related dependencies to the latest stable version.
    • Updated configuration files to reference stable Biome schemas and improved file exclusion patterns.
    • Enhanced pre-commit and commit message hooks to support additional command execution environments.
    • Updated subproject references for templates.
  • Documentation
    • Improved formatting and readability in integration and component guide documents.
    • Added changelog entry for the latest Biome update.

…nhance linter settings. Update package versions in package.json and pnpm-lock.yaml. Modify GitHub workflow to use stable Biome version. Add new dependencies and update CHANGELOG for version 1.3.0.
@coderabbitai

coderabbitai Bot commented Jun 18, 2025

Copy link
Copy Markdown

Walkthrough

This update upgrades Biome and its related configurations from beta to stable version 2.0.0 across the project, updates dependencies and schema references, and improves documentation formatting for readability. Additionally, pre-commit scripts now support running lefthook via devbox as a fallback. No changes were made to exported or public entities.

Changes

File(s) Change Summary
.github/workflows/check.yml Updated Biome setup action to use version "2" instead of "2.0.0-beta.6".
biome.json, packages/biome/biome.json Updated schema URLs from beta to stable; set root to true in root config; extended files exclusion list.
package.json, packages/biome/package.json Upgraded @biomejs/biome dependency from beta to stable; updated package version to 1.3.0.
packages/biome/CHANGELOG.md Added changelog entry for version 1.3.0 noting Biome update.
.lefthook/pre-commit, .lefthook/prepare-commit-msg Added fallback to run lefthook via devbox if available.
docs/guides/third-party-integration.md, docs/guides/weaverse-component.md Improved documentation formatting with additional blank lines for readability.
templates/pilot Updated subproject commit reference.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Pre-commit Script
    participant Mise
    participant Devbox

    User->>Pre-commit Script: Run lefthook command
    Pre-commit Script->>Mise: Try "mise exec -- lefthook -h"
    alt Mise available
        Pre-commit Script->>Mise: Run "mise exec -- lefthook <args>"
    else
        Pre-commit Script->>Devbox: Try "devbox run lefthook -h"
        alt Devbox available
            Pre-commit Script->>Devbox: Run "devbox run lefthook <args>"
        else
            Pre-commit Script->>User: Print error message
        end
    end
Loading

Poem

In the garden of code, Biome blooms anew,
From beta to stable, its roots now grew.
Docs are tidier, scripts more robust—
Lefthook finds its way, in devbox we trust!
With every update, the project feels bright,
Hippity-hop, the future’s in sight! 🐇✨


🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 0

♻️ Duplicate comments (1)
.lefthook/prepare-commit-msg (1)

60-62: Same duplication concern as noted for .lefthook/pre-commit

The devbox fallback is useful, but the growing cascade of elif checks is duplicated across hook scripts. Extracting the resolution logic into a shared helper would improve maintainability.

🧹 Nitpick comments (3)
packages/biome/CHANGELOG.md (1)

3-8: Revise changelog entry for clarity
The entry duplicates the same text as version 1.2.0 ("- update biome to v2"). Consider updating the description to something like "Upgrade Biome to stable v2.0.0 release" for improved clarity and differentiation.

.lefthook/pre-commit (1)

60-62: Reduce duplication by extracting hook-locator logic

The new devbox run lefthook branch works, but each extra elif … lefthook -h line makes the hook scripts harder to maintain (this list now appears in at least two files).
Consider moving the entire lookup chain into a single helper (e.g. .lefthook/find_lefthook) that returns the resolved command; each hook could then simply call that helper. This keeps behaviour consistent and future additions require editing one place only.

.github/workflows/check.yml (1)

26-30: Pin Biome to an explicit minor/patch for deterministic CI

version: 2 will always fetch the latest 2.x release. A future 2.1 could contain breaking changes that unexpectedly break the workflow.
Prefer an explicit range such as 2.0.x or a concrete tag (2.0.0) to keep builds reproducible, and bump deliberately when you’re ready.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 480dfc1 and 1911690.

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (11)
  • .github/workflows/check.yml (1 hunks)
  • .lefthook/pre-commit (1 hunks)
  • .lefthook/prepare-commit-msg (1 hunks)
  • biome.json (2 hunks)
  • docs/guides/third-party-integration.md (13 hunks)
  • docs/guides/weaverse-component.md (4 hunks)
  • package.json (1 hunks)
  • packages/biome/CHANGELOG.md (1 hunks)
  • packages/biome/biome.json (1 hunks)
  • packages/biome/package.json (2 hunks)
  • templates/pilot (1 hunks)
🔇 Additional comments (16)
docs/guides/weaverse-component.md (2)

15-15: Approve whitespace enhancement for list separation

The inserted blank line before the Table of Contents list improves visual separation and aligns with our documentation formatting guidelines.


294-294: Approve whitespace enhancement for list separation

The added blank line before the “Component Types” list enhances readability and maintains consistency with other guides.

docs/guides/third-party-integration.md (6)

13-13: Approve blank line before Table of Contents list

Adding a blank line here cleanly separates the heading from the list and matches the formatting in other guides.


169-169: Approve import of createSchema in code example

The new import { createSchema } from '@weaverse/hydrogen' line ensures the API widget snippet is accurate and self-contained.


173-173: Approve blank line after imports in snippet

This spacing insertion improves readability between imports and subsequent code in the example.


202-202: Approve blank line before component definition

The inserted blank line before const ApiWidget = forwardRef… enhances snippet clarity.


232-232: Approve blank line before export statement

This minor formatting tweak provides better visual delineation in the code block.


265-265: Approve blank line before schema closure

Adding space before the closing brace of the schema example keeps consistency with the surrounding code blocks.

templates/pilot (1)

1-1: Verify updated subproject commit reference

Please confirm that 3d62f34dfb51748d7546c74fc4fdd48a558ae9a5 corresponds to the intended Biome v2.0.0 stable release in the templates/pilot submodule.

You can run the following script from the repo root to validate:

#!/bin/bash
set -e
# Initialize and update the submodule
git submodule update --init templates/pilot

# Check current HEAD of the submodule
cd templates/pilot
current=$(git rev-parse HEAD)
if [ "$current" != "3d62f34dfb51748d7546c74fc4fdd48a558ae9a5" ]; then
  echo "Mismatch: expected 3d62f34dfb51748d7546c74fc4fdd48a558ae9a5, got $current" >&2
  exit 1
fi

# Verify the Biome version bump in submodule configuration
if ! grep -R '"version": "2.0.0"' .; then
  echo "Biome version 2.0.0 not found in submodule files" >&2
  exit 1
fi

echo "Submodule commit and Biome version are correct."
package.json (1)

27-27: Upgrade Biome devDependency to stable 2.0.0
This updates @biomejs/biome from the beta to the stable release.

Please ensure pnpm-lock.yaml is updated to reflect this dependency change.

packages/biome/biome.json (1)

3-3: Update schema URL to stable 2.0.0
The $schema reference has been updated from the beta to the stable schema URL, aligning with the version bump.

biome.json (3)

2-2: Enable root configuration
Setting "root": true correctly designates this as the root Biome config.


3-3: Switch schema to stable 2.0.0
The schema URL has been updated to the stable 2.0.0 version.


19-20: Add ignore patterns for lockfile and CSS
Ignoring package-lock.json and app/styles/app.css helps avoid unnecessary linting on generated or external files.

packages/biome/package.json (2)

3-3: Bump package version to 1.3.0
Version has been correctly incremented to match the changelog entry.


23-23: Upgrade Biome dependency to stable
@biomejs/biome has been updated to ^2.0.0 in this package’s dependencies.

Verify that the corresponding lockfile has been updated.

@paul-phan paul-phan merged commit a7c51ba into main Jun 18, 2025
3 checks passed
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