fix: 일관된 한글 표기법 적용

docs/src/components/demo/chosung-includes-demo.tsx → docs/src/components/demo/choseong-includes-demo.tsx

@@ -1,7 +1,7 @@
 import React, { useState } from 'react';
 import { chosungIncludes } from 'es-hangul';
 
-export function ChosungIncludesDemo() {
+export function ChoseongIncludesDemo() {
   const [searchWord, setSearchWord] = useState<string>('홍길동');
   const [userInput, setUserInput] = useState<string>('ㅎㄱㄷ');
 

docs/src/pages/docs/api/chosungIncludes.en.mdx → docs/src/pages/docs/api/choseongIncludes.en.mdx

@@ -1,4 +1,4 @@
-import { ChosungIncludesDemo } from '@/components/demo/chosung-includes-demo';
+import { ChoseongIncludesDemo } from '@/components/demo/chosung-includes-demo';
 
 # chosungIncludes
 
@@ -24,4 +24,4 @@ chosungIncludes('프론트엔드', '푸롴트'); // false
 
 <br />
 
-<ChosungIncludesDemo />
+<ChoseongIncludesDemo />

docs/src/pages/docs/api/chosungIncludes.ko.mdx → docs/src/pages/docs/api/choseongIncludes.ko.mdx

@@ -1,4 +1,4 @@
-import { ChosungIncludesDemo } from '@/components/demo/chosung-includes-demo';
+import { ChoseongIncludesDemo } from '@/components/demo/chosung-includes-demo';
 
 # chosungIncludes
 
@@ -24,4 +24,4 @@ chosungIncludes('프론트엔드', '푸롴트'); // false
 
 <br />
 
-<ChosungIncludesDemo />
+<ChoseongIncludesDemo />

docs/src/pages/index.en.mdx

@@ -27,7 +27,8 @@ import { Callout, useTheme, Steps } from 'nextra-theme-docs';
       <h3 className="">A modern JavaScript Hangul library</h3>
     </div>
     <Callout className="w-full">
-      es-hangul is a small JavaScript library that helps you conveniently handle Hangul. It provides a convenient and clean API for actions such as searching for initial consonants and attaching particles.
+      es-hangul is a small JavaScript library that helps you conveniently handle Hangul. It provides a convenient and
+      clean API for actions such as searching for initial consonants and attaching particles.
     </Callout>
   </div>
 </div>

src/_internal/hangul.ts

@@ -2,7 +2,7 @@ import assert, { excludeLastElement, isBlank, joinString } from '.';
 import { combineHangulCharacter, combineVowels, curriedCombineHangulCharacter } from '../combineHangulCharacter';
 import { disassembleHangulToGroups } from '../disassemble';
 import { removeLastHangulCharacter } from '../removeLastHangulCharacter';
-import { canBeChosung, canBeJongsung, canBeJungsung, hasSingleBatchim } from '../utils';
+import { canBeChoseong, canBeJongseong, canBeJungseong, hasSingleBatchim } from '../utils';
 
 export function isHangulCharacter(character: string) {
   return /^[가-힣]$/.test(character);
@@ -57,12 +57,12 @@ export function safeParseHangul(actual: unknown): SafeParseSuccess | SafeParseEr
  * ```
  */
 export function binaryAssembleHangulAlphabets(source: string, nextCharacter: string) {
-  if (canBeJungsung(`${source}${nextCharacter}`)) {
+  if (canBeJungseong(`${source}${nextCharacter}`)) {
     return combineVowels(source, nextCharacter);
   }
 
-  const isConsonantSource = canBeJungsung(source) === false;
-  if (isConsonantSource && canBeJungsung(nextCharacter)) {
+  const isConsonantSource = canBeJungseong(source) === false;
+  if (isConsonantSource && canBeJungseong(nextCharacter)) {
     return combineHangulCharacter(source, nextCharacter);
   }
 
@@ -106,7 +106,7 @@ export function binaryAssembleHangulCharacters(source: string, nextCharacter: st
   );
   assert(
     isHangulAlphabet(nextCharacter),
-    `Invalid next character: ${nextCharacter}. Next character must be one of the chosung, jungsung, or jongsung.`
+    `Invalid next character: ${nextCharacter}. Next character must be one of the choseong, jungseong, or jongseong.`
   );
 
   const sourceJamos = disassembleHangulToGroups(source)[0];
@@ -119,29 +119,29 @@ export function binaryAssembleHangulCharacters(source: string, nextCharacter: st
 
   const [restJamos, lastJamo] = excludeLastElement(sourceJamos);
 
-  const needLinking = canBeChosung(lastJamo) && canBeJungsung(nextCharacter);
+  const needLinking = canBeChoseong(lastJamo) && canBeJungseong(nextCharacter);
   if (needLinking) {
     return linkHangulCharacters(source, nextCharacter);
   }
 
   const fixConsonant = curriedCombineHangulCharacter;
-  const combineJungsung = fixConsonant(restJamos[0]);
+  const combineJungseong = fixConsonant(restJamos[0]);
 
-  if (canBeJungsung(`${lastJamo}${nextCharacter}`)) {
-    return combineJungsung(`${lastJamo}${nextCharacter}`)();
+  if (canBeJungseong(`${lastJamo}${nextCharacter}`)) {
+    return combineJungseong(`${lastJamo}${nextCharacter}`)();
   }
 
-  if (canBeJungsung(lastJamo) && canBeJongsung(nextCharacter)) {
-    return combineJungsung(lastJamo)(nextCharacter);
+  if (canBeJungseong(lastJamo) && canBeJongseong(nextCharacter)) {
+    return combineJungseong(lastJamo)(nextCharacter);
   }
 
-  const fixVowel = combineJungsung;
-  const combineJongsung = fixVowel(restJamos[1]);
+  const fixVowel = combineJungseong;
+  const combineJongseong = fixVowel(restJamos[1]);
 
   const lastConsonant = lastJamo;
 
-  if (hasSingleBatchim(source) && canBeJongsung(`${lastConsonant}${nextCharacter}`)) {
-    return combineJongsung(`${lastConsonant}${nextCharacter}`);
+  if (hasSingleBatchim(source) && canBeJongseong(`${lastConsonant}${nextCharacter}`)) {
+    return combineJongseong(`${lastConsonant}${nextCharacter}`);
   }
 
   return joinString(source, nextCharacter);

src/chosungIncludes.spec.ts → src/choseongIncludes.spec.ts

@@ -1,35 +1,35 @@
-import { chosungIncludes } from './chosungIncludes';
+import { choseongIncludes } from './choseongIncludes';
 
-describe('chosungIncludes', () => {
+describe('choseongIncludes', () => {
   describe('초성이 포함되어있다고 판단되는 경우', () => {
     it('"ㅍㄹㅌ" 문자열로 "프론트엔드"를 검색하면 true를 반환한다.', () => {
-      expect(chosungIncludes('프론트엔드', 'ㅍㄹㅌ')).toBe(true);
+      expect(choseongIncludes('프론트엔드', 'ㅍㄹㅌ')).toBe(true);
     });
 
     it('"ㅍㄹㅌ" 문자열로 "00프론트엔드"를 검색하면 true를 반환한다.', () => {
-      expect(chosungIncludes('00프론트엔드', 'ㅍㄹㅌ')).toBe(true);
+      expect(choseongIncludes('00프론트엔드', 'ㅍㄹㅌ')).toBe(true);
     });
 
     it('"ㅍㄹㅌㅇㄷㄱㅂㅈ" 문자열로 "프론트엔드 개발자"를 검색하면 true를 반환한다.', () => {
-      expect(chosungIncludes('프론트엔드 개발자', 'ㅍㄹㅌㅇㄷㄱㅂㅈ')).toBe(true);
+      expect(choseongIncludes('프론트엔드 개발자', 'ㅍㄹㅌㅇㄷㄱㅂㅈ')).toBe(true);
     });
 
     it('"ㅍㄹㅌㅇㄷ ㄱㅂㅈ" 문자열로 "프론트엔드 개발자"를 검색하면 true를 반환한다.', () => {
-      expect(chosungIncludes('프론트엔드 개발자', 'ㅍㄹㅌㅇㄷ ㄱㅂㅈ')).toBe(true);
+      expect(choseongIncludes('프론트엔드 개발자', 'ㅍㄹㅌㅇㄷ ㄱㅂㅈ')).toBe(true);
     });
   });
 
   describe('초성이 포함되어있다고 판단되지 않는 경우', () => {
     it('"ㅍㅌ" 문자열로 "프론트엔드"를 검색하면 false를 반환한다.', () => {
-      expect(chosungIncludes('프론트엔드', 'ㅍㅌ')).toBe(false);
+      expect(choseongIncludes('프론트엔드', 'ㅍㅌ')).toBe(false);
     });
 
     it('빈 문자열로 "프론트엔드 개발자"를 검색하면 false를 반환한다.', () => {
-      expect(chosungIncludes('프론트엔드 개발자', ' ')).toBe(false);
+      expect(choseongIncludes('프론트엔드 개발자', ' ')).toBe(false);
     });
 
     it('"푸롴트" 문자열로 "프론트엔드"를 검색하면 초성으로만 구성되어 있지 않아 false를 반환한다.', () => {
-      expect(chosungIncludes('프론트엔드', '푸롴트')).toBe(false);
+      expect(choseongIncludes('프론트엔드', '푸롴트')).toBe(false);
     });
   });
 });

src/choseongIncludes.ts

@@ -0,0 +1,29 @@
+import { disassembleHangulToGroups } from './disassemble';
+import { canBeChoseong, getChoseong } from './utils';
+
+export function choseongIncludes(x: string, y: string) {
+  const trimmedY = y.replace(/\s/g, '');
+
+  if (!isOnlyChoseong(trimmedY)) {
+    return false;
+  }
+
+  const choseongX = getChoseong(x).replace(/\s/g, '');
+  const choseongY = trimmedY;
+
+  return choseongX.includes(choseongY);
+}
+
+/*
+ * @description 문자열이 한글초성으로만 주어진 경우
+ */
+export function isOnlyChoseong(str: string) {
+  const groups = disassembleHangulToGroups(str);
+  if (groups.length === 0) {
+    return false;
+  }
+
+  return groups.every(disassembled => {
+    return disassembled.length === 1 && canBeChoseong(disassembled[0]);
+  });
+}

src/chosungIncludes.ts

@@ -1,29 +1,18 @@
-import { disassembleHangulToGroups } from './disassemble';
-import { canBeChosung, getChosung } from './utils';
+import { isOnlyChoseong } from './choseongIncludes';
+import { getChoseong } from './utils';
 
+/**
+ * @deprecated choseongIncludes를 사용해 주세요.
+ */
 export function chosungIncludes(x: string, y: string) {
   const trimmedY = y.replace(/\s+/g, '');
 
-  if (!isOnlyChosung(trimmedY)) {
+  if (!isOnlyChoseong(trimmedY)) {
     return false;
   }
 
-  const chosungX = getChosung(x).replace(/\s+/g, '');
-  const chosungY = trimmedY;
-
-  return chosungX.includes(chosungY);
-}
-
-/*
- * @description 문자열이 한글초성으로만 주어진 경우
- */
-function isOnlyChosung(str: string) {
-  const groups = disassembleHangulToGroups(str);
-  if (groups.length === 0) {
-    return false;
-  }
+  const choseongX = getChoseong(x).replace(/\s/g, '');
+  const choseongY = trimmedY;
 
-  return groups.every(disassembled => {
-    return disassembled.length === 1 && canBeChosung(disassembled[0]);
-  });
+  return choseongX.includes(choseongY);
 }

src/combineHangulCharacter.ts

@@ -5,7 +5,7 @@ import {
   HANGUL_CHARACTERS_BY_LAST_INDEX,
   HANGUL_CHARACTERS_BY_MIDDLE_INDEX,
 } from './constants';
-import { canBeChosung, canBeJongsung, canBeJungsung } from './utils';
+import { canBeChoseong, canBeJongseong, canBeJungseong } from './utils';
 
 /**
  * @name combineHangulCharacter
@@ -27,9 +27,9 @@ import { canBeChosung, canBeJongsung, canBeJungsung } from './utils';
  */
 export function combineHangulCharacter(firstCharacter: string, middleCharacter: string, lastCharacter = '') {
   if (
-    canBeChosung(firstCharacter) === false ||
-    canBeJungsung(middleCharacter) === false ||
-    canBeJongsung(lastCharacter) === false
+    canBeChoseong(firstCharacter) === false ||
+    canBeJungseong(middleCharacter) === false ||
+    canBeJongseong(lastCharacter) === false
   ) {
     throw new Error(`Invalid hangul Characters: ${firstCharacter}, ${middleCharacter}, ${lastCharacter}`);
   }

src/constants.ts

@@ -1,7 +1,7 @@
 export const COMPLETE_HANGUL_START_CHARCODE = '가'.charCodeAt(0);
 export const COMPLETE_HANGUL_END_CHARCODE = '힣'.charCodeAt(0);
-export const NUMBER_OF_JONGSUNG = 28;
-export const NUMBER_OF_JUNGSUNG = 21;
+export const NUMBER_OF_JONGSEONG = 28;
+export const NUMBER_OF_JUNGSEONG = 21;
 
 const _JASO_HANGUL_NFD = [...'각힣'.normalize('NFD')].map(char => char.charCodeAt(0)); // NFC 에 정의되지 않은 문자는 포함하지 않음
 export const JASO_HANGUL_NFD = {
@@ -11,7 +11,7 @@ export const JASO_HANGUL_NFD = {
   END_CHOSEONG: _JASO_HANGUL_NFD[3], // ㅎ
   END_JUNGSEONG: _JASO_HANGUL_NFD[4], // ㅣ
   END_JONGSEONG: _JASO_HANGUL_NFD[5], // ㅎ
-}
+};
 
 /**
  * ㄱ -> 'ㄱ'

src/disassembleCompleteHangulCharacter.ts

@@ -4,8 +4,8 @@ import {
   HANGUL_CHARACTERS_BY_FIRST_INDEX,
   HANGUL_CHARACTERS_BY_LAST_INDEX,
   HANGUL_CHARACTERS_BY_MIDDLE_INDEX,
-  NUMBER_OF_JONGSUNG,
-  NUMBER_OF_JUNGSUNG,
+  NUMBER_OF_JONGSEONG,
+  NUMBER_OF_JUNGSEONG,
 } from './constants';
 
 interface ReturnTypeDisassembleCompleteHangulCharacter {
@@ -41,9 +41,9 @@ export function disassembleCompleteHangulCharacter(
 
   const hangulCode = charCode - COMPLETE_HANGUL_START_CHARCODE;
 
-  const lastIndex = hangulCode % NUMBER_OF_JONGSUNG;
-  const middleIndex = ((hangulCode - lastIndex) / NUMBER_OF_JONGSUNG) % NUMBER_OF_JUNGSUNG;
-  const firstIndex = Math.floor((hangulCode - lastIndex) / NUMBER_OF_JONGSUNG / NUMBER_OF_JUNGSUNG);
+  const lastIndex = hangulCode % NUMBER_OF_JONGSEONG;
+  const middleIndex = ((hangulCode - lastIndex) / NUMBER_OF_JONGSEONG) % NUMBER_OF_JUNGSEONG;
+  const firstIndex = Math.floor((hangulCode - lastIndex) / NUMBER_OF_JONGSEONG / NUMBER_OF_JUNGSEONG);
 
   return {
     first: HANGUL_CHARACTERS_BY_FIRST_INDEX[firstIndex],