feat: Strictly manage constants by adding hasValueInStringList, hasPr… (

#38) * feat: Strictly manage constants by adding hasValueInStringList, hasPropert * feat: Added disassembleCompleteHangulCharacter return type * Create strong-jars-argue.md --------- Co-authored-by: 박찬혁 <pgg6713@gmail.com>
toss · Apr 15, 2024 · b7df997 · b7df997
1 parent 2cb0d98
commit b7df997
Show file tree

Hide file tree

Showing 6 changed files with 36 additions and 16 deletions.
diff --git a/.changeset/strong-jars-argue.md b/.changeset/strong-jars-argue.md
@@ -0,0 +1,5 @@
+---
+"es-hangul": patch
+---
+
+feat: Strictly manage constants by adding hasValueInStringList, hasPr…
diff --git a/src/chosungIncludes.ts b/src/chosungIncludes.ts
@@ -1,6 +1,6 @@
 import { HANGUL_CHARACTERS_BY_FIRST_INDEX } from './constants';
 import { disassembleHangulToGroups } from './disassemble';
-import { getFirstConsonants } from './utils';
+import { getFirstConsonants, hasValueInReadOnlyStringList } from './utils';
 
 export function chosungIncludes(x: string, y: string) {
   if (!isOnlyInitialConsonant(y)) {
@@ -18,6 +18,6 @@ export function chosungIncludes(x: string, y: string) {
  */
 function isOnlyInitialConsonant(str: string) {
   return disassembleHangulToGroups(str).every(disassembled => {
-    return disassembled.length === 1 && HANGUL_CHARACTERS_BY_FIRST_INDEX.includes(disassembled[0] ?? '');
+    return disassembled.length === 1 && hasValueInReadOnlyStringList(HANGUL_CHARACTERS_BY_FIRST_INDEX, disassembled[0]);
   });
 }
diff --git a/src/constants.ts b/src/constants.ts
@@ -7,7 +7,7 @@ export const NUMBER_OF_JUNGSUNG = 21;
  * ㄱ -> 'ㄱ'
  * ㄳ -> 'ㄱㅅ' 으로 나눈다.
  */
-export const DISASSEMBLED_CONSONANTS_BY_CONSONANT: { [letter: string]: string | undefined } = {
+export const DISASSEMBLED_CONSONANTS_BY_CONSONANT = {
   // 종성이 없는 경우 '빈' 초성으로 관리하는 것이 편리하여, 빈 문자열도 포함한다.
   '': '',
   ㄱ: 'ㄱ',
@@ -40,9 +40,9 @@ export const DISASSEMBLED_CONSONANTS_BY_CONSONANT: { [letter: string]: string |
   ㅌ: 'ㅌ',
   ㅍ: 'ㅍ',
   ㅎ: 'ㅎ',
-};
+} as const;
 
-export const DISASSEMBLED_VOWELS_BY_VOWEL: { [letter: string]: string | undefined } = {
+export const DISASSEMBLED_VOWELS_BY_VOWEL = {
   ㅏ: 'ㅏ',
   ㅐ: 'ㅐ',
   ㅑ: 'ㅑ',
@@ -64,7 +64,7 @@ export const DISASSEMBLED_VOWELS_BY_VOWEL: { [letter: string]: string | undefine
   ㅡ: 'ㅡ',
   ㅢ: 'ㅡㅣ',
   ㅣ: 'ㅣ',
-};
+} as const;
 
 /**
  * 초성으로 올 수 있는 한글 글자
@@ -89,17 +89,17 @@ export const HANGUL_CHARACTERS_BY_FIRST_INDEX = [
   'ㅌ',
   'ㅍ',
   'ㅎ',
-];
+] as const;
 
 /**
  * 중성으로 올 수 있는 한글 글자
  */
-export const HANGUL_CHARACTERS_BY_MIDDLE_INDEX = Object.values(DISASSEMBLED_VOWELS_BY_VOWEL) as string[];
+export const HANGUL_CHARACTERS_BY_MIDDLE_INDEX = Object.values(DISASSEMBLED_VOWELS_BY_VOWEL);
 
 /**
  * 종성으로 올 수 있는 한글 글자
  */
-export const HANGUL_CHARACTERS_BY_LAST_INDEX = [
+export const HANGUL_CHARACTERS_BY_LAST_INDEX = ([
   '',
   'ㄱ',
   'ㄲ',
@@ -128,4 +128,4 @@ export const HANGUL_CHARACTERS_BY_LAST_INDEX = [
   'ㅌ',
   'ㅍ',
   'ㅎ',
-].map(consonant => DISASSEMBLED_CONSONANTS_BY_CONSONANT[consonant]!);
+] as const).map(consonant => DISASSEMBLED_CONSONANTS_BY_CONSONANT[consonant]);
diff --git a/src/disassemble.ts b/src/disassemble.ts
@@ -1,5 +1,6 @@
 import { DISASSEMBLED_CONSONANTS_BY_CONSONANT, DISASSEMBLED_VOWELS_BY_VOWEL } from './constants';
 import { disassembleCompleteHangulCharacter } from './disassembleCompleteHangulCharacter';
+import { hasProperty } from './utils';
 
 export function disassembleHangulToGroups(str: string) {
   /*
@@ -19,16 +20,16 @@ export function disassembleHangulToGroups(str: string) {
       continue;
     }
 
-    const disassembledConsonant = DISASSEMBLED_CONSONANTS_BY_CONSONANT[letter];
+    if (hasProperty(DISASSEMBLED_CONSONANTS_BY_CONSONANT, letter)) {
+      const disassembledConsonant = DISASSEMBLED_CONSONANTS_BY_CONSONANT[letter];
 
-    if (disassembledConsonant != null) {
       result.push([...disassembledConsonant]);
       continue;
     }
 
-    const disassembledVowel = DISASSEMBLED_VOWELS_BY_VOWEL[letter];
+    if (hasProperty(DISASSEMBLED_VOWELS_BY_VOWEL, letter)) {
+      const disassembledVowel = DISASSEMBLED_VOWELS_BY_VOWEL[letter];
 
-    if (disassembledVowel != null) {
       result.push([...disassembledVowel]);
       continue;
     }

diff --git a/src/disassembleCompleteHangulCharacter.ts b/src/disassembleCompleteHangulCharacter.ts
@@ -8,9 +8,15 @@ import {
   NUMBER_OF_JUNGSUNG,
 } from './constants';
 
+interface ReturnTypeDisassembleCompleteHangulCharacter {
+  first: (typeof HANGUL_CHARACTERS_BY_FIRST_INDEX)[number];
+  middle: (typeof HANGUL_CHARACTERS_BY_MIDDLE_INDEX)[number];
+  last: (typeof HANGUL_CHARACTERS_BY_LAST_INDEX)[number];
+}
+
 export function disassembleCompleteHangulCharacter(
   letter: string
-): { first: string; middle: string; last: string } | undefined {
+): ReturnTypeDisassembleCompleteHangulCharacter | undefined {
   const charCode = letter.charCodeAt(0);
 
   const isCompleteHangul = COMPLETE_HANGUL_START_CHARCODE <= charCode && charCode <= COMPLETE_HANGUL_END_CHARCODE;
@@ -29,5 +35,5 @@ export function disassembleCompleteHangulCharacter(
     first: HANGUL_CHARACTERS_BY_FIRST_INDEX[firstIndex]!,
     middle: HANGUL_CHARACTERS_BY_MIDDLE_INDEX[middleIndex]!,
     last: HANGUL_CHARACTERS_BY_LAST_INDEX[lastIndex]!,
-  };
+  } as const;
 }
diff --git a/src/utils.ts b/src/utils.ts
@@ -41,3 +41,11 @@ export function getFirstConsonants(word: string) {
     return `${firstConsonants}${consonant}`;
   }, '');
 }
+
+export function hasValueInReadOnlyStringList<T extends string>(list: readonly T[], value: string): value is T {
+  return list.some(item => item === value);
+}
+
+export function hasProperty<T extends object, K extends PropertyKey>(obj: T, key: K): key is K & keyof T {
+  return Object.prototype.hasOwnProperty.call(obj, key);
+}