Merge branch 'main' into docs/demo-in-docs

toss · Aug 6, 2024 · d6a6fd6 · d6a6fd6
2 parents 029221a + accc087
commit d6a6fd6
Show file tree

Hide file tree

Showing 116 changed files with 3,438 additions and 1,544 deletions.
diff --git a/.changeset/config.json b/.changeset/config.json
@@ -6,5 +6,5 @@
   "access": "public",
   "baseBranch": "main",
   "updateInternalDependencies": "patch",
-  "ignore": []
+  "ignore": ["docs"]
 }
diff --git a/.changeset/itchy-nails-bake.md b/.changeset/itchy-nails-bake.md
diff --git a/.changeset/silly-lamps-camp.md b/.changeset/silly-lamps-camp.md
diff --git a/.changeset/tough-suits-push.md b/.changeset/tough-suits-push.md
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -74,4 +74,4 @@ import hangul from 'es-hangul' // hangul default export에 묶어서도 제공
 hangul.getSimilarity(...)
 hangul.disassemble(...)
 hangul.josa(...)
-
+```
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,37 @@
 # es-hangul
 
+## 2.0.0
+
+### Major Changes
+
+- [#189](https://github.com/toss/es-hangul/pull/189) [`8a97fff`](https://github.com/toss/es-hangul/commit/8a97fffbaf1c4c68c228d10c4b8972f4e507e70e) Thanks [@okinawaa](https://github.com/okinawaa)! - feat: 문자열에서 한글을 추출해주는 extractHangul 함수를 제거합니다
+
+- [#189](https://github.com/toss/es-hangul/pull/189) [`7a33c1e`](https://github.com/toss/es-hangul/commit/7a33c1e2701471628582af3dd051e5ba1cc4c1f1) Thanks [@okinawaa](https://github.com/okinawaa)! - feat: hasBatchim 을 utils에서 별도 함수로 분리합니다.
+
+- [#204](https://github.com/toss/es-hangul/pull/204) [`82e03c3`](https://github.com/toss/es-hangul/commit/82e03c33182d248d7f6c8bfcb9241234464a37c8) Thanks [@Collection50](https://github.com/Collection50)! - fix: 일관된 한글 이름 규칙 설정 함수명에서 꼭 필요하지 않다면 hangul이라는 워딩을 제거합니다
+
+- [#189](https://github.com/toss/es-hangul/pull/189) [`6456f79`](https://github.com/toss/es-hangul/commit/6456f7989abd06d8abda29a3aadd460e5393e11b) Thanks [@okinawaa](https://github.com/okinawaa)! - feat: disassembleHangul, disassemble, disassembleHangulToGroup 함수에서 hangul이라는 글자를 제거합니다
+
+- [#189](https://github.com/toss/es-hangul/pull/189) [`cbf3e4a`](https://github.com/toss/es-hangul/commit/cbf3e4ac2765b427d1c40b3cf7bb1ef059681747) Thanks [@okinawaa](https://github.com/okinawaa)! - feat: choseongIncludes함수를 제거합니다.
+
+- [#189](https://github.com/toss/es-hangul/pull/189) [`7ed39ac`](https://github.com/toss/es-hangul/commit/7ed39acc775e1ea0002a052b7403050c04be1341) Thanks [@okinawaa](https://github.com/okinawaa)! - canBeChoseong, canBeJungseong, canBeJongseong 을 utils에서 별도 함수로 분리합니다.
+
+- [#189](https://github.com/toss/es-hangul/pull/189) [`642a3e4`](https://github.com/toss/es-hangul/commit/642a3e449ecea1312b73679049b0a49efb7da161) Thanks [@okinawaa](https://github.com/okinawaa)! - hangulIncludes 함수를 제거합니다
+
+- [#189](https://github.com/toss/es-hangul/pull/189) [`9f8dd1b`](https://github.com/toss/es-hangul/commit/9f8dd1b84cfbc941c19e105daff316d3d8afeffb) Thanks [@okinawaa](https://github.com/okinawaa)! - feat: 한글의 두음을 반환해주는 acronymizeHangul 함수를 제거합니다.
+
+## 1.5.0
+
+### Minor Changes
+
+- [#115](https://github.com/toss/es-hangul/pull/115) [`84584d4`](https://github.com/toss/es-hangul/commit/84584d48ac5ded83c55934f0b72e37a6b889f4e1) Thanks [@po4tion](https://github.com/po4tion)! - feat: 한국어를 로마자로 변환해주는 함수와 한국어를 표준 발음법으로 변환해주는 함수를 만들고 문서화를 진행합니다
+
+## 1.4.7
+
+### Patch Changes
+
+- [#201](https://github.com/toss/es-hangul/pull/201) [`56db7f0`](https://github.com/toss/es-hangul/commit/56db7f0140ee369fbe0dc2dad834e8d6a218a4ea) Thanks [@BO-LIKE-CHICKEN](https://github.com/BO-LIKE-CHICKEN)! - feat: 숫자를 순 우리말 수사로 변환하거나 수 관형사로 변환하는 함수를 추가
+
 ## 1.4.6
 
 ### Patch Changes

diff --git a/README-en_us.md b/README-en_us.md
@@ -11,12 +11,16 @@ es-hangul is a library that makes it easy to handle [Hangul](https://en.wikipedi
 You can easily implement tasks related to Hangul, such as initial consonant search and attaching particles(josas).
 
 ```tsx
