inca/did-you-mean

Fuzzy match a command from a list (typo-safety)

Did You Mean ...

Fuzzy match a word from your list of commands or keywords in Node.js to provide a friendly typo-safe human prompt.

You can use it in:

• your CLI
• a web application
• URLs
• etc.

Installation

$ npm install did-you-mean

Usage

var Matcher = require('did-you-mean');

// Create a matcher with a list of values
var m = new Matcher('init install update upgrade');

// Get the closest match
m.get('udpate');   // 'update'

// Set the threshold (the maximum Levenshtein distance)
m.setThreshold(3);

// List all matches
m.list('udpate');    // [ { value: 'update', distance: 2 }, { value: 'upgrade', distance: 3 } ]

// Set ignore case
m.ignoreCase();

// Set match case
m.matchCase();

// Add more values
m.add('merge', 'checkout', 'commit');

did-you-mean's Issues

Further document list function

Does this code snippet return a list in the order of least-to-most distance?

// List all matches
m.list('udpate');    // [ { value: 'update', distance: 2 }, { value: 'upgrade', distance: 3 } ]

[Update] After looking through the source, this seems to be ordered. Think that could be documented in the readme?

Parameterize distance algorithm

Allow to set the distance algorithm as an option in the constructor. Example:

var levenshtein = require('fast-levenshtein');

// Receives two words and returns their distance
var myAlgorithm = function( word1, word2 ) {
    return levenshtein.get( word1, word2 );
};

// Passing the algorithm to use as an option
var m = new Matcher('init install update upgrade', { algorithm: myAlgorithm } );