From aab90a1276a55340751163522166345c9aa5f19b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=EB=B0=95=EC=B0=AC=ED=98=81?= <pgg6713@gmail.com>
Date: Sun, 14 Jul 2024 16:53:10 +0900
Subject: [PATCH] =?UTF-8?q?feat:=20=ED=95=9C=EA=B8=80=EC=9D=98=20=EB=91=90?=
 =?UTF-8?q?=EC=9D=8C=EC=9D=84=20=EB=B0=98=ED=99=98=ED=95=B4=EC=A3=BC?=
 =?UTF-8?q?=EB=8A=94=20acronymizeHangul=20=ED=95=A8=EC=88=98=EB=A5=BC=20?=
 =?UTF-8?q?=EC=A0=9C=EA=B1=B0=ED=95=A9=EB=8B=88=EB=8B=A4.=20(#180)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

* remove acronymize

* Create weak-walls-sniff.md

---------

Co-authored-by: Jonghyeon Ko <manudeli.ko@gmail.com>
---
 .changeset/weak-walls-sniff.md                 |  5 +++++
 .../src/pages/docs/api/acronymizeHangul.en.mdx | 16 ----------------
 .../src/pages/docs/api/acronymizeHangul.ko.mdx | 16 ----------------
 src/acronymizeHangul.spec.ts                   | 18 ------------------
 src/acronymizeHangul.ts                        | 12 ------------
 src/index.ts                                   |  1 -
 6 files changed, 5 insertions(+), 63 deletions(-)
 create mode 100644 .changeset/weak-walls-sniff.md
 delete mode 100644 docs/src/pages/docs/api/acronymizeHangul.en.mdx
 delete mode 100644 docs/src/pages/docs/api/acronymizeHangul.ko.mdx
 delete mode 100644 src/acronymizeHangul.spec.ts
 delete mode 100644 src/acronymizeHangul.ts

diff --git a/.changeset/weak-walls-sniff.md b/.changeset/weak-walls-sniff.md
new file mode 100644
index 00000000..975a6db5
--- /dev/null
+++ b/.changeset/weak-walls-sniff.md
@@ -0,0 +1,5 @@
+---
+"es-hangul": major
+---
+
+feat: 한글의 두음을 반환해주는 acronymizeHangul 함수를 제거합니다.
diff --git a/docs/src/pages/docs/api/acronymizeHangul.en.mdx b/docs/src/pages/docs/api/acronymizeHangul.en.mdx
deleted file mode 100644
index 9f2f9007..00000000
--- a/docs/src/pages/docs/api/acronymizeHangul.en.mdx
+++ /dev/null
@@ -1,16 +0,0 @@
-# acronymizeHangul
-
-It receives the Korean sentence and returns the first letter of that Korean sentence.
-(We don't deal with non-Korean sentences; we don't deal with additional Korean + English sentences.)
-
-```typescript
-function acronymizeHangul(
-  // String consisting of plural nouns (e.g. '버스 충전', '치킨과 맥주')
-  hangul: string
-): string[];
-```
-
-```typescript
-acronymizeHangul('치킨과 맥주').join(''); //치맥
-acronymizeHangul('버스 충전 카드').join(''); //버충카
-```
diff --git a/docs/src/pages/docs/api/acronymizeHangul.ko.mdx b/docs/src/pages/docs/api/acronymizeHangul.ko.mdx
deleted file mode 100644
index c1b576a4..00000000
--- a/docs/src/pages/docs/api/acronymizeHangul.ko.mdx
+++ /dev/null
@@ -1,16 +0,0 @@
-# acronymizeHangul
-
-한글 문장을 입력받아서, 해당 한글 문장의 첫글자를 리턴해줍니다.
-(한글 문장이 아닌, 문장은 취급하지않습니다. 추가로 한글 문장 + 영어 문장의 경우에도 취급하지않습니다.)
-
-```typescript
-function acronymizeHangul( 
-  // 복수 명사로 이루어진 문자열 (e.g. '버스 충전', '치킨과 맥주')
-  hangul: string
-): string[];
-```
-
-```typescript
-acronymizeHangul('치킨과 맥주').join(''); //치맥
-acronymizeHangul('버스 충전 카드').join(''); //버충카
-```
diff --git a/src/acronymizeHangul.spec.ts b/src/acronymizeHangul.spec.ts
deleted file mode 100644
index a4d8b91e..00000000
--- a/src/acronymizeHangul.spec.ts
+++ /dev/null
@@ -1,18 +0,0 @@
-import { acronymizeHangul } from './acronymizeHangul';
-
-describe('acronymizeHangul', () => {
-  it('한글 문장 단어중 첫 문자만 뽑은 리스트를 반환', () => {
-    expect(acronymizeHangul('치킨과 맥주')).toHaveLength(2);
-    expect(acronymizeHangul('치킨과 맥주').join('')).toBe('치맥');
-
-    expect(acronymizeHangul('버스 충전 카드')).toHaveLength(3);
-    expect(acronymizeHangul('버스 충전 카드').join('')).toBe('버충카');
-  });
-  it('한글이 아닌 문장 넣었을 때', () => {
-    expect(() => acronymizeHangul('test test')).toThrowError('"test test" is not a valid hangul string');
-  });
-
-  it('한글과 영어가 섞인 문장을 넣었을 때', () => {
-    expect(() => acronymizeHangul('고기와 Cheese')).toThrowError('"고기와 Cheese" is not a valid hangul string');
-  });
-});
diff --git a/src/acronymizeHangul.ts b/src/acronymizeHangul.ts
deleted file mode 100644
index 9103ec40..00000000
--- a/src/acronymizeHangul.ts
+++ /dev/null
@@ -1,12 +0,0 @@
-import { parseHangul } from './_internal/hangul';
-
-/**
- *
- * @param getHangulAcronym
- * @description
- * 한글 문장을 입력받아서, 해당 한글 문장의 초성을을 리턴해줍니다.
- * 한글 문장이 아닌, 문장은 취급하지않습니다. 추가로 한글 문장 + 영어 문장의 경우에도 취급하지않습니다.
- */
-export function acronymizeHangul(hangul: string) {
-return parseHangul(hangul).split(' ').map(word => word.charAt(0));
-}
diff --git a/src/index.ts b/src/index.ts
index d8cfe6f8..87b3cb4a 100644
--- a/src/index.ts
+++ b/src/index.ts
@@ -17,5 +17,4 @@ export {
   hasSingleBatchim,
   hasValueInReadOnlyStringList,
 } from './utils';
-export { acronymizeHangul } from './acronymizeHangul';
 export { susa } from './susa';