https://github.com/pocesar/js-diacritic-regex

Creates the inverse of transliterated string to a regex. What? Basically, diacritic insensitiveness
https://github.com/pocesar/js-diacritic-regex

accent accents database diacritics insensitive insensitiveness regex regex-match regexp regexp-search transliterate transliteration

Last synced: 17 days ago
JSON representation

Creates the inverse of transliterated string to a regex. What? Basically, diacritic insensitiveness

• Host: GitHub
• URL: https://github.com/pocesar/js-diacritic-regex
• Owner: pocesar
• License: mit
• Created: 2016-02-05T23:59:15.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2024-07-11T17:18:02.000Z (4 months ago)
• Last Synced: 2024-10-19T15:03:40.264Z (26 days ago)
• Topics: accent, accents, database, diacritics, insensitive, insensitiveness, regex, regex-match, regexp, regexp-search, transliterate, transliteration
• Language: TypeScript
• Homepage:
• Size: 93.8 KB
• Stars: 27
• Watchers: 4
• Forks: 9
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Build Status](https://travis-ci.org/pocesar/js-diacritic-regex.svg?branch=master)](https://travis-ci.org/pocesar/js-diacritic-regex)

[![Coverage Status](https://coveralls.io/repos/github/pocesar/js-diacritic-regex/badge.svg?branch=master)](https://coveralls.io/github/pocesar/js-diacritic-regex?branch=master)

[![NPM](https://nodei.co/npm/diacritic-regex.png)](https://nodei.co/npm/diacritic-regex/)

# Diacritic regex

Creates the inverse of transliterated string to a regex. What? Basically, a regex that is diacritic insensitive

## Why?

Sometimes the user will search for **blasé**, but your database is dumb and doesn't understand collations and diacritic insensitiveness, but it can compare stuff using regex, so there ya go.

## How?

Suppose you have the word **résumé** but written improperly in the database as **resume**. The user is clever, and types it correctly into the search box. Gets nothing. How to search for all the weird cases people mistype stuff when comes to accents?

```es6

import { toRegex, toString } from 'diacritic-regex';

toRegex()('résumé') // => /r[eEÉéÈèÊêëË]s[úùÚÙüÜuU]m[eEÉéÈèÊêëË]/i;

toRegex({flags: 'mu'})('résumé') // => /r[eEÉéÈèÊêëË]s[úùÚÙüÜuU]m[eEÉéÈèÊêëË]/mu;

toRegex({

  flags: '',

  mappings: {

    'e': 'eéÉ'

  }

})('résumé') // => /r[eéÉ]s[úùÚÙüÜuU]m[eéÉ]/;

toString({

    mappings: {

        '*': ['\\S+'] // literals, won't try to wrap in []'s,

        'u': ['u']

    }

})('résumé*') // => 'r[eEÉéÈèÊêëË]sum[eEÉéÈèÊêëË]\S+'

```

If you want to change the mappings for all instances:

```ts

import { mappings } from 'diacritic-regex'

mappings['*'] = ['[\\S\\s]+']

```

## Caveats

Be aware of [RegExp.prototype.exec](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp/exec) with `g` flag being stateful

The `i` flag is appended to the RegExp flags if you don't pass any flags to `toRegex`

## Compatibility

Work in node and the browser, but needs polyfills for `Array.reduce`, `Array.map` and `Object.keys` depending on how old your target browser is

## License

MIT