jcs-elpa / flx-rs

flx in Rust using dynamic module
GNU General Public License v3.0
22 stars 8 forks source link
fuzzy

License: GPL v3 JCS-ELPA

flx-rs

flx in Rust using dynamic module

CI Activate

Build Windows Build macOS Build Linux

The rust implementation is under the-flx/flx-rs ; hence this repo will only contain releases to ELPA and ready-to-use binary files.

πŸ”¨ Usage

Load by calling the following function,

(flx-rs-load-dyn)

Calculate the score with PATTERN and SOURCE:

(flx-rs-score "something" "some else thing")

πŸ’₯ Replace flx

To completely replace flx with this package, add the following line to your configuration.

(advice-add 'flx-score :override #'flx-rs-score)

πŸ› οΈ 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!

You need eask in your PATH to run the Makefile. See Eask install instructions , e.g.

$ npm install -g @emacs-eask/eask

πŸ”¬ 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.