fix: don't error on files containing special chars

[aarondill]

fixes: #66

Summary by CodeRabbit

• Bug Fixes
  • Improved handling of file names with special characters to enhance file operations.

[coderabbitai]

Summary of changes

autoload/suda.vim: The suda#BufEnter() function has been updated to use fnameescape() for better file name handling.

Objectives from linked issues for validation

#66: suda cannot handle files that include '#' in the name

Title

suda cannot handle files that include '#' in the name

Description

suda seems to be unable to handle files with '#' in the name.

I am able to reproduce this with a very minimal config, e.g.

call plug#begin('~/.local/share/nvim/plugged')
Plug 'lambdalisue/suda.vim'
call plug#end()

$ touch '#test'

chown root:root '#test'

$ nvim '#test'

When I open the file:

Error detected while processing BufEnter Autocommands for "*"..function suda#BufEnter:
line 29:
E194: No alternate file name to substitute for '#': keepalt keepjumps edit suda:///home/user/#test

on :SudaWrite:

Error detected while processing function 8_write:
line 2:
E194: No alternate file name to substitute for '#': write suda:///home/user/#test

Interestingly, if I call the file '##test', the write succeeds, but a file named '##testtest' is written.

Using nvim v0.9.4. Please let me know if I can provide any more information.

Walkthrough

The updates to suda.vim enhance the plugin's capability to handle file names with special characters like #. By employing fnameescape() in the relevant functions, the plugin now ensures that file paths are correctly processed, thus mitigating errors related to file name interpretation in Vim.

Changes

File Path	Change Summary
autoload/suda.vim	Updated suda#BufEnter() to use fnameescape() for file name handling.

Assessment against linked issues

Objective	Addressed	Explanation
Handle files with # in the name (#66)	✅

Poem

A hop, a skip, in the code we dive, 🐰
Fixing bugs, making plugins thrive.
Special chars in names, no more a strife,
suda.vim now handles them, oh what a life!
Cheers to paths, now tamed and neat,
With fnameescape, no defeat! 🌟

---

Recent Review Details

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 65ec6f7 and dbfc53a.

Files selected for processing (1)

• autoload/suda.vim (4 hunks)

Files skipped from review as they are similar to previous changes (1)

• autoload/suda.vim

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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.

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 as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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

[aarondill]

@sserenade can you test this to ensure it works for your usecase(s)?

[sserenade]

Testing this by loading the branch in the config, with a similar test as before:

Plug 'aarondill/suda.vim',{'branch':'fix-other-file'}

$ echo 'foo' > '#test'
$ cat '#test'
foo
# chown root:root '#test'
$ nvim '#test'

On open, I get the below error and the file contents aren't loaded, though vim still thinks I'm editing a file called '#test':

[suda] Vim(read):E194: No alternate file name to substitute for '#'

I'm able to write to the file and save it, with the correct name, with no errors:

bar
:wq

$ cat '#test'
bar

However, opening the file with vim after saving it makes the above error appear again, and the file is not loaded.

[aarondill]

@sserenade can you try with the latest commit?

[sserenade]

With the latest commit, suda now behaves as expected and appears to be able to handle the file. I get no errors upon reading or writing, the file contents are what I expect, and the filename appears correct after writing.

Thank you for your work on this!

[aarondill]

@lambdalisue any thoughts on this before merging it?

[lambdalisue]

LGTM