Update README.md

Ship the TypeScript declarations too

.travis.yml

@@ -1,5 +1,3 @@
 language: node_js
 node_js:
-  - '4'
-  - '6'
-sudo: false
+  - node

CHANGELOG.md

@@ -1,3 +1,38 @@
+1.0.6 / 2020-05-18
+------------------
+
+- Update mapping data to version 13.0.0
+  http://www.unicode.org/Public/security/latest/confusables.txt
+- Encode `\u2028` & `\u2029` as text, #7.
+- Dev deps bump.
+
+
+1.0.5 / 2020-03-03
+------------------
+
+- Include missed TS definition into npm package.
+
+
+1.0.4 / 2020-02-05
+------------------
+
+- Added TS definition.
+
+
+1.0.3 / 2019-11-04
+------------------
+
+- Update mapping data to version 12.1.0
+  http://www.unicode.org/Public/security/latest/confusables.txt
+- Dev deps bump.
+
+1.0.2 / 2017-03-05
+------------------
+
+- Update mapping data to version 9.0.0
+  http://www.unicode.org/Public/security/latest/confusables.txt
+
+
 1.0.1 / 2016-12-09
 ------------------
 

README.md

@@ -4,14 +4,21 @@
 [![NPM version](https://img.shields.io/npm/v/unhomoglyph.svg?style=flat)](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), v8.0.0.
+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 install unhomoglyph --save
+npm i git+https://github.com/TateB/unhomoglyph.git
 ```
 
 
@@ -21,6 +28,18 @@ npm install unhomoglyph --save
 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`);
+}
 ```
 
 

addOther.js

@@ -0,0 +1,44 @@
+const fs      = require('fs')
+const path    = require('path')
+const savePath = path.join(__dirname, 'data.json')
+var data = require('./data.json')
+
+const similarLetters = [
+    { eng: "a", alts: "₳АаДдӔӕА̊а̊А̄а̄ӒӓӐӑꙘꙙѦѧӘәa͏ａＡａα𝓐𝓪𝐀🇦𝐚" },
+    { eng: "b", alts: "฿БбВвЫыЪъЬь6Ҍҍb͏Ｂｂ𝓑𝓫𝐁𝐛🇧" },
+    { eng: "c", alts: "🇨₵Сс(ҪҫС́с́c͏Ｃｃ¢𝓒𝓬𝐂𝐜" },
+    { eng: "d", alts: "ĐԂԃ🇩Ԁԁd͏Ｄｄ∂𝓓𝓭𝐃𝐝" },
+    { eng: "e", alts: "ɆЕеЁёЗ🇪зЭэЄ̈є̈Е̃е̃Е̄е̄Ё̄ё̄ӖӗЀѐԐԑЄєӠӡe͏Ｅｅ𝓔𝓮𝐄𝐞" },
+    { eng: "f", alts: "₣Ғғf͏Ｆｆ𝓕🇫𝓯𝐅𝐟" },
+    { eng: "g", alts: "₲Ԍԍg͏Ｇｇ𝓖𝓰𝐆🇬𝐠" },
+    { eng: "h", alts: "НⱧнӉӊҢңԨԩӇӈҺһԊԋ🇭h͏Ｈｈ𝓗𝓱𝐇𝐡" },
+    { eng: "i", alts: "l1ł|ӀӏЇїІіi͏Ｉｉι𝓘𝓲🇮𝐈𝐢" },
+    { eng: "j", alts: "Јјj͏JＪｊנ𝓙𝓳𝐉𝐣🇯" },
+    { eng: "k", alts: "КкҚқ₭ҜҝҞҟҠҡk͏Ｋｋ𝓚𝓴𝐊🇰𝐤" },
+    { eng: "l", alts: "l͏ＬｌⱠℓ𝓛𝓵𝐋𝐥🇱" },
+    { eng: "m", alts: "МмӍӎm͏₥Ｍｍ𝓜𝓶𝐌𝐦🇲" },
+    { eng: "n", alts: "ИиЙйЛлП₦пԤԥn͏Ｎｎ𝓝𝓷𝐍𝐧🇳" },
+    { eng: "o", alts: "ОоЮюФф0ӪØӫӦӧО̄о̄ꙔꙕѲѳѺѻꙪꙫꙨꙩꚚꚛӨө🇴o͏Ｏｏσ𝓞𝓸𝐎𝐨" },
+    { eng: "p", alts: "РрР̌р̌Ҏҏp͏Ｐ₱ｐρ𝓟𝓹𝐏🇵" },
+    { eng: "q", alts: "g9q͏Ｑｑ𝓠𝓺𝐐Q𝐪🇶" },
+    { eng: "r", alts: "ГгЯяԘԙԆԇԄԅr͏Ｒｒ𝓡𝓻𝐑𝐫Ɽ🇷" },
+    { eng: "s", alts: "5ꙄꙅЅѕs͏Ｓｓ𝓢𝓼𝐒𝐬🇸₴" },
+    { eng: "t", alts: "ТтҬҭt͏Ｔｔ𝓣𝓽𝐓𝐭₮🇹" },
+    { eng: "u", alts: "vЦцꙠꙡu͏Ｕｕυ𝓤𝓾𝐔𝐮🇺Ʉ"},
+    { eng: "v", alts: "ѶѷѴѵv͏Ｖｖν𝓥𝓿𝐕𝐯🇻​"},
+    { eng: "w", alts: "ШшЩщꚆꚇѠѡԜԝw͏Ｗｗω𝓦𝔀𝐖𝐰🇼​₩" },
+    { eng: "x", alts: "ХхҲҳӾӿӼӽx͏Ｘｘχ𝓧𝔁𝐗🇽𝐱" },
+    { eng: "y", alts: "УуҮүЧчЦцӮӯӰӱЎўӲӳꚎꚏy͏🇾Ｙｙ𝓨𝔂𝐘𝐲Ɏ" },
+    { eng: "z", alts: "2ЗзЖжЗ́ж́z͏Ｚｚ𝓩𝔃𝐙𝐳Ⱬ🇿" }
+]
+
+similarLetters.forEach((letter) => {
+    const alts = letter.alts.normalize('NFD').replace(/\p{Diacritic}/gu, "").replace(/[\u200B-\u200D\uFEFF\u034F]/g, '');
+    [...alts].forEach((alt) => {
+        data[alt.toLowerCase()] = letter.eng
+    })
+})
+
+fs.writeFileSync(savePath, JSON.stringify(data, null, 2))
+
+console.log("Added alternatives")

index.d.ts

@@ -0,0 +1,4 @@
+declare module 'unhomoglyph' {
+    const unhomoglyph: (s: string) => string;
+    export default unhomoglyph;
+}

index.js

@@ -14,7 +14,7 @@ function replace_fn(match) {
 }
 
 function unhomoglyph(str) {
-  return str.replace(REPLACE_RE, replace_fn);
+  return str.toLowerCase().normalize('NFD').replace(/\p{Diacritic}/gu, "").replace(/[\u200B-\u200D\uFEFF\u034F]/g, '').replace(REPLACE_RE, replace_fn).toLowerCase();
 }
 
 module.exports = unhomoglyph;

package.json

@@ -1,6 +1,6 @@
 {
   "name": "unhomoglyph",
-  "version": "1.0.1",
+  "version": "1.0.6",
   "description": "Replace all homoglyphs with base characters.",
   "keywords": [
     "homoglyph",
@@ -10,7 +10,8 @@
   "license": "MIT",
   "files": [
     "index.js",
-    "data.json"
+    "data.json",
+    "index.d.ts"
   ],
   "scripts": {
     "lint": "eslint .",
@@ -18,7 +19,7 @@
     "update": "node update.js && npm test"
   },
   "devDependencies": {
-    "eslint": "^3.11.1",
-    "mocha": "^3.2.0"
+    "eslint": "^7.0.0",
+    "mocha": "^7.1.2"
   }
 }

test.js

@@ -26,4 +26,8 @@ describe('unhomoglyph', function () {
     assert.strictEqual(unhomoglyph('1abcаа'), 'labcaa');
   });
 
+  it('2028 & 2029 should be ok after replace in updater', function () {
+    assert.strictEqual(data['\u2028'], ' ');
+    assert.strictEqual(data['\u2029'], ' ');
+  });
 });

update.js

@@ -37,8 +37,14 @@ function save(str) {
       result[src] = dst;
     });
 
+  let output = JSON.stringify(result, null, '  ')
+    // Workaround for ES9 <=> ES10 inconsistency
+    // https://github.com/nodeca/unhomoglyph/issues/7
+    // https://github.com/facebook/hermes/issues/235#issuecomment-623606572
+    .replace(/\u2028/g, '\\u2028')
+    .replace(/\u2029/g, '\\u2029');
 
-  fs.writeFileSync(SAVE_PATH, JSON.stringify(result, null, '  '));
+  fs.writeFileSync(SAVE_PATH, output);
   console.log('Done!');
 }