Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/nlamirault/socyl

The emacs frontend for several search tools (ag, pt, sift, ripgrep, ...)
https://github.com/nlamirault/socyl

ag emacs pt ripgrep sift

Last synced: 3 months ago
JSON representation

The emacs frontend for several search tools (ag, pt, sift, ripgrep, ...)

Host: GitHub
URL: https://github.com/nlamirault/socyl
Owner: nlamirault
License: gpl-2.0
Created: 2016-09-26T11:19:26.000Z (about 8 years ago)
Default Branch: master
Last Pushed: 2022-01-14T14:38:37.000Z (almost 3 years ago)
Last Synced: 2024-04-26T01:32:44.459Z (6 months ago)
Topics: ag, emacs, pt, ripgrep, sift
Language: Emacs Lisp
Homepage:
Size: 51.8 KB
Stars: 16
Watchers: 3
Forks: 3
Open Issues: 1
Metadata Files:
- Readme: README.md
- Changelog: ChangeLog.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

README

        # Socyl

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

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

* Master : [![MELPA Stable](https://stable.melpa.org/packages/socyl-badge.svg)](https://stable.melpa.org/#/socyl) [![Circle CI](https://circleci.com/gh/nlamirault/socyl/tree/master.svg?style=svg)](https://circleci.com/gh/nlamirault/socyl/tree/master)

* Develop: [![Melpa Status](https://melpa.org/packages/socyl-badge.svg)](https://melpa.org/#/socyl) [![Circle CI](https://circleci.com/gh/nlamirault/socyl/tree/develop.svg?style=svg)](https://circleci.com/gh/nlamirault/socyl/tree/develop)

``socyl`` allows you to search using multiple search tools:

Supported backends are :

* [ag][]

* [pt][]

* [sift][]

* [ripgrep][]

## Installation

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

    M-x package-install socyl

or [Cask][]:

	(depends-on "socyl")

## Usage

Choose your backend :

(setq socyl-backend 'pt)

M-x socyl-search-regexp

to test backends in a IELM session :

```lisp

ELISP> (let ((socyl-backend 'pt))

         (socyl-search-regexp "Emacs" "/tmp/"))

```

## Development

### Cask

``socyl`` 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 (backend, ...)

* 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 

[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

[ag]: https://github.com/ggreer/the_silver_searcher

[pt]: https://github.com/monochromegane/the_platinum_searcher

[sift]: https://sift-tool.org/

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