Skip to content

Latest commit

 

History

History
125 lines (88 loc) · 3.79 KB

README.md

File metadata and controls

125 lines (88 loc) · 3.79 KB
Raw

📢 Maintainer wanted This project is looking for maintainers, please open up an issue if you would love to chime in!

License: GPL v3 MELPA MELPA Stable

helm-fuzzy

Fuzzy matching for helm source.

CI

🏆 Featuers

  • Work with all helm source.
  • Decouple from helm-source.
  • Uses flx.

❓ Differences from other alternatives

  • helm-flx
    • Doesn't work for sources that don't already support fuzzy matching
  • helm-fuzzier
    • Only enhance matching for sources that have fuzzy-matching enabled
  • helm-fuz

🔧 Usage

To enable this by putting these line of codes to your configuration.

(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.

(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.

(setq helm-fuzzy-not-allow-fuzzy '("*helm-ag*"))

🛠️ Contribute

PRs Welcome Elisp styleguide Donate on paypal Become a patron

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:

Install all dependencies and development dependencies:

$ eask install-deps --dev

To test the package's installation:

$ eask package
$ eask install

To test compilation:

$ eask compile

🪧 The following steps are optional, but we recommend you follow these lint results!

The built-in checkdoc linter:

$ eask lint checkdoc

The standard package linter:

$ 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 https://www.gnu.org/licenses/.

See LICENSE for details.