Organize files

[maekawatoshiki]

Summary

• This is an implementation for Apply part mentioned in #12.
• Adds Markdown Copilot: Organize files command to apply file renaming.

After manually specifying diff and selecting it, run the command.

- path/to/markdown.md
+ corrected/path/name.md
- other/markdown2.md
+ nicer/path/name.md

Remaining tasks

• [x] What if the workspace dir contains so many (>100) files? The editor buffer gets messy with a large diff during List part.

[squld]

@maekawatoshiki Thank you for the work!

Please meet the following requirements:

Command: Apply File Path Diff

• Command name is "Apply File Path Diff"
• Treat a pair of lines as a from/to path change
  • If the number of selected diff lines is odd, report an error
  • If the to line is blank or matches ^\+ *$, delete the from file
• Support cyclic renaming paths

  - path/a.md
  + path/b.md
  - path/b.md
  + path/c.md
  - path/c.md
  + path/a.md

• When an error occurs, the files never be deleted
• When an error occurs, report the details to a buffer
• Works whether the buffer line feed is LF or CRLF
• Detect to path collisions and report errors

  - path/a.md
  + conflict.md
  - path/b.md
  + conflict.md

Command: List File Path Diff

• Command name is "List File Path Diff"
• Run from the context menu of the selected path in VSCode File Explorer
• List paths are limited to the descendants of the selected path and only Markdown files

[maekawatoshiki]

From your review, I've made changes to the Apply File Path Diff part.

[squld]

@maekawatoshiki Thank you for the work!

I tested cyclic renaming paths, but an error occurred. Please support cyclic renaming paths.

Preparation commands:

mkdir -p testdata
touch testdata/a.md testdata/b.md testdata/c.md

Applied File Path Diff:

- testdata/a.md
+ testdata/b.md
- testdata/b.md
+ testdata/c.md
- testdata/c.md
+ testdata/a.md

Displayed error message:

ERROR: Destination file already exists: "testdata/b.md"

[squld]

@maekawatoshiki I have decided to withdraw the cyclic renaming paths feature. After rethinking the use cases, I realized that both cyclic renaming paths and swapping renaming paths are quite rare scenarios.

What do you think?

[maekawatoshiki]

@squld

Implementing cyclic renaming paths is no hard (though I had a wrong understanding 😕), but it's better for code simplicity not to support it.

[squld]

@maekawatoshiki

Implementing cyclic renaming paths is no hard (though I had a wrong understanding 😕), but it's better for code simplicity not to support it.

Thanks for the comment. Let's keep the code simple for now!

[maekawatoshiki]

@squld From your review, I've modified the code to force diff lines in order. Also List File Path Diff is added.