https://github.com/ad-si/fuzzily

Fuzzy string search library in Haskell
https://github.com/ad-si/fuzzily

filter find fuzzy haskell search

Last synced: 2 months ago
JSON representation

Fuzzy string search library in Haskell

• Host: GitHub
• URL: https://github.com/ad-si/fuzzily
• Owner: ad-si
• License: isc
• Created: 2024-05-03T15:19:44.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-05-03T17:08:53.000Z (10 months ago)
• Last Synced: 2024-10-14T19:04:23.955Z (4 months ago)
• Topics: filter, find, fuzzy, haskell, search
• Language: Haskell
• Homepage: https://hackage.haskell.org/package/fuzzily
• Size: 18.6 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: license.txt

Awesome Lists containing this project

README

        
# Fuzzily

Fuzzy string search library in Haskell.

Uses `TextualMonoid` from

[monoid-subclasses](https://hackage.haskell.org/package/monoid-subclasses)

to be able to run on different types of strings.

This is a fork of Joomy Korkut's [fuzzy](https://github.com/joom/fuzzy),

which itselft was a port of the JavaScript library

[mattyork/fuzzy](https://github.com/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](https://tasklite.org/)'s

`find` sub-command.

## Usage

```haskell

> 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 = "aell"

        , score = 5

        })

> langs = [("Standard ML", 1990), ("OCaml", 1996), ("Scala", 2003)]

> filter IgnoreCase ("<", ">") fst "ML" langs

[ Fuzzy

    { original = ("Standard ML", 1990)

    , rendered = "Standard "

    , score = 4

    }

, Fuzzy

    { original = ("OCaml", 1996)

    , rendered = "OCa"

    , score = 4

    }

]

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

["vim", "virtual machine"]

> test "brd" "bread"

True

```