abbrev

What is abbrev?

The abbrev npm package is used to create a list of unique abbreviations for a given set of strings. It is particularly useful when you need to generate a minimal set of distinct abbreviations for a list of words, ensuring that each word's abbreviation is unambiguous.

What are abbrev's main functionalities?

Generating abbreviations

This feature allows you to generate an object where the keys are all possible unique abbreviations and the values are the full strings that they map to. In the code sample, abbreviations for 'apple', 'ape', and 'april' are generated, resulting in an object with keys like 'a', 'ap', 'app', etc., each pointing to their respective full words.

const abbrev = require('abbrev');
const abbreviations = abbrev('apple', 'ape', 'april');
console.log(abbreviations);

Other packages similar to abbrev

fuzzyset.js

Fuzzyset.js is a package that provides fuzzy string matching. It can be used to find strings that approximate other strings but does not generate abbreviations. It is more complex and suitable for cases where you want to match user input against a list of strings and find the closest match.

string-similarity

This package is used to find how similar two strings are or to find the best match in an array of strings. Unlike abbrev, it does not create abbreviations but rather compares strings for similarity, which can be useful in search algorithms and typo correction.

README

abbrev-js

Just like ruby's Abbrev.

Usage:

var abbrev = require("abbrev");
abbrev("foo", "fool", "folding", "flop");

// returns:
{ fl: 'flop'
, flo: 'flop'
, flop: 'flop'
, fol: 'folding'
, fold: 'folding'
, foldi: 'folding'
, foldin: 'folding'
, folding: 'folding'
, foo: 'foo'
, fool: 'fool'
}

This is handy for command-line scripts, or other cases where you want to be able to accept shorthands.

Changelog

3.0.0 (2024-09-24)

⚠️ BREAKING CHANGES

• abbrev now supports node ^18.17.0 || >=20.5.0

Bug Fixes

• e2c25c1 #92 align to npm 10 node engine range (@hashtagchris)

Chores

• 9d4e497 #97 enable auto publish (#97) (@reggi)
• b4c7e46 #93 bump @npmcli/eslint-config from 4.0.5 to 5.0.0 (@dependabot[bot])
• faa9bf1 #92 run template-oss-apply (@hashtagchris)
• ff93548 #80 bump @npmcli/template-oss to 4.22.0 (@lukekarrys)
• 2369d5d #95 postinstall for dependabot template-oss PR (@hashtagchris)
• 090138a #95 bump @npmcli/template-oss from 4.22.0 to 4.23.3 (@dependabot[bot])