Skip to content

Conversation

@ryzizub
Copy link
Contributor

@ryzizub ryzizub commented Apr 23, 2025

Status

READY

Description

The path normalization was adding extra \ on windows, that was making the command failing cause it never found the package in path

Type of Change

  • ✨ New feature (non-breaking change which adds functionality)
  • 🛠️ Bug fix (non-breaking change which fixes an issue)
  • ❌ Breaking change (fix or feature that would cause existing functionality to change)
  • 🧹 Code refactor
  • ✅ Build configuration change
  • 📝 Documentation
  • 🗑️ Chore

Summary by CodeRabbit

  • Bug Fixes
    • Improved accuracy in resolving package directory paths when checking for license files.

@ryzizub ryzizub requested a review from a team as a code owner April 23, 2025 12:36
@coderabbitai
Copy link

coderabbitai bot commented Apr 23, 2025

Walkthrough

The update modifies the method for resolving the file system path of a cached package within the license-checking logic. Instead of normalizing the path property of the package root, the code now converts the package root from a URI to a file system path using a dedicated function before normalization. This change impacts how the directory path for each cached package is determined during license verification.

Changes

File(s) Change Summary
lib/src/commands/packages/commands/check/commands/licenses.dart Updated the logic for obtaining the package path by converting the root URI to a file system path before normalization.

Poem

A hop and a skip through the license files,
With paths now decoded in proper styles.
From URI to path, the journey's precise,
Each package discovered, checked in a trice.
So rabbits rejoice, as the code’s more robust,
In the garden of licenses, in clarity we trust! 🐇📄


📜 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 06daf69 and f1dfd62.

📒 Files selected for processing (1)
  • lib/src/commands/packages/commands/check/commands/licenses.dart (1 hunks)
🔇 Additional comments (1)
lib/src/commands/packages/commands/check/commands/licenses.dart (1)

244-244: Good fix for Windows path compatibility!

This change correctly addresses the issue with path normalization on Windows systems. The previous implementation directly accessed the .path property of the cachePackageEntry.root URI, which would add extra backslashes on Windows due to URI escape character handling. Using path.fromUri(cachePackageEntry.root) properly converts the URI to a file system path before normalization, ensuring consistent behavior across platforms.

This is especially important for Windows where file paths use backslashes as separators, and the previous implementation would cause the command to fail because it couldn't locate the package at the malformed path.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

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

}

final packagePath = path.normalize(cachePackageEntry.root.path);
final packagePath = path.normalize(path.fromUri(cachePackageEntry.root));
Copy link
Contributor

Choose a reason for hiding this comment

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

We should try to run our e2e test on windows because it would most likely have been caught then: https://github.com/VeryGoodOpenSource/very_good_cli/blob/main/.github/workflows/e2e.yaml#L51

@ryzizub
Copy link
Contributor Author

ryzizub commented Apr 23, 2025

Duplicate of #1230 💙

@ryzizub ryzizub closed this Apr 23, 2025
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