fuzzily: Filters a list based on a fuzzy string search

[ filter, find, fuzzy, library, search, text ] [ Propose Tags ]

Fuzzily is a library that filters a list based on a fuzzy string search. Uses TextualMonoid to be able to run on different types of strings.


[Skip to Readme]

Modules

[Index] [Quick Jump]

Downloads

Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees

Candidates

  • No Candidates
Versions [RSS] 0.1.0.0, 0.2.0.0
Dependencies base (>=4.18.2 && <5), monoid-subclasses (>=1.2.5 && <1.3), protolude (>=0.3.4 && <0.4) [details]
License ISC
Copyright Adrian Sieber
Author Adrian Sieber
Maintainer mail@adriansieber.com
Category Text, Fuzzy, Search, Find, Filter
Home page https://github.com/ad-si/Fuzzily
Bug tracker https://github.com/ad-si/Fuzzily/issues
Source repo head: git clone https://github.com/ad-si/Fuzzily
Uploaded by adrian at 2024-05-03T17:10:02Z
Distributions NixOS:0.2.0.0
Reverse Dependencies 1 direct, 0 indirect [details]
Downloads 48 total (5 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs uploaded by user
Build status unknown [no reports yet]

Readme for fuzzily-0.2.0.0

[back to package description]

Fuzzily

Fuzzy string search library in Haskell. Uses TextualMonoid from monoid-subclasses to be able to run on different types of strings.

This is a fork of Joomy Korkut's fuzzy, which itselft was a port of the JavaScript library mattyork/fuzzy.

It's main difference is more readable code and a cleaner API:

  • Descriptive variable names
  • ADTs instead of booleans

It was initially forked to be used in TaskLite's `find` sub-command.

Usage

> import Text.Fuzzily

> match HandleCase ("", "") id "fnt" "infinite"
Just (Fuzzy
        { original = "infinite"
        , rendered = "infinite"
        , score = 3
        })

> match IgnoreCase ("<", ">") fst "hsk" ("Haskell", 1995)
Just (Fuzzy
        { original = ("Haskell", 1995)
        , rendered = "<H>a<s><k>ell"
        , score = 5
        })

> langs = [("Standard ML", 1990), ("OCaml", 1996), ("Scala", 2003)]
> filter IgnoreCase ("<", ">") fst "ML" langs
[ Fuzzy
    { original = ("Standard ML", 1990)
    , rendered = "Standard <M><L>"
    , score = 4
    }
, Fuzzy
    { original = ("OCaml", 1996)
    , rendered = "OCa<m><l>"
    , score = 4
    }
]

> simpleFilter "vm" ["vim", "emacs", "virtual machine"]
["vim", "virtual machine"]

> test "brd" "bread"
True