toss / es-hangul

A modern JavaScript library for handling Hangul characters.
https://es-hangul.slash.page/
MIT License
1.34k stars 95 forks source link

feat: 한국어를 로마자로 변환해주는 함수와 한국어를 표준 발음법으로 변환해주는 함수를 만들고 문서화를 진행합니다 #115

Closed po4tion closed 3 months ago

po4tion commented 5 months ago

close #33

Overview

한글을 로마자로 변경하기 위해서는 다음과 같은 프로세스가 필요합니다.

  1. 입력받은 한글을 표준 발음법으로 변경합니다.
  2. 표준 발음법으로 변경된 한글을 로마자로 변경합니다. 단, 로마자 표기법은 된소리되기를 반영하지 않으므로 경음화가 적용되지 않은 표준 발음법을 기준으로 적용합니다.

한국어 어문 규범의 표준 발음법을 지키며 한글을 표준 발음법으로 변환하는 standardizePronunciation 함수를 만들고 문서화를 진행하였습니다. standardPronunciation 함수는 표준어 규정(문화체육관광부 고시 제2017-13호)의 제2부 표준발음법의 4장(받침의 발음), 5장(음의 동화), 6장(경음화)를 기반으로 기능을 구현하였습니다.

standardPronunciation 함수로 반환받은 표준 발음법(단, 경음화 제거)을 로마자로 변경합니다. 한국어 어문 규범의 '국어의 로마자 표기법'을 참고하여 romanize 함수를 만들고 문서화를 진행하였습니다.

테스트 커버리지 image

참고하실 수 있는 자료

  1. https://korean.go.kr/kornorms/main/main.do
  2. https://www.hankookilbo.com/News/Read/201611221071387854
  3. https://www.korean.go.kr/front/page/pageView.do?page_id=P000149&mn_id=99
  4. https://www.youtube.com/watch?v=gKRKVVLaDsM
  5. https://www.youtube.com/watch?v=UVStu0RVlCE
  6. https://www.youtube.com/watch?v=Mm2JX2naqWk
  7. http://contents2.kocw.or.kr/KOCW/data/document/2020/seowon/choiyungon0805/12.pdf
  8. https://www.youtube.com/watch?v=mubHE707Eo4

PR Checklist

  1. I have read the Contributing Guide
  2. I have written documents and tests, if needed.
changeset-bot[bot] commented 5 months ago

🦋 Changeset detected

Latest commit: eb1e80ea3f6964193e652d3353384cb331baebe6

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

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

vercel[bot] commented 5 months ago

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

Name Status Preview Comments Updated (UTC)
es-hangul ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 4, 2024 10:41am
manudeli commented 4 months ago

@po4tion https://github.com/toss/es-hangul/issues/121 일관된 이름짓기 규칙이 만들어지고 이 기능이 추가되는 것이 맞다고 생각해서 남깁니다. 이슈에서 같이 논의해주시면 좋을 것 같아요

codecov-commenter commented 4 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 99.79%. Comparing base (d58ba15) to head (59c79fd).

Additional details and impacted files [![Impacted file tree graph](https://app.codecov.io/gh/toss/es-hangul/pull/115/graphs/tree.svg?width=650&height=150&src=pr&token=My9jTW6bSr&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=toss)](https://app.codecov.io/gh/toss/es-hangul/pull/115?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=toss) ```diff @@ Coverage Diff @@ ## main #115 +/- ## ========================================== + Coverage 99.60% 99.79% +0.18% ========================================== Files 16 20 +4 Lines 255 494 +239 Branches 56 131 +75 ========================================== + Hits 254 493 +239 Misses 1 1 ```
okinawaa commented 3 months ago

conflic도 해결 부탁드립니당! 🙏

po4tion commented 3 months ago

@okinawaa conflict 해결하였습니다.

po4tion commented 3 months ago

@okinawaa conflict 해결하였습니다.