JavaScriptで絵文字とサロゲートペアと結合文字とgrapheme clusterを正しく扱うのに少し苦労した話

皆さんはUnicodeや絵文字についてどのくらい理解していますか？ 
私は全く理解できていません。

JavaScriptで絵文字を扱おうとしたら苦労した話を書きます。誰かの参考になれば幸いです。

## 経緯

MuscularというジョークコマンドをNode.jsで開発していました。

 <a href="https://github.com/amanoese/muscular"><img src="https://github-link-card.s3.ap-northeast-1.amazonaws.com/amanoese/muscular.png" width="460px"></a> 


これは、ボディビルダーとともにテキストを叫んだ感じで表示するという単純なアプリケーションでした。
「[cowsay](https://github.com/tnalpgge/rank-amateur-cowsay)」と「[echo-sd](https://fumiyas.github.io/2013/12/25/echo-sd.sh-advent-calendar.html)」と「筋肉」をあわせたようなコマンドです。

```txt
$ muscular shout ナイスバルク
        .-~-.          
        /   \          
        |   /          
     ,_-/ ,.*`--.,     
   .r ;       ``  \    
  .`,`   ,:  ,.`A`,\   
 /,`/\`''  ''  ? \` \  
/  /  \ ; , ; /   )  } ＿人人＿
| /    \:':': |   | 7  ＞ ナ ＜
| |    ) ':'  |  ,` /  ＞ イ ＜
( \    `-,_,-~}  | l   ＞ ス ＜
 `~   / `,  /' \ '"'   ＞ バ ＜
     ,7   \/   |.      ＞ ル ＜
     {  ; |, ,  )      ＞ ク ＜
     |,`: |`,`: |      ￣Y^Y^￣
     \` , /\`.; /      
      |`;/  \ , |      
      \``\   |` (      
      \ . )  {  /      
       \ `/  (  }      
        \ |  | /       
        ) \  | |       
     c~^_~d  V _`,     
```

## 絵文字が崩れれる問題

このコマンドでテキストを**縦書きで表示**しているのですが、
ここに絵文字が入ると崩れる問題が生じました。[(issues #5)](https://github.com/amanoese/muscular/issues/5)

```txt
$ muscular shout "$(echo -e "😫")"
        .-~-.
        /   \
        |   /
     ,_-/ ,.*`--.,
   .r ;       ``  \
  .`,`   ,:  ,.`A`,\
 /,`/\`''  ''  ? \` \
/  /  \ ; , ; /   )  }
| /    \:':': |   | 7
| |    ) ':'  |  ,` /  ＿人人＿
( \    `-,_,-~}  | l   ＞ �  ＜
 `~   / `,  /' \ '"'   ＞ �  ＜
     ,7   \/   |.      ￣Y^Y^￣
     {  ; |, ,  )
     |,`: |`,`: |
     \` , /\`.; /
      |`;/  \ , |
      \``\   |` (
      \ . )  {  /
       \ `/  (  }
        \ |  | /
        ) \  | |
     c~^_~d  V _`,
```
これを解決する必要があります。

## 参考にした情報

以下のリンクを読めば今回なぜ問題が起きたのかすべてを理解できます。

[JavaScript における文字コードと「文字数」の数え方](https://blog.jxck.io/entries/2017-03-02/unicode-in-javascript.html)

すばらしいまとめと説明でした。
リンク先を読めばこれより下にある文章は読まなくてもJavaScriptにおける文字コード問題はほぼ解決できるでしょう。

## なにが問題だったのか

実際に書いたコードはもう少し複雑ですが、
単純化して説明するために１行の文字列を縦書きで表示するプログラムで説明します。

```javascript
'天気☀☁'.split('').join('\n')
// 天
// 気
// ☀
// ☁
```
このコードはUTF-16において16ビットで収まる文字であれば十分機能します。
しかし、サロゲートペアの範囲(U+10000 〜 U+10FFFF)に含まれる文字になると事情が異なります。


```javascript
'💩🚽'.split('').join('\n')
// \ud83d
// �
// \ud83d
// �
```

これは、JavaScriptの内部表現はUTF-16であり、JavaScriptの正規表現の "." が１文字ではなくUTF-16のデータ16bitに一致することを表しているためのようです。

## サロゲートペアな文字に対応する

こういう1文字がほしいときのために、
JavaScriptの正規表現にはES2015から[ "u" フラグ ](https://developer.mozilla.org/ja/docs/Web/JavaScript/Reference/Global_Objects/RegExp/unicode)というオプションが追加されたみたいです。

また、String.prototype.splitは[UTF-16のコードユニット毎にしか分割できない](https://developer.mozilla.org/ja/docs/Web/JavaScript/Reference/Global_Objects/String/split#Syntax)ため、
String.prototype.matchを使う必要があります。

```javascript
'天気☀☁💩🚽'.match(/./ug).join('\n')
// 天
// 気
// ☀
// ☁
// 💩
// 🚽
```

また、[スプレッド構文](https://developer.mozilla.org/ja/docs/Web/JavaScript/Reference/Operators/Spread_syntax)でも分解できるようです。こっちのほうが短くて良いですね。

```javascript
[ ...'天気☀☁💩🚽' ].join('\n')
// 天
// 気
// ☀
// ☁
// 💩
// 🚽
```

## 結合文字列の問題

これで問題は解決したかに思われましたが、Unicodeには結合文字列という、
基底文字＋結合文字で1文字を表す文字列が存在します。

```javascript
[ ...'👨‍👩‍👧‍👦' ].join('\n')
// 👨
// ‍
// 👩
‍// 
// 👧
‍// 
// 👦
[ ...'pͪoͣnͬpͣoͥnͭpͣa͡inͥ' ].join('\n')
// p
// ͪ
// o
// ͣ
// n
// ͬ
// p
// ͣ
// o
// ͥ
// n
// ͭ
// p
// ͣ
// a
// ͡
// i
// n
// ͥ
```

この状態では家族は離散してしまい、お腹が痛いというメッセージも伝わらないです。


この問題は「**基底文字＋結合文字で1文字を表す**」というUnicodeにおける文字(CodePoint)と見た目の文字数が一致していないことに起因するみたいです。

この問題は多くの場合、[Unicode正規化](https://ja.wikipedia.org/wiki/Unicode%E6%AD%A3%E8%A6%8F%E5%8C%96) のみで解決できるかもしれません。
しかしZWJ (U+200D)を使用した絵文字 " 👨‍👩‍👧‍👦　"は７文字で１文字に見える合字を表しており、
このような文字はUnicode正規化では問題を解決することができません。

## 結合文字列とgrapheme clusterに対応する

しかしながら「**１文字に見える単位**」にも複雑ながら定義がされているらしいです。
[UAX #29 Unicode Text Segmentation](https://unicode.org/reports/tr29/)
**grapheme cluster** というUnicodeにおいて１文字に見える範囲と、その境界を判断するルールらしいです。

これを実装すれば解決できそうですね………
実装できないのでライブラリ使います。

使用した素晴らしいライブラリです。
https://www.npmjs.com/package/graphemesplit

```javascript
const split = require('graphemesplit')

split('👨‍👩‍👧‍👦' ).join('\n')
// 👨‍👩‍👧‍👦
split('pͪoͣnͬpͣoͥnͭpͣa͡inͥ').join('\n')
// pͪ
// oͣ
// nͬ
// pͣ
// oͥ
// nͭ
// pͣ
// a͡
// i
// nͥ
```

すばらしいです！これで家族が離散しなくて済みます！

## まとめ

文字の問題を片付け、正しく縦書きにして表示できるようになりました。

```txt
$ muscular shout '天気☀☁💩🚽👨‍👩‍👧‍👦'
   ,~-,    .-,    r~-.    
  / r-d   /   \   `w`,\   
,7 /      \   /      \ \  
/  ^"`-'v/'`-y|`"'-"^-` ) 
`\,_ _,;,   ,     A,,  /  
    "'\ `:,.'`..,`)' `'   
       \ ,  ;, ,,r`       
        `, .,.` )         ＿人人＿
         ) `;.  }         ＞ 天 ＜
         |._,,_.|         ＞ 気 ＜
         ^\    .'.        ＞ ☀  ＜
        /  \, /  \,       ＞ ☁  ＜
        | ; `/ `  )       ＞ 💩 ＜
        | ,  |  . |       ＞ 🚽 ＜
        \,`,,A ;`,}       ＞ 👨‍👩‍👧‍👦 ＜
        ';  ) \   ,       ￣Y^Y^￣
         \',/  (  }       
         \  \  /  |       
          ( ,)(   ,       
          \ ;} :`/        
           \ | )V         
            )\| |         
         ,^'_}?__`,       
```


しかし、フォントの問題から様々な環境では崩れるかもしれません。少なくとも私の手元の環境では崩れます。
Unicodeは難しいですね。
また、"文字"という概念を理解するのも難しそうです。

---

何か誤っている点がありましたらご教示いただけると幸いです。