color-rg

KO | EN

gitlite — search

#javascript #python #react #llm #android #rust #deep-learning #macos #java #kubernetes #awesome-list #pytorch #ios #openai

(★ 183)

Search and refactoring tool based on ripgrep.

File Explorer

Download Latest Version (.zip)

- color-rg.png
.gitignore
color-rg.el
README.md

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# What is color-rg?

color-rg is a search and refactoring tool based on ripgrep.

I'm a big fan of color-moccur.el, this extension's name is a tribute to
color-moccur.el!

## Installation

Clone or download this repository (path of the folder is the
`<path-to-color-rg>` used below).

In your `~/.emacs`, add the following two lines:

```Elisp
(add-to-list 'load-path "<path-to-color-rg>") ; add color-rg to your load-path
(require 'color-rg)
```

If you use Mac, you also need to install
[exec-path-from-shell](https://github.com/purcell/exec-path-from-shell)

## Usage

Bind your favorite key to functions:

### Keymap for view mode

| Key      | Description                                                                            |
| :------: | :----------------------------------------------------------------------                |
| C-a      | Jump to first editable position of current line                                        |
| Tab      | Jump to next match keyword                                                             |
| Back Tab | Jump to previous match keyword                                                         |
| j        | Jump to next match keyword                                                             |
| k        | Jump to previous match keyword                                                         |
| h        | Jump to next match file                                                                |
| l        | Jump to previous match file                                                            |
| i        | Insert current line                                                                    |
| SPC      | Open file                                                                              |
| RET      | Open file relative to match line                                                       |
| Ctrl + m | Open file relative to match line                                                       |
| r        | Replace all matches (after insert replace string, press y, n or ! for replace action ) |
| e        | Enable edit mode                                                                       |
| f        | Filter results match regexp                                                            |
| F        | Filter results not match regexp                                                        |
| x        | Filter results match file extension                                                    |
| X        | Filter results not match file extension                                                |
| u        | Don't filter file extension                                                            |
| D        | Delete current line from results                                                       |
| I        | Toggle to `include`/`exclude` the ignore files then rerun last search                  |
| N        | Toggle to respect `color-rg-search-ignore-rules` then rerun last search                |
| C        | Toggle to `smart case`/`case sensitive` then rerun last search                         |
| z        | Search second keyword with file list filter by first keywrod                           |
| L        | Re-search pattern as literal                                                           |
| W        | Re-search pattern as whole word                                                           |
| R        | Re-search pattern as regexp                                                            |
| G        | Rerun last search only include specified file type                                     |
| E        | Rerun last search exclude specified file type                                          |
| o        | Rerun last search in (up one level) parent directory                                   |
| O        | Rerun last search in project root directory                                            |
| s        | Rerun rg with customized directory.                                                    |
| S        | Rerun rg with customized arguments.                                                    |
| q        | Quit                                                                                   |

### Keymap for edit mode

### Work with isearch

Add this into your emacs config file:

```
(define-key isearch-mode-map (kbd "M-s M-s") 'isearch-toggle-color-rg)
```

When using `isearch-forward`, type <kbd>M-s M-s</kbd> to search current
isearch string with color-rg.

### Research with new files

`color-rg-rerun-change-files` can limit search files with GLOB. This function
used rg arguments '--type', '--add-type'.

Default search files is "everything" which means use rg without '--type'
argument.

If search files is "all", search rg like "rg --type all".

Other complete candidates are mostly read from "rg --type-list" command, which
is predefined in rg.

Of course you can specify your own GLOB, just insert them as you like. For
example, if you input a GLOB like `*mypersonalglob*`, which match none of the
candidates, then, color-rg will call shell command like:

```
rg --add-type 'custom:*mypersonalglob*' --type custom ...
```

### Research with customized arguments

If none of the preset meet your requirements, `color-rg-customized-search` can
release the full power of `rg`.

When `color-rg-customized-search` is called, the full command of rg will show
up, and you can add any argument to rg as in shell.

you must escape special characters when using `color-rg-customized-search`, for
example:

```
rg --type-add custom\:\*.el
# or
rg --type-add 'custom:*.el'
# or
rg --type-add "custom:*.el"
```

Note: `color-rg-customized-search` is design for re-run customized arguments after you have run `color-rg-search-input`, please don't use this command directly.

### Works with Windows
Some user need add `powershell` before start command `rg`, you need custom option `color-rg-command-prefix`, such as `powershell`.

### Multi-line search
color-rg support rg option `-U` default, you can pass regex string `find-file.*\n(goto-char` to match code block that first line is start with `find-file` and second line start with `goto-char`

### Show match-line context
When you set `color-rg-show-lines-before-match` or `color-rg-show-lines-after-match`, color-rg will pass number to option `-B` or `-A`, to show context around match line.

## Contributor

color-rg

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

color-rg

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

Download README