feat: 한글 문자열에 대한 검증, assert, parsing 함수를 구현합니다.

[sa02045]

Overview

#106 이슈에서 제안한 "한글 문자열"만을 다루기 위한 내부 함수를 구현합니다.

한글 문자열임을 보장하기 위해 상황에 따라 검증, assert, parsing 기능을 제공합니다.

• 검증(validation): isHangul
• assert: assertHangul
• parsing: parseHangul, safeParseHangul

** "한글 문자열"에 대한 정의는 다른 이슈를 참고해 "공백포함"인 경우를 생각했습니다.

parsing은 유저 입력같이 런타임 데이터를 주로 다루는 함수에서 사용될 것으로 기대합니다.

• 알수없는 입력값 string 타입을 한글 문자열로 parsing하여 사용

example)

export function hangulIncludes(x: string, y: string) {
  const parsedHangulX = safeParseHangul(x)  
  const parsedHangulY = safeParseHangul(y)

  if( !(parsedHangulX.success && parsedHangulY.success) ){
     return false
  }
  
   // 한글 문자열로 파싱 후 disassemble
  const disassembledX = disassembleHangul(parsedHangulX.data);
  const disassembledY = disassembleHangul(parsedHangulY.data);
  
  // ...
}

PR Checklist

• I read and included theses actions below

1. I have read the Contributing Guide
2. I have written documents and tests, if needed.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 2d3974e

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
es-hangul	❌ Failed (Inspect)			Jun 25, 2024 5:56pm

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.58%. Comparing base (db94449) to head (2d3974e).

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #136      +/-   ##
==========================================
+ Coverage   99.56%   99.58%   +0.02%     
==========================================
  Files          14       14              
  Lines         230      242      +12     
  Branches       51       53       +2     
==========================================
+ Hits          229      241      +12     
  Misses          1        1              

[okinawaa]

감사합니다! 내부적으로, 일관된 코딩스타일을 유지하는데 큰 도움이 될 것 같아요!