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

feat(astro-tests): Use stable Astro Config APIs #203

Merged
merged 4 commits into from
Feb 27, 2025
Merged

Conversation

Fryuni
Copy link
Owner

@Fryuni Fryuni commented Feb 14, 2025

Summary by CodeRabbit

  • New Features

    • Released a new minor version of the Astro Tests package, now leveraging stable Astro APIs for enhanced reliability.
  • Chores

    • Adjusted dependency management by moving the Astro package from direct dependencies to peer dependencies.
    • Updated the Astro version requirement in the project workspace.
  • Refactor

    • Improved configuration validation to deliver clearer error messaging during setup.

@Fryuni Fryuni self-assigned this Feb 14, 2025
Copy link

vercel bot commented Feb 14, 2025

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

Name Status Preview Updated (UTC)
inox-tools ✅ Ready (Inspect) Visit Preview Feb 27, 2025 4:27pm

Copy link

coderabbitai bot commented Feb 14, 2025

Walkthrough

This pull request introduces a minor version update for the @inox-tools/astro-tests package as recorded in the changeset. The update also shifts the dependency management for the astro package by moving it from dependencies to peerDependencies in the package configuration, and updates the Astro version range in the workspace configuration. Additionally, the loadFixture function in the astro-tests source has been refactored to destructure its configuration parameter and directly validate the root property.

Changes

File(s) Change Summary
.changeset/late-dogs-grab.md, pnpm-workspace.yaml Added a changeset entry for a minor version update of @inox-tools/astro-tests and updated the Astro version from ^5.2.5 to ^5.4.0.
packages/astro-tests/package.json Removed "astro": "catalog:" from dependencies and added it to a new peerDependencies section.
packages/astro-tests/src/astroFixture.ts Refactored the loadFixture function to destructure inlineConfig, checking for root directly and streamlining the configuration handling.

Sequence Diagram(s)

sequenceDiagram
    participant C as Caller
    participant L as loadFixture
    participant V as getViteConfig

    C->>L: Call loadFixture(inlineConfig)
    L->>L: Destructure inlineConfig to (root, ...remaining)
    alt root not provided
         L->>C: Throw error ("Missing root")
    else root provided
         L->>L: Process and validate root (URL/path conversions)
         L->>V: Call getViteConfig(inlineConfig)
         V-->>L: Return Vite config
         L->>C: Return Fixture object
    end
Loading

Possibly related PRs

Suggested labels

documentation, bug

Suggested reviewers

  • BryceRussell
  • florian-lefebvre
  • OliverSpeir

Poem

I'm a bunny in the code forest, light on my feet,
Hopping over changes, where two systems meet.
With version bumps and refactored flows,
I celebrate each line as the magic grows.
Through configs and fixes, my joy is complete! 🐇✨

✨ Finishing Touches
  • 📝 Generate Docstrings

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

@Fryuni Fryuni changed the title wip(astro-tests): Use stable Astro APIs from withastro/astro#12052 wip(astro-tests): Use stable Astro Config APIs Feb 14, 2025
@Fryuni Fryuni changed the title wip(astro-tests): Use stable Astro Config APIs feat(astro-tests): Use stable Astro Config APIs Feb 27, 2025
@Fryuni Fryuni marked this pull request as ready for review February 27, 2025 16:26
Copy link

@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

🧹 Nitpick comments (1)
packages/astro-tests/package.json (1)

47-50: Good dependency management change.

Moving Astro from dependencies to peerDependencies is a sound architectural decision, allowing consumers to provide their own version of Astro and preventing potential duplicate installations.

This change provides more flexibility and follows best practices for libraries that integrate with frameworks but don't need to bundle them.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 40adb0e and 5a4e4b7.

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (4)
  • .changeset/late-dogs-grab.md (1 hunks)
  • packages/astro-tests/package.json (1 hunks)
  • packages/astro-tests/src/astroFixture.ts (4 hunks)
  • pnpm-workspace.yaml (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • .changeset/late-dogs-grab.md
⏰ Context from checks skipped due to timeout of 120000ms (1)
  • GitHub Check: E2E test
🔇 Additional comments (6)
pnpm-workspace.yaml (1)

2-2: Astro version update matches PR objectives.

The version bump from ^5.2.5 to ^5.4.0 aligns with the PR's goal of using stable Astro Config APIs introduced in version 5.4.0.

packages/astro-tests/src/astroFixture.ts (5)

8-8: Proper imports for the Astro Config API.

The import statement now explicitly includes all the necessary functions from astro/config, improving code clarity and maintainability.


155-157: Improved function signature with better parameter handling.

The function signature has been refactored to destructure the root property directly, which makes the code more readable and allows for better error handling.

The early validation of the root parameter with a clear error message is a good practice that improves developer experience.


183-201: Streamlined root path handling.

The refactored code directly assigns to inlineConfig.root instead of using a separate variable, reducing complexity while maintaining the same functionality.

The code correctly handles various formats of the root parameter (string, URL, relative, absolute).


203-203: Direct use of inlineConfig.root in validateConfig.

Using inlineConfig.root directly in the validateConfig call simplifies the code.


208-211: Simplified getViteConfig call.

The refactored code removes unnecessary object spreading and directly passes inlineConfig to getViteConfig.

@Fryuni Fryuni merged commit 2e64078 into main Feb 27, 2025
19 checks passed
@Fryuni Fryuni deleted the feat/new-test-api branch February 27, 2025 16:30
@coderabbitai coderabbitai bot mentioned this pull request Feb 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant