tiaanduplessis / fuzzy-finder

🔎 Tiny fuzzy searcher (356 Bytes gzipped)

fuzzy-finder

Tiny fuzzy searcher (Under 300 bytes gzipped)

Table of Contents

• fuzzy-finder
  • Table of Contents
  • Install
  • Usage
  • Contributing
  • License

Install

$ npm install fuzzy-finder
# OR
$ yarn add fuzzy-finder

Or with CDN:

<script src="https://unpkg.com/[email protected]/dist/fuzzy-finder.umd.js"></script>

Usage

import fuzzyFinder from 'fuzzy-finder'

console.log(fuzzy('da', [
    'dota.js',
    'stratures.js',
    'structures.js',
    'database.db',
    'user-data.js',
    'dummy-data.txt',
    'other.js'
]))
// [ { match: 'dota.js', rank: 0 },
//   { match: 'database.db', rank: 0 },
//   { match: 'user-data.js', rank: 5 },
//   { match: 'dummy-data.txt', rank: 0 } ]

Check out the example here.

Contributing

Contributions are welcome!

1. Fork it.
2. Create your feature branch: git checkout -b my-new-feature
3. Commit your changes: git commit -am 'Add some feature'
4. Push to the branch: git push origin my-new-feature
5. Submit a pull request :D

Or open up a issue.

License

Licensed under the MIT License.

fuzzy-finder's Issues

Characters that need escaping break regex

Hello,

If a search string contains special characters, the split breaks the escaping.
I had to change it to this:

escaped.split(/(\.|)/).filter( x=>x.length ).join('(.*)')