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.

Sign up for GitHub

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

Jump to bottom

Split paths by both backslash and forward slash on Windows #505

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Split paths by both backslash and forward slash on Windows #505

wants to merge 1 commit into from

Conversation

lambdalisue
Copy link
Owner

@lambdalisue lambdalisue commented Sep 24, 2024 •
edited by coderabbitai bot
Loading

May close #478

Summary by CodeRabbit

  • New Features

    • Enhanced path handling to support both backslashes and forward slashes for improved compatibility with Windows-style paths.

  • Bug Fixes

    • Ensured that empty components are filtered out correctly during path processing.

@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Sep 24, 2024 •
edited
Loading

Walkthrough

The changes made in the pull request involve updating the s:to_slash_windows function in the autoload/fern/internal/filepath.vim file. The function now splits input paths using both backslashes (\) and forward slashes (/), improving its capability to handle different path formats on Windows. The filtering process for empty components remains unchanged, and the final output still concatenates non-empty components with a forward slash (/), with a prefix for absolute paths.

Changes

File Change Summary
autoload/fern/internal/filepath.vim Updated s:to_slash_windows to split paths using both \ and /. Filtering remains unchanged.

Assessment against linked issues

Objective Addressed Explanation
Reveal doesn't work with slash (/) separated path on Windows ( #478) ✅

🐇 In the land of paths, both slashes unite,
A function enhanced, making coding delight.
With each little hop, we handle with care,
Windows now smiles, no need for despair!
So let’s celebrate, with joy we shall sing,
For paths are now merry, let the code bring! 🎉

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.

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.

@lambdalisue lambdalisue mentioned this pull request Sep 24, 2024
Open
coderabbitai[bot]
coderabbitai bot reviewed Sep 24, 2024
View reviewed changes
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

Outside diff range and nitpick comments (2)
autoload/fern/internal/filepath.vim (2)

Line range hint 9-12: Consider updating fern#internal#filepath#from_slash for Unix systems

The fern#internal#filepath#from_slash function currently calls s:to_slash_unix for Unix systems, which might not be the intended behavior. Consider creating a dedicated s:from_slash_unix function or verifying if the current implementation is correct.

function! fern#internal#filepath#from_slash(path) abort
  return g:fern#internal#filepath#is_windows
        \ ? s:from_slash_windows(a:path)
        \ : s:from_slash_unix(a:path)  " This function doesn't exist yet
endfunction

Line range hint 48-51: Consider updating s:from_slash_windows for consistency

The s:to_slash_windows function now handles both backslashes and forward slashes, but s:from_slash_windows still only splits on forward slashes. For consistency, consider updating s:from_slash_windows to handle both slash types as well:

function! s:from_slash_windows(path) abort
  let terms = filter(split(a:path, '\\/'), '!empty(v:val)')
  let path = join(terms, '\')
  return path[:2] =~# '^\w:$' ? path . '\' : path
endfunction

This change would make the behavior more symmetric and robust.

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between a675dff and 0ea569c.

Files selected for processing (1)
  • autoload/fern/internal/filepath.vim (1 hunks)
Additional comments not posted (1)
autoload/fern/internal/filepath.vim (1)

43-43: Excellent modification to improve path handling on Windows

This change effectively addresses the PR objective and the issue mentioned in #478. By modifying the split function to use both backslashes and forward slashes as delimiters, the s:to_slash_windows function can now handle Windows paths regardless of the slash type used.

Key improvements:

  1. Increased flexibility in path handling on Windows.
  2. Resolves the issue where the reveal function didn't work with forward slash separated paths.
  3. Maintains consistency with the function's purpose of standardizing path formats.

The change is minimal, targeted, and doesn't introduce any apparent negative side effects. Great job on implementing this solution!

@lambdalisue lambdalisue force-pushed the fix-reveal-on-windows branch from 0ea569c to 473a94e Compare October 15, 2024 18:20
@lambdalisue lambdalisue marked this pull request as draft October 15, 2024 18:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Reveal doesn't work with slach (/) separated path on Windows
1 participant
@lambdalisue