mirror of
https://github.com/litruv/unhomoglyph.git
synced 2026-07-24 02:36:12 +10:00
56 lines
1.5 KiB
Markdown
56 lines
1.5 KiB
Markdown
# unhomoglyph
|
||
|
||
[](https://travis-ci.org/nodeca/unhomoglyph)
|
||
[](https://www.npmjs.org/package/unhomoglyph)
|
||
|
||
> Replace all homoglyphs with base characters. Useful to detect similar strings.
|
||
For example, to prohibit register similar looking nicknames at websites.
|
||
|
||
Data source - [Recommended confusable mapping for IDN](http://www.unicode.org/Public/security/latest/confusables.txt), v13.0.0.
|
||
Similar letters array in addOther.js provided by [litruv](https://github.com/litruv) and [KillAllTheHippies](https://github.com/killallthehippies).
|
||
|
||
__Note!__ Text after transform is NOT intended be read by humans. For example,
|
||
`m` will be transformed to `r` + `n`. Goal is to compare 2 strings after
|
||
transform, to check if sources looks similar or not. If sources look similar,
|
||
then transformed strings are equal.
|
||
|
||
|
||
## Install
|
||
|
||
```bash
|
||
npm i git+https://github.com/TateB/unhomoglyph.git
|
||
```
|
||
|
||
|
||
## Example
|
||
|
||
```js
|
||
const unhomoglyph = require('unhomoglyph');
|
||
|
||
console.log(unhomoglyph('AΑАᎪᗅᴀꓮ')); // => AAAAAAA
|
||
console.log(unhomoglyph('m')); // => rn (r + n)
|
||
|
||
//
|
||
// Compare nicknames
|
||
//
|
||
|
||
const username1 = 'm';
|
||
const username2 = 'rn';
|
||
|
||
if (unhomoglyph(username1) === unhomoglyph(username2)) {
|
||
console.log(`"${username1}" and "${username2} look similar`);
|
||
}
|
||
```
|
||
|
||
|
||
## Update
|
||
|
||
```bash
|
||
npm run update
|
||
```
|
||
|
||
|
||
## License
|
||
|
||
[MIT](https://github.com/nodeca/unhomoglyph/blob/master/LICENSE)
|