chore(@toss/hangul): deprecated @toss/hangul and convert to es-hangul (…

…toss#464)

Co-authored-by: Sojin Park <[email protected]>

packages/common/hangul/README.ko.md

@@ -2,6 +2,21 @@
 
 현대적인 JavaScript로 한글을 다루는 라이브러리입니다.
 
+## 지원 종료 안내
+
+`@toss/hangul`은 더 이상 지원되지 않습니다. 새로운 패키지 `es-hangul`로 전환되었으며, 이는 기능성과 성능이 개선되었습니다.
+
+### 추천 조치 사항:
+
+- 의존성을 `es-hangul`로 업데이트하세요.
+- 새 기능과 구현 세부사항에 대해서는 `es-hangul` 문서를 참고해 주세요.
+
+지속적인 지원과 이해에 감사드립니다.
+
+## 문서
+
+`es-hangul`에 대한 자세한 정보는 [es-hangul 문서](https://es-hangul.slash.page/)에서 확인하실 수 있습니다.
+
 ## 배경
 
 한국어로 된 서비스에서 검색과 같은 기능을 개발할 때, 한글 문자열을 정교하게 다루어야 하는 경우가 생깁니다.

packages/common/hangul/README.md

@@ -2,6 +2,21 @@
 
 A library to handle [Hangul](https://en.wikipedia.org/wiki/Hangul) (Korean) characters, in modern JavaScript.
 
+## Deprecation Notice
+
+Please note that `@toss/hangul` has been deprecated. We have transitioned to a new package, `es-hangul`, which offers improved functionality and performance.
+
+### Recommended Actions:
+
+- Update your dependencies to use `es-hangul`.
+- Refer to the `es-hangul` documentation for new features and implementation details.
+
+Thank you for your continued support and understanding.
+
+## Documentation
+
+For more information about `es-hangul`, please visit [es-hangul documentation](https://es-hangul.slash.page/).
+
 ## Motivation
 
 In Korean services, there are cases where we have to handle Hangul characters in a sophisticated way. For example, when searching among Korean strings, most Koreans expect to search `토스` with `톳`, or `토스` with `ㅌㅅ`.

packages/common/hangul/src/chosungIncludes.ts

@@ -3,6 +3,11 @@ import { HANGUL_CHARACTERS_BY_FIRST_INDEX } from './constants';
 import { disassembleHangulToGroups } from './disassemble';
 import { getFirstConsonants } from './utils';
 
+/**
+ * This method has been moved to the es-hangul library.
+ * Please use es-hangul for this functionality going forward.
+ * @deprecated This feature is now available in the es-hangul package.
+ */
 export function chosungIncludes(x: string, y: string) {
   if (!isOnlyInitialConsonant(y)) {
     return false;

packages/common/hangul/src/disassemble.ts

@@ -2,6 +2,11 @@
 import { DISASSEMBLED_CONSONANTS_BY_CONSONANT, DISASSEMBLED_VOWELS_BY_VOWEL } from './constants';
 import { disassembleCompleteHangulCharacter } from './disassembleCompleteHangulCharacter';
 
+/**
+ * This method has been moved to the es-hangul library.
+ * Please use es-hangul for this functionality going forward.
+ * @deprecated This feature is now available in the es-hangul package.
+ */
 export function disassembleHangulToGroups(str: string) {
   /*
    * FIXME(@raon0211):
@@ -40,6 +45,11 @@ export function disassembleHangulToGroups(str: string) {
   return result;
 }
 
+/**
+ * This method has been moved to the es-hangul library.
+ * Please use es-hangul for this functionality going forward.
+ * @deprecated This feature is now available in the es-hangul package.
+ */
 export function disassembleHangul(str: string) {
   return disassembleHangulToGroups(str).reduce((hanguls, disassembleds) => `${hanguls}${disassembleds.join('')}`, '');
 }

packages/common/hangul/src/hangulIncludes.ts

@@ -1,6 +1,11 @@
 /** @tossdocs-ignore */
 import { disassembleHangul } from './disassemble';
 
+/**
+ * This method has been moved to the es-hangul library.
+ * Please use es-hangul for this functionality going forward.
+ * @deprecated This feature is now available in the es-hangul package.
+ */
 export function hangulIncludes(x: string, y: string) {
   const disassembledX = disassembleHangul(x);
   const disassembledY = disassembleHangul(y);

packages/common/hangul/src/josa.ts

@@ -19,6 +19,11 @@ type JosaOption =
 
 const 로_조사: JosaOption[] = ['으로/로', '으로서/로서', '으로써/로써', '으로부터/로부터'];
 
+/**
+ * This method has been moved to the es-hangul library.
+ * Please use es-hangul for this functionality going forward.
+ * @deprecated This feature is now available in the es-hangul package.
+ */
 export function josa(word: string, josa: JosaOption): string {
   if (word.length === 0) {
     return word;