nvim-lsp-file-operations

# nvim-lsp-file-operations

`nvim-lsp-file-operations` is a Neovim plugin that adds support for file operations using [built-in LSP support](https://neovim.io/doc/user/lsp/).

This plugin works by subscribing to events emitted by either of these plugins
(other integrations may be added if needed):

- [nvim-neo-tree/neo-tree.nvim](https://github.com/nvim-neo-tree/neo-tree.nvim)
- [nvim-tree/nvim-tree.lua](https://github.com/nvim-tree/nvim-tree.lua)
- [simonmclean/triptych.nvim](https://github.com/simonmclean/triptych.nvim)

<https://user-images.githubusercontent.com/14187674/211327507-39f21a74-0a43-43f0-ba3e-91109125286c.mp4>

---

## Features

Full implementation of all `workspace.fileOperations` for [the current LSP spec](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.18/specification/):

- [`workspace/DidCreate`](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.18/specification/#workspace_didCreateFiles)
- [`workspace/DidDelete`](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.18/specification/#workspace_didDeleteFiles)
- [`workspace/DidRename`](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.18/specification/#workspace_didRenameFiles) - Tested in:
  - [lua-language-server](https://github.com/LuaLS/lua-language-server)
  - [vtsls](https://github.com/yioneko/vtsls)
- [`workspace/WillCreate`](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.18/specification/#workspace_willCreateFiles)
- [`workspace/WillDelete`](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.18/specification/#workspace_willDeleteFiles)
- [`workspace/WillRename`](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.18/specification/#workspace_willRenameFiles) - Tested in:
  - [basedpyright](https://docs.basedpyright.com/latest)
  - [metals](https://scalameta.org/metals/)
  - [rust-analyzer](https://rust-analyzer.github.io/)
  - [typescript-language-server](https://github.com/typescript-language-server/typescript-language-server)

**If you have use cases for any other operations please open an issue.**

---

## Table of Contents

- [Installation](#installation)
- [Setup](#setup)
  - [LSP Capabilities](#lsp-capabilities)
- [User Command](#user-command)
- [API](#api)
  - [`create()`](#create)
  - [`delete()`](#delete)
  - [`rename()`](#rename)
- [Contributing](#contributing)
- [Credits](#credits)
- [License](#license)

---

## Installation

> [!WARNING]
> **The order in which the plugins are loaded matters!**
>
> Avoid installing this plugin as a dependency for either `nvim-tree.lua`, `neo-tree` and/or `triptych`!
>
> For example, `neo-tree.nvim` must already be loaded before `nvim-lsp-file-operations` for this to work,
> so `nvim-lsp-file-operations` depends on `neo-tree.nvim`, not the other way around!

<details>
<summary><a href="https://github.com/lewis6991/pckr.nvim">pckr.nvim</a></summary>

```lua
require