https://github.com/jhawthorn/fzy.js

A javascript port of fzy's scoring algorithm. As seen on GitHub.com!
https://github.com/jhawthorn/fzy.js

fuzzy fuzzy-search fuzzyfinder fzy

Last synced: 11 days ago
JSON representation

A javascript port of fzy's scoring algorithm. As seen on GitHub.com!

• Host: GitHub
• URL: https://github.com/jhawthorn/fzy.js
• Owner: jhawthorn
• License: mit
• Created: 2018-11-04T00:34:12.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2024-02-28T06:10:46.000Z (9 months ago)
• Last Synced: 2024-05-11T13:20:24.395Z (6 months ago)
• Topics: fuzzy, fuzzy-search, fuzzyfinder, fzy
• Language: JavaScript
• Homepage:
• Size: 799 KB
• Stars: 147
• Watchers: 3
• Forks: 11
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-tiny-js - fzy.js - Matches one string at a time, tree-shakeable scores and match highlighting. <img align="top" height="24" src="./img/fzyjs.svg"> total, or ~150 bytes for `hasMatch` only. (Text Search / Fuzzy search)

README

        
# fzy.js

A javascript port of [fzy](https://github.com/jhawthorn/fzy)'s fuzzy finder scoring algorithm

[Try it out online!](https://jhawthorn.github.io/fzy-demo/)

[![CI status](https://github.com/jhawthorn/fzy.js/workflows/CI/badge.svg)](https://github.com/jhawthorn/fzy.js/actions)

![Build Size](http://img.badgesize.io/jhawthorn/fzy.js/master/index.js.svg?compression=gzip)

![0 Dependencies](https://img.shields.io/badge/dependencies-0-44cc11.svg)

# Installation

```

npm i --save fzy.js

```

# Usage

`score(needle, haystack)`

``` javascript

var fzy = require('fzy.js')

fzy.score("amuser", "app/models/user.rb")     // 5.595

fzy.score("amuser", "app/models/customer.rb") // 3.655

```

`positions(needle, haystack)`

``` javascript

fzy.positions("amuser", "app/models/user.rb")     // [ 0, 4, 11, 12, 13, 14 ]

fzy.positions("amuser", "app/models/customer.rb") // [ 0, 4, 12, 13, 17, 18 ]

```

NB: `score` and `positions` must be called with matching needle and haystack,

doing otherwise is undefined. The caller needs to check that there is a match.

See the full example below for a way to do this check.

# Full Example

``` javascript

var { sortBy, escapeRegExp } = require("lodash");

var fzy = require("fzy.js");

// List of candidate strings

// Often generated by something like require("glob")("**/*")

var list = [

	"app/models/user.rb",

	"app/models/order.rb",

	"app/models/customer.rb"

];

// Usually this is input from the user

var query = "amuser";

// fzy.js includes `hasMatch` which can be used for filtering

list = list.filter((s) => fzy.hasMatch(s));

// Sort by fzy's scoring, descending (higher scores are better matches)

list = sortBy(list, (s) => -fzy.score(query, s));

// Select only the first 10 results

list.slice(0, 10);

// Print out our results with matched positions

list.forEach((s) => {

	var padded = "";

	var p = fzy.positions(query, s);

	for(var i = 0; i < query.length; i++) {

		padded = padded.padEnd(p[i], ' ') + query[i];

	}

	console.log(s);

	console.log(padded);

	console.log("");

});

// Output:

//

// app/models/user.rb

// a   m      user

//

// app/models/customer.rb

// a   m       us   er

```