Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jcs-legacy/helm-fuzzy
Fuzzy matching for helm source.
https://github.com/jcs-legacy/helm-fuzzy
emacs helm helm-source
Last synced: about 1 month ago
JSON representation
Fuzzy matching for helm source.
- Host: GitHub
- URL: https://github.com/jcs-legacy/helm-fuzzy
- Owner: jcs-legacy
- License: gpl-3.0
- Created: 2019-08-25T16:49:53.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-05-08T06:48:30.000Z (4 months ago)
- Last Synced: 2024-05-15T13:18:01.766Z (4 months ago)
- Topics: emacs, helm, helm-source
- Language: Emacs Lisp
- Homepage:
- Size: 47.9 KB
- Stars: 3
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
**📢 Maintainer wanted This project is looking for maintainers, please open up an issue if you would love to chime in!**
---
[](https://www.gnu.org/licenses/gpl-3.0)
[](https://melpa.org/#/helm-fuzzy)
[](https://stable.melpa.org/#/helm-fuzzy)
# helm-fuzzy
> Fuzzy matching for helm source.
[](https://github.com/jcs-legacy/helm-fuzzy/actions/workflows/test.yml)
## 🏆 Featuers
- Work with all `helm` source.
- Decouple from `helm-source`.
- Uses [flx](https://github.com/lewang/flx).
## ❓ Differences from other alternatives
* [helm-flx](https://github.com/PythonNut/helm-flx)
* Doesn't work for sources that don't already support fuzzy matching
* [helm-fuzzier](https://github.com/EphramPerdition/helm-fuzzier)
* Only enhance matching for sources that have fuzzy-matching enabled
* [helm-fuz](https://github.com/cireu/fuz.el)
* Uses [fuz.el](https://github.com/cireu/fuz.el).
## 🔧 Usage
To enable this by putting these line of codes to your configuration.
```el
(require 'helm-fuzzy)
(with-eval-after-load 'helm
(helm-fuzzy-mode 1))
```
If you use `use-package`, you can put these line of codes instead.
```el
(use-package helm-fuzzy
:init
(with-eval-after-load 'helm
(helm-fuzzy-mode 1)))
```
### Inhibit fuzzy matching
You might don't want to fuzzy match some of the action. You can customize
`helm-fuzzy-not-allow-fuzzy` variable adding or removing the helm
buffer name.
```el
(setq helm-fuzzy-not-allow-fuzzy '("*helm-ag*"))
```
## 🛠️ Contribute
[](http://makeapullrequest.com)
[](https://github.com/bbatsov/emacs-lisp-style-guide)
[](https://www.paypal.me/jcs090218)
[](https://www.patreon.com/jcs090218)
If you would like to contribute to this project, you may either
clone and make pull requests to this repository. Or you can
clone the project and establish your own branch of this tool.
Any methods are welcome!
### 🔬 Development
To run the test locally, you will need the following tools:
- [Eask](https://emacs-eask.github.io/)
- [Make](https://www.gnu.org/software/make/) (optional)
Install all dependencies and development dependencies:
```sh
$ eask install-deps --dev
```
To test the package's installation:
```sh
$ eask package
$ eask install
```
To test compilation:
```sh
$ eask compile
```
**🪧 The following steps are optional, but we recommend you follow these lint results!**
The built-in `checkdoc` linter:
```sh
$ eask lint checkdoc
```
The standard `package` linter:
```sh
$ eask lint package
```
*📝 P.S. For more information, find the Eask manual at https://emacs-eask.github.io/.*
## ⚜️ License
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see .
See [`LICENSE`](./LICENSE.txt) for details.