-import { choseongIncludes } from 'es-hangul';
+import { getChoseong } from 'es-hangul';
 
 const searchWord = '라면';
 const userInput = 'ㄹㅁ';
 
-const result = choseongIncludes(searchWord, userInput); // true
+const result = getChoseong(searchWord); // ㄹㅁ
+
+if (result === userInput) {
+  // do something
+}
 ```
 
 ```tsx

diff --git a/README.md b/README.md
@@ -8,15 +8,19 @@
 
 ## 사용 예시
 
-초성 검색, 조사 붙이기와 같은 한글 작업을 간단히 할 수 있습니다.
+문자열 초성화, 조사 붙이기와 같은 한글 작업을 간단히 할 수 있습니다.
 
 ```tsx
-import { choseongIncludes } from 'es-hangul';
+import { getChoseong } from 'es-hangul';
 
 const searchWord = '라면';
 const userInput = 'ㄹㅁ';
 
-const result = choseongIncludes(searchWord, userInput); // true
+const result = getChoseong(searchWord); // ㄹㅁ
+
+if (result === userInput) {
+  // 일치한다면 if문이 실행
+}
 ```
 
 ```tsx

diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
@@ -1,5 +1,31 @@
 # docs
 
+## 0.1.16
+
+### Patch Changes
+
+- Updated dependencies [[`84584d4`](https://github.com/toss/es-hangul/commit/84584d48ac5ded83c55934f0b72e37a6b889f4e1)]:
+  - es-hangul@1.5.0
+
+## 0.1.15
+
+### Patch Changes
+
+- [#209](https://github.com/toss/es-hangul/pull/209) [`c15a9d1`](https://github.com/toss/es-hangul/commit/c15a9d18cff0bc36f7672f3d6ab38e422a625d34) Thanks [@kangju2000](https://github.com/kangju2000)! - docs: josa, josa.pick 문서에 demo를 추가합니다.
+
+- [#205](https://github.com/toss/es-hangul/pull/205) [`75ef7df`](https://github.com/toss/es-hangul/commit/75ef7dfb1e1e27f33cb3fb2e4ab3184b6d0901c6) Thanks [@anonymousRecords](https://github.com/anonymousRecords)! - fix : 문서 상단의 깃허브 아이콘이 제대로 보이지 않는 문제를 수정합니다
+
+## 0.1.14
+
+### Patch Changes
+
+- [#200](https://github.com/toss/es-hangul/pull/200) [`9e6d391`](https://github.com/toss/es-hangul/commit/9e6d391a983eaf2b67bf00e92384839b8a60d8dd) Thanks [@kangju2000](https://github.com/kangju2000)! - feat: 문서에서 바로 실행해볼 수 있는 Sandpack MDX 컴포넌트를 구현합니다.
+
+- [#207](https://github.com/toss/es-hangul/pull/207) [`3c5c7f6`](https://github.com/toss/es-hangul/commit/3c5c7f6176e4cc6902950191a5614b4b12789ded) Thanks [@anonymousRecords](https://github.com/anonymousRecords)! - 새로고침 시 문서 로고의 layout shift를 개선함
+
+- Updated dependencies [[`56db7f0`](https://github.com/toss/es-hangul/commit/56db7f0140ee369fbe0dc2dad834e8d6a218a4ea)]:
+  - es-hangul@1.4.7
+
 ## 0.1.13
 
 ### Patch Changes

diff --git a/docs/package.json b/docs/package.json
@@ -1,6 +1,6 @@
 {
   "name": "docs",
-  "version": "0.1.13",
+  "version": "0.1.16",
   "private": true,
   "packageManager": "yarn@4.1.1",
   "scripts": {

diff --git a/docs/src/components/demo/choseong-includes-demo.tsx b/docs/src/components/demo/choseong-includes-demo.tsx
diff --git a/docs/src/pages/docs/api/acronymizeHangul.en.mdx b/docs/src/pages/docs/api/acronymizeHangul.en.mdx
diff --git a/docs/src/pages/docs/api/acronymizeHangul.ko.mdx b/docs/src/pages/docs/api/acronymizeHangul.ko.mdx
diff --git a/docs/src/pages/docs/api/canBe.en.md b/docs/src/pages/docs/api/canBe.en.md
@@ -0,0 +1,53 @@
+---
+title: canBe
+---
+
+# canBeChoseong
+
+Check if a given character can be a choseong in Korean.
+
+```typescript
+function canBeChoseong(character: string): boolean;
+```
+
+```typescript
+canBeChoseong('ㄱ'); // true
+canBeChoseong('ㅃ'); // true
+canBeChoseong('ㄱㅅ'); // false
+canBeChoseong('ㅏ'); // false
+canBeChoseong('가'); // false
+```
+
+# canBeJungseong
+
+Check if a given character can be a jungseong in Korean.
+
+```typescript
+function canBeJungseong(character: string): boolean;
+```
+
+```typescript
+canBeJungseong('ㅏ'); // true
+canBeJungseong('ㅗㅏ'); // true
+canBeJungseong('ㅏㅗ'); // false
+canBeJungseong('ㄱ'); // false
+canBeJungseong('ㄱㅅ'); // false
+canBeJungseong('가'); // false
+```
+
+# canBeJongseong
+
+Check if a given character can be a jongseong in Korean.
+
+```typescript
+function canBeJongseong(character: string): boolean;
+```
+
+```typescript
+canBeJongseong('ㄱ'); // true
+canBeJongseong('ㄱㅅ'); // true
+canBeJongseong('ㅎㄹ'); // false
+canBeJongseong('가'); // false
+canBeJongseong('ㅏ'); // false
+canBeJongseong('ㅗㅏ'); // false
+```
diff --git a/docs/src/pages/docs/api/canBe.ko.md b/docs/src/pages/docs/api/canBe.ko.md
@@ -0,0 +1,53 @@
+---
+title: canBe
+---
+
+# canBeChoseong
+
+인자로 받은 문자가 초성으로 위치할 수 있는 문자인지 검사합니다.
+
+```typescript
+function canBeChoseong(character: string): boolean;
+```
+
+```typescript
+canBeChoseong('ㄱ'); // true
+canBeChoseong('ㅃ'); // true
+canBeChoseong('ㄱㅅ'); // false
+canBeChoseong('ㅏ'); // false
+canBeChoseong('가'); // false
+```
+
+# canBeJungseong
+
+인자로 받은 문자가 중성으로 위치할 수 있는 문자인지 검사합니다.
+
+```typescript
+function canBeJungseong(character: string): boolean;
+```
+
+```typescript
+canBeJungseong('ㅏ'); // true
+canBeJungseong('ㅗㅏ'); // true
+canBeJungseong('ㅏㅗ'); // false
+canBeJungseong('ㄱ'); // false
+canBeJungseong('ㄱㅅ'); // false
+canBeJungseong('가'); // false
+```
+
+# canBeJongseong
+
+인자로 받은 문자가 종성으로 위치할 수 있는 문자인지 검사합니다.
+
+```typescript
+function canBeJongseong(character: string): boolean;
+```
+
+```typescript
+canBeJongseong('ㄱ'); // true
+canBeJongseong('ㄱㅅ'); // true
+canBeJongseong('ㅎㄹ'); // false
+canBeJongseong('가'); // false
+canBeJongseong('ㅏ'); // false
+canBeJongseong('ㅗㅏ'); // false
+```