https://github.com/kyoh86/vim-ripgrep

A plugin for Vim8/Neovim to search text by ripgrep (rg) asynchronously
https://github.com/kyoh86/vim-ripgrep

neovim neovim-plugin nvim nvim-plugin ripgrep vim vim-plugin

Last synced: 2 months ago
JSON representation

A plugin for Vim8/Neovim to search text by ripgrep (rg) asynchronously

• Host: GitHub
• URL: https://github.com/kyoh86/vim-ripgrep
• Owner: kyoh86
• License: mit
• Created: 2022-02-22T14:34:41.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-03-26T00:12:54.000Z (10 months ago)
• Last Synced: 2024-03-26T01:29:22.175Z (10 months ago)
• Topics: neovim, neovim-plugin, nvim, nvim-plugin, ripgrep, vim, vim-plugin
• Language: Vim Script
• Homepage:
• Size: 97.7 KB
• Stars: 28
• Watchers: 2
• Forks: 3
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ripgrep.vim

[![Test](https://github.com/kyoh86/vim-ripgrep/actions/workflows/test.yml/badge.svg)](https://github.com/kyoh86/vim-ripgrep/actions/workflows/test.yml)

A plugin for Vim8/Neovim to search text by `ripgrep` (`rg`).

**THIS IS EXPERIMENTAL PLUGIN AND UNDER DEVELOPMENT.**

**DESTRUCTIVE CHANGES MAY OCCUR.**

## What's different from [`jremmen/vim-ripgrep`](https://github.com/jremmen/vim-ripgrep)?

- Calling `ripgrep` asynchronously.

    - Even if it finds a lot of matches, editor won't freeze.

    - Exception in case of `Neovim` on `Windows`.

- There's no default command.

    - You can create a command with name what you like.

- Observability.

    - You can add observer for each event in searching process.

# USAGE

For more details: `:help ripgrep.txt`

## FUNCTION

```vim

:call ripgrep#search('-w --ignore-case foo')

```

## CONFIG

You can create a command to call the function with a name you like.

For example:

```vim

Plug "kyoh86/vim-ripgrep",

command! -nargs=+ -complete=file Ripgrep :call ripgrep#search()

```

# LICENSE

[![MIT License](http://img.shields.io/badge/license-MIT-blue.svg)](http://www.opensource.org/licenses/MIT)

This software is released under the [MIT License](http://www.opensource.org/licenses/MIT), see LICENSE.

- `autoload/ripgrep/job.vim` is from [`async.vim`](https://github.com/prabirshrestha/async.vim) and some patch.