Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/nlamirault/ripgrep.el

Emacs front-end for ripgrep, a command line search tool
https://github.com/nlamirault/ripgrep.el

emacs ripgrep

Last synced: 3 months ago
JSON representation

Emacs front-end for ripgrep, a command line search tool

Host: GitHub
URL: https://github.com/nlamirault/ripgrep.el
Owner: nlamirault
License: gpl-2.0
Created: 2016-09-23T15:24:08.000Z (about 8 years ago)
Default Branch: master
Last Pushed: 2022-10-13T05:41:01.000Z (about 2 years ago)
Last Synced: 2024-04-26T01:33:55.988Z (6 months ago)
Topics: emacs, ripgrep
Language: Emacs Lisp
Size: 54.7 KB
Stars: 86
Watchers: 5
Forks: 19
Open Issues: 14
Metadata Files:
- Readme: README.md
- Changelog: ChangeLog.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

README

        # ripgrep.el

[![License GPL 2][badge-license]][LICENSE]

[![Coverage Status](https://coveralls.io/repos/nlamirault/ripgrep.el/badge.png?branch=master)](https://coveralls.io/r/nlamirault/ripgrep.el?branch=master)

Master :

* [![MELPA Stable](https://stable.melpa.org/packages/ripgrep-badge.svg)](https://stable.melpa.org/#/ripgrep)

* [![Circle CI](https://circleci.com/gh/nlamirault/ripgrep.el/tree/master.svg?style=svg)](https://circleci.com/gh/nlamirault/ripgrep.el/tree/master)

Develop:

* [![Melpa Status](https://melpa.org/packages/ripgrep-badge.svg)](https://melpa.org/#/ripgrep)

* [![Circle CI](https://circleci.com/gh/nlamirault/ripgrep.el/tree/develop.svg?style=svg)](https://circleci.com/gh/nlamirault/ripgrep.el/tree/develop)

``ripgrep.el`` allows you to search using [ripgrep][] from inside Emacs.

## Installation

The recommended way to install ``ripgrep`` is via [MELPA][]:

    M-x package-install ripgrep

or [Cask][]:

	(depends-on "ripgrep")

There is also [projectile-ripgrep](https://melpa.org/#/projectile-ripgrep) if you want to use it using [projectile](https://github.com/bbatsov/projectile)

## Usage

M-x ripgrep-regexp or M-x projectile-ripgrep

## Development

### Cask

``ripgrep.el`` use [Cask][] for dependencies management. Install it and

retrieve dependencies :

    $ curl -fsSkL https://raw.github.com/cask/cask/master/go | python

    $ export PATH="$HOME/.cask/bin:$PATH"

    $ cask

### Testing

* Launch unit tests from shell

    $ make clean test

* Using [overseer][] :

Keybinding           | Description

---------------------|------------------------------------------------------------

C-c , t   | launch unit tests from buffer

C-c , b   | launch unit tests

C-c , g   | launch unit tests with tag (find, regexp, ...)

* Tips:

If you want to launch a single unit test, add a specify tag :

```lisp

(ert-deftest test-foobar ()

  :tags '(current)

  ```

And launch it using : C-c , g and specify tag : *current*

## Support / Contribute

See [here](CONTRIBUTING.md)

## Changelog

A changelog is available [here](ChangeLog.md).

## License

See [LICENSE](LICENSE).

## Contact

Nicolas Lamirault 

[ripgrep.el]: https://github.com/nlamirault/ripgrep.el

[badge-license]: https://img.shields.io/badge/license-GPL_2-green.svg?style=flat

[LICENSE]: https://github.com/nlamirault/ripgrep.el/blob/master/LICENSE

[GNU Emacs]: https://www.gnu.org/software/emacs/

[MELPA]: https://melpa.org/

[Cask]: http://cask.github.io/

[Issue tracker]: https://github.com/nlamirault/ripgrep.el/issues

[overseer]: https://github.com/tonini/overseer.el

[ripgrep]: https://github.com/BurntSushi/ripgrep