Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

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

A front-end for sift
https://github.com/nlamirault/sift.el

emacs sift

Last synced: 3 months ago
JSON representation

A front-end for sift

Host: GitHub
URL: https://github.com/nlamirault/sift.el
Owner: nlamirault
License: gpl-2.0
Created: 2015-11-12T13:56:09.000Z (almost 9 years ago)
Default Branch: master
Last Pushed: 2022-01-14T14:41:08.000Z (almost 3 years ago)
Last Synced: 2024-06-15T14:34:16.501Z (5 months ago)
Topics: emacs, sift
Language: Emacs Lisp
Size: 31.3 KB
Stars: 8
Watchers: 3
Forks: 4
Open Issues: 1
Metadata Files:
- Readme: README.md
- Changelog: ChangeLog.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

README

        # sift.el

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

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

Master :

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

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

Develop:

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

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

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

## Installation

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

    M-x package-install sift

or [Cask][]:

	(depends-on "sift")

## Usage

M-x sift-regexp or M-x projectile-sift

## Development

### Cask

``sift.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 

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

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

[LICENSE]: https://github.com/nlamirault/sift.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/sift.el/issues

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

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