Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/wincent/loupe

🔍 Enhanced in-file search for Vim
https://github.com/wincent/loupe

vim

Last synced: 10 days ago
JSON representation

🔍 Enhanced in-file search for Vim

Host: GitHub
URL: https://github.com/wincent/loupe
Owner: wincent
License: bsd-2-clause
Created: 2015-07-05T22:14:34.000Z (over 9 years ago)
Default Branch: main
Last Pushed: 2023-10-24T22:25:05.000Z (about 1 year ago)
Last Synced: 2024-10-12T06:09:55.670Z (25 days ago)
Topics: vim
Language: Vim Script
Homepage:
Size: 132 KB
Stars: 144
Watchers: 7
Forks: 6
Open Issues: 10
Metadata Files:
- Readme: README.md
- License: LICENSE.txt

Awesome Lists containing this project

README

# loupe

## Intro

> "loupe (noun)
a small magnifying glass used by jewelers and watchmakers."

loupe-features

Loupe enhances Vim's `search-commands` in four ways:

### 1. Makes the currently selected match easier to see

When searching using `/`, `?`, `star`, `#`, `n`, `N` or similar, it can be hard to see the "current" match from among all the matches that 'hlsearch' highlights. Loupe makes the currently selected match easier to see by:

- Applying a different `:highlight` group (by default, `hl-IncSearch`) to the match under the cursor.
- Keeping the matching line centered within the window when jumping between matches with `n` and `N`.

### 2. Applies sane pattern syntax by default

Loupe makes "very magic" (`/\v`) syntax apply by default when searching. This is true even if you initiate a search via a novel means, such as from a visual selection or with a complicated `:range` prefix.

This means that you can use a pattern syntax closer to the familiar regular expression syntax from languages such as Perl, Ruby, JavaScript (indeed, most other modern languages that support regular expressions).

### 3. Provides a shortcut to remove search highlighting

Loupe maps <leader>n to quickly remove all 'hlsearch' highlighting (although you can provide an alternative mapping of your choosing or suppress the feature entirely).

### 4. Sensible defaults for search-related features

Loupe provides reasonable defaults for most search-related Vim settings to provide a good "out of the box" experience. For more details, or to see how to override Loupe's settings, see [`loupe-overrides`](#user-content-loupe-overrides).

## Installation

To install Loupe, use your plug-in management system of choice.

If you don't have a "plug-in management system of choice", I recommend Pathogen (https://github.com/tpope/vim-pathogen) due to its simplicity and robustness. Assuming that you have Pathogen installed and configured, and that you want to install Loupe into `~/.vim/bundle`, you can do so with:

```
git clone https://github.com/wincent/loupe.git ~/.vim/bundle/loupe
```

Alternatively, if you use a Git submodule for each Vim plug-in, you could do the following after `cd`-ing into the top-level of your Git superproject:

```
git submodule add https://github.com/wincent/loupe.git ~/vim/bundle/loupe
git submodule init
```

To generate help tags under Pathogen, you can do so from inside Vim with:

```
:call pathogen#helptags()
```

## Mappings

### `(LoupeClearHighlight)`

Loupe maps <leader>n to [`(LoupeClearHighlight)`](#user-content-plugloupeclearhighlight), which clears all visible highlights (like `:nohighlight` does). To use an alternative mapping instead, create a different one in your `.vimrc` instead using `:nmap`:

```
" Instead of n, use x.
nmap x (LoupeClearHighlight)
```

Note that Loupe will not try to set up its <leader>n mapping if any of the following are true:

- A mapping for <leader>n already exists.
- An alternative mapping for [`(LoupeClearHighlight)`](#user-content-plugloupeclearhighlight) has already been set up from a `.vimrc`.
- The mapping has been suppressed by setting [`g:LoupeClearHighlightMap`](#user-content-gloupeclearhighlightmap) to 1 in your `.vimrc`.

### `(LoupeOctothorpe)`

Loupe maps `#` to [`(LoupeOctothorpe)`](#user-content-plugloupeoctothorpe) in order to implement custom highlighting and line-centering for the current match.