https://github.com/jcs-elpa/flx-rs
flx in Rust using dynamic module
https://github.com/jcs-elpa/flx-rs
fuzzy
Last synced: 4 months ago
JSON representation
flx in Rust using dynamic module
- Host: GitHub
- URL: https://github.com/jcs-elpa/flx-rs
- Owner: jcs-elpa
- License: gpl-3.0
- Created: 2021-10-27T16:51:06.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2025-02-24T22:07:26.000Z (4 months ago)
- Last Synced: 2025-02-24T23:20:31.787Z (4 months ago)
- Topics: fuzzy
- Language: Emacs Lisp
- Homepage:
- Size: 8.63 MB
- Stars: 22
- Watchers: 3
- Forks: 8
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://www.gnu.org/licenses/gpl-3.0)
[](https://jcs-emacs.github.io/jcs-elpa/#/flx-rs)
# flx-rs
> flx in Rust using dynamic module
[](https://github.com/jcs-elpa/flx-rs/actions/workflows/test.yml)
[](https://github.com/jcs-elpa/flx-rs/actions/workflows/activate.yml)
[](https://github.com/jcs-elpa/flx-rs/actions/workflows/build_win.yml)
[](https://github.com/jcs-elpa/flx-rs/actions/workflows/build_macos.yml)
[](https://github.com/jcs-elpa/flx-rs/actions/workflows/build_linux.yml)
The `rust` implementation is under [the-flx/flx-rs](https://github.com/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,
```el
(flx-rs-load-dyn)
```
Calculate the score with `PATTERN` and `SOURCE`:
```el
(flx-rs-score "something" "some else thing")
```
## 💥 Replace `flx`
To completely replace `flx` with this package, add the following line to your
configuration.
```el
(advice-add 'flx-score :override #'flx-rs-score)
```
## 🛠️ 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!
You need `eask` in your `PATH` to run the [Makefile](/Makefile).
See [Eask install instructions](https://emacs-eask.github.io/Getting-Started/Install-Eask/)
, e.g.
```
$ npm install -g @emacs-eask/eask
```
### 🔬 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.