https://github.com/yaegassy/coc-ruff
Ruff Language Server extension for coc.nvim
https://github.com/yaegassy/coc-ruff
coc coc-extensions coc-nvim coc-ruff neovim python python3 ruff ruff-lsp vim
Last synced: about 1 year ago
JSON representation
Ruff Language Server extension for coc.nvim
- Host: GitHub
- URL: https://github.com/yaegassy/coc-ruff
- Owner: yaegassy
- License: mit
- Created: 2023-01-16T08:10:44.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2025-02-11T02:42:26.000Z (over 1 year ago)
- Last Synced: 2025-04-02T20:24:25.588Z (about 1 year ago)
- Topics: coc, coc-extensions, coc-nvim, coc-ruff, neovim, python, python3, ruff, ruff-lsp, vim
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/@yaegassy/coc-ruff
- Size: 338 KB
- Stars: 63
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# coc-ruff
[Ruff](https://github.com/astral-sh/ruff) Language Server extension for [coc.nvim](https://github.com/neoclide/coc.nvim).
## Install
**CocInstall**:
```vim
:CocInstall @yaegassy/coc-ruff
```
> scoped packages
**e.g. vim-plug**:
```vim
Plug 'yaegassy/coc-ruff', {'do': 'yarn install --frozen-lockfile'}
```
## Configuration options
- `ruff.enable`: Enable coc-ruff extension, default: `true`
- `ruff.nativeServer`: Use the integrated Rust-based language server, available now in Beta, default: `true`
- `ruff.nativeBinaryPath`: Custom path for the `ruff` binary when using the native server. If no value is set, the `ruff` command will be detected from the runtime environment, default: `""`
- `ruff.disableDocumentFormatting`: Disable document formatting only, default: `false`
- `ruff.disableHover`: Disable hover only, default: `false`
- `ruff.useDetectRuffCommand`: Automatically detects the ruff command in the execution environment and sets `ruff.path`, default: `true`
- `ruff.client.codeAction.showDocumantaion.enable`: Whether to display the code action for open the Ruff rule documentation web page included in the diagnostic information, default: `false`
- `ruff.trace.server`: Traces the communication between coc.nvim and the ruff-lsp, default: `"off"`
Other settings have the same configuration as [ruff-vscode](https://github.com/astral-sh/ruff-vscode).
## Commands
- `ruff.executeAutofix`: Fix all auto-fixable problems
- `ruff.executeFormat`: Format document
- `ruff.executeOrganizeImports`: Format imports
- `ruff.debugInformation`: Print debug information (native server only)
- `ruff.showLogs`: Show logs
- `ruff.restart`: Restart Server
## Thanks
- [astral-sh/ruff](https://github.com/astral-sh/ruff)
- [astral-sh/ruff-vscode](https://github.com/astral-sh/ruff-vscode)
## License
MIT
---
> This extension is built with [create-coc-extension](https://github.com/fannheyward/create-coc-extension)