feat: 문자열에서 한글만 반환하는 extractHangul을 구현합니다. #130

Collection50 · 2024-06-23T16:56:16Z

Overview

문자열에서 한글만 반환하는 extractHangul 을 구현합니다. #108

extractHangul('안녕하세요1234abc'); // '안녕하세요'
extractHangul('abcde'); // ''
extractHangul('안녕하세요ㄱㄴ'); // '안녕하세요ㄱㄴ'
extractHangul('안녕하세요    만나서 반갑습니다'); // '안녕하세요    만나서 반갑습니다'
extractHangul('가나다!-29~라마바.,,사'); // '가나다라마바사'

고민점

\s 정규표현식을 통해 \n과 같은 escape 문자열은 한글로 인식되어 처리하고 있습니다.
escape 문자열도 필터링할 지에 대해 고민 후, 한글과 혼용되어 사용될 것이라 생각하고 필터링하지 않았습니다.
이부분에 대해 의견주시면 감사하겠습니다 !

PR Checklist

I read and included theses actions below

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

changeset-bot · 2024-06-23T16:56:20Z

🦋 Changeset detected

Latest commit: f8ef0b9

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 · 2024-06-23T16:56:20Z

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

Name	Status	Preview	Comments	Updated (UTC)
es-hangul	❌ Failed (Inspect)			Jun 29, 2024 2:17pm

codecov-commenter · 2024-06-23T16:58:06Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.80%. Comparing base (b25fcc5) to head (1d3df38).

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #130   +/-   ##
=======================================
  Coverage   98.79%   98.80%           
=======================================
  Files          15       16    +1     
  Lines         249      251    +2     
  Branches       55       55           
=======================================
+ Hits          246      248    +2     
  Misses          3        3

manudeli · 2024-06-24T11:57:14Z

src/parseHangul.ts

+ * parseHangul('가나다!-29~라마바.,,사') // '가나다라마바사'
+ */
+
+export function parseHangul(str: string): string {


@okinawaa #121 이름짓기 이슈가 해결되고 승인되면 좋겠습니다
@Collection50 같이 이슈 봐주시면 좋겠어요

@manudeli #121 이슈에 의견이 필요하다는 말씀일까요??

네 맞아요 ~Hangul을 사용할 것인지 말것인지에 대한 의견이 필요해요

crucifyer · 2024-06-24T16:48:59Z

이 함수 명칭은 removeUnHangul 같은 지운다는 뜻을 포함했으면 좋겠습니다.

정규식에서 + 는 큰 단위의 반복을 줄여 성능을 높이는 효과가 있습니다.
bench: https://jsfiddle.net/crucify/g74b5d1h/

ps. 저 식대로면 ㅠㅠ 같은 문자도 지워지는데 함수의 역할이 무엇인가요?

okinawaa · 2024-06-24T16:54:18Z

이 함수 명칭은 removeUnHangul 같은 지운다는 뜻을 포함했으면 좋겠습니다.

이 부분에 동의하여, 한글을 지운다는 맥락을 설명할 수 있는 함수명, 혹은 주석에 "한글을 추출" 한다고 작성해주신것을 따라 extractHangul 정도는 어떨까요? 현재 parseHangul이 약간 함수의 동작을 정확히 설명하기에 모호하다고 생각이 들어서요. !

okinawaa · 2024-06-24T16:56:53Z

escape 문자열도 필터링할 지에 대해 고민 후, 한글과 혼용되어 사용될 것이라 생각하고 필터링하지 않았습니다.

이 부분은 현재 구현대로 띄어쓰기는 삭제하지 않는 것이 좋을 것 같아요~ 라이브러리를 사용하는쪽에서 정말 띄어쓰기를 삭제하고 싶으면 사용하는 쪽에서 제어할 것 이라고 생각해요

Collection50 · 2024-06-25T01:09:27Z

@crucifyer 피드백 해주셔서 감사합니다 !

Collection50 · 2024-06-25T01:10:06Z

@okinawaa

이 부분에 동의하여, 한글을 지운다는 맥락을 설명할 수 있는 함수명, 혹은 주석에 "한글을 추출" 한다고 작성해주신것을 따라 extractHangul 정도는 어떨까요? 현재 parseHangul이 약간 함수의 동작을 정확히 설명하기에 모호하다고 생각이 들어서요. !

테스트 코드 보완과 함께 수정 완료 했습니다 !

okinawaa · 2024-06-29T11:41:12Z

src/extractHangul.spec.ts

@@ -0,0 +1,51 @@
+import { extractHangul } from './extractHangul';
+
+describe('extractHangul 함수 테스트', () => {


일관성을 유지하기 위해서 , 함수 테스트 글자를 지우는것은 어떨까요?

Suggested change

describe('extractHangul 함수 테스트', () => {

describe('extractHangul', () => {

okinawaa · 2024-06-29T11:42:35Z

src/extractHangul.spec.ts

+  it('숫자와 알파벳 추출', () => {
+    expect(extractHangul('안녕하세요1234abc!@#')).toBe('안녕하세요');
+  });
+
+  it('한글이 없는 문자열', () => {
+    expect(extractHangul('1234abc')).toBe('');
+  });
+
+  it('한글과 공백만 남기고 다른 문자는 추출', () => {
+    expect(extractHangul('한글과 영어가 섞인 문장입니다. Hello!')).toBe('한글과 영어가 섞인 문장입니다 ');
+  });
+
+  it('특수문자 추출', () => {
+    expect(extractHangul('특수문자!@#가 들어간 경우')).toBe('특수문자가 들어간 경우');
+  });
+
+  it('숫자와 특수문자 추출', () => {
+    expect(extractHangul('숫자1234와 특수문자!@# 추출')).toBe('숫자와 특수문자 추출');
+  });
+
+  it('공백 유지', () => {
+    expect(extractHangul('공백도 유지됩니다    이렇게')).toBe('공백도 유지됩니다    이렇게');
+  });
+


추후 다른 PR에서 작업되도 좋겠습니다,
현재 it구문이 너무 병렬적으로 나와있으니 인지적으로 힘든 것 같아요.
비슷한 맥락인 것들은 describe 메서드를 사용해 한번 grouping해주면 좋을 것 같아요

넵 추가적인 PR 만들겠습니다 !

okinawaa

extractHangul에 대한 문서 작업도 진행해주시면 감사하겠습니다.
API가 실제로 추가되는것이기때문에 문서에서도 표현되었으면 좋겠어요!

okinawaa · 2024-06-29T13:45:55Z

src/extractHangul.spec.ts

+import { extractHangul } from './extractHangul';
+
+describe('extractHangul', () => {
+  it('숫자와 알파벳 추출', () => {


숫자

Suggested change

it('숫자와 알파벳 추출', () => {

it('숫자와 알파벳과 특수문자를 제외한 한글 추출', () => {

okinawaa · 2024-06-29T13:46:59Z

src/extractHangul.spec.ts

+
+  it('한글과 공백만 남기고 다른 문자는 추출', () => {
+    expect(extractHangul('한글과 영어가 섞인 문장입니다. Hello!')).toBe('한글과 영어가 섞인 문장입니다 ');
+  });
+
+  it('특수문자 추출', () => {
+    expect(extractHangul('특수문자!@#가 들어간 경우')).toBe('특수문자가 들어간 경우');
+  });
+
+  it('숫자와 특수문자 추출', () => {
+    expect(extractHangul('숫자1234와 특수문자!@# 추출')).toBe('숫자와 특수문자 추출');
+  });


한글을 추출하여, return값으로 주는것이기때문에
한글을 추출하고, 다른건 제외한다는 표현을 사용하면 좋을 것 같아요

Collection50 · 2024-06-29T14:03:26Z

@okinawaa
중복되는 테스트 코드를 삭제하여 가독성 향상했습니다 !
문서 작성 완료했습니다 !

okinawaa · 2024-06-29T14:10:11Z

src/extractHangul.ts

+ * extractHangul('가나다!-29~라마바.,,사') // '가나다라마바사'
+ */
+
+export function extractHangul(str: string): string {


실제 사용할 수 있도록 src/index.ts에서 export 해주시면 좋을 것 같아요

완료했습니다 ! 감사합니다 !

okinawaa

긴 작업 감사합니다!

* feat: parseHangul * fix: parseHangul의 이름을 extractHangul로 수정 및 테스트 코드 보완 * test: 일관된 테스트 코드 작성이 될 수 있도록 describe 설명 수정 * test: 테스트 코드 수정 * docs: extractHangul의 문서 작성 * test: 테스트 문구 수정 * fix: index.ts에 export 추가 * Create fresh-students-sit.md --------- Co-authored-by: 박찬혁 <[email protected]>

* fix. 겹모음과 관련된 이상 현상들 수정 * fix. fix index * fix. 오타 수정 Co-authored-by: 박찬혁 <[email protected]> * fix. 오타 수정 Co-authored-by: 박찬혁 <[email protected]> * fix. 업데이트 로직 반영 * test: internal 테스트 코드를 작성합니다 (#137) * test: internal 테스트 코드를 작성합니다 * test: vitest에서 제공해주는 toThrowError로 변경 --------- Co-authored-by: 박찬혁 <[email protected]> * docs: josa에 관련된 문서에 잘못된 부분을 수정합니다 - '이에/에' 삭제 Co-authored-by: 박찬혁 <[email protected]> * chore: version packages (#143) Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> * feat: 한글 문자열에 대한 검증, assert, parsing 함수를 구현합니다. (#136) * feat: 한글 문자열인지 boolean 반환 함수 * feat: 한글 문자열인지 assert 함수 * feat: stringify * test: isHangulString, assertHangulString 테스트 코드 * feat: parse 함수 * test: parse 함수 테스트 * refactor: naming 통일 * feat : 문장의 각 단어 중 첫 문자만 뽑는 함수추가 ( #128 이슈에 대한 ) (#133) * feat : 문장의 각 단어 중 첫 문자만 뽑는 함수추가 * test 및 함수 추가 * add : 한글 문장인지 여부 판별 함수 추가 * fix : 한글 문장인지 여부 판별 기저 및 오류 추가 / arg 이름 변경 test 추가 * fix: src/_internal/hangul.ts Co-authored-by: 박찬혁 <[email protected]> * fix : rename function getFirstHangulLetters -> getHangulAcronym * fix : rename function export function isHangulOnly로 변경 * fix : lint error * fix : index에 추가 * chore : doc 추가 * fix : 문서화 한글 영어 바뀐거 바로 변경 * fix : isHangul로 대체 #136 으로 * chore : doc수정 * Update docs/src/pages/docs/api/getHangulAcronym.en.mdx Co-authored-by: 박찬혁 <[email protected]> * fix : Update hangul.ts 안쓰는 메소드 삭제 * Update getHangulAcronym.ko.mdx * Update getHangulAcronym.en.mdx * Update src/getHangulAcronym.ts Co-authored-by: 박찬혁 <[email protected]> * Update src/getHangulAcronym.ts Co-authored-by: 박찬혁 <[email protected]> * Update getHangulAcronym.ts * Update getHangulAcronym.spec.ts * Create fair-brooms-drive.md --------- Co-authored-by: 박찬혁 <[email protected]> * chore: version packages (#145) Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> * feat: 문자열에서 한글만 반환하는 extractHangul을 구현합니다. (#130) * feat: parseHangul * fix: parseHangul의 이름을 extractHangul로 수정 및 테스트 코드 보완 * test: 일관된 테스트 코드 작성이 될 수 있도록 describe 설명 수정 * test: 테스트 코드 수정 * docs: extractHangul의 문서 작성 * test: 테스트 문구 수정 * fix: index.ts에 export 추가 * Create fresh-students-sit.md --------- Co-authored-by: 박찬혁 <[email protected]> * chore: version packages (#146) Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> * fix : getHangulacronym함수를 acronymizeHangul 메서드로 대체합니다. (#148) * Update and rename getHangulAcronym.ts to acronymizeHangul.ts * Update and rename getHangulAcronym.spec.ts to acronymizeHangul.spec.ts * Update index.ts * Update and rename getHangulAcronym.en.mdx to acronymizeHangul.en.mdx * Update and rename getHangulAcronym.ko.mdx to acronymizeHangul.ko.mdx * Create odd-squids-sin.md --------- Co-authored-by: 박찬혁 <[email protected]> * chore: version packages (#150) Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> * fix: amountToHangul이 소수점, 숫자도 대응할 수 있도록 수정 (#144) * fix: amountToHangul이 소수점, 숫자도 대응할 수 있도록 수정 * docs: amountToHangul의 영어 문서 작성 * Create famous-cheetahs-sneeze.md * Update famous-cheetahs-sneeze.md --------- Co-authored-by: 박찬혁 <[email protected]> * fix: packlint ESLint error (#149) * test: utils 기능들의 테스트 케이스를 개선합니다 (#151) * test: hasBatchim 함수의 테스트 케이스를 추가합니다 * test: hasSingleBatchim의 테스트 케이스를 추가합니다 * fix: nextra theme asset 개선 (#152) * chore: version packages (#153) Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> * fix: 패키지가 노출하는 인터페이스를 명확히 하기 위해 index.ts를 named export로 수정합니다 (#157) * fix: exposing public apis strictly * Create wild-cows-juggle.md * chore: version packages (#160) Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> * docs: CONTRIBUTING.md 파일에 메서드 컨벤션을 작성합니다. (#132) * Update CONTRIBUTING.md * fix * write contribution.md Co-authored-by: Jonghyeon Ko <[email protected]> Co-authored-by: Dongkyu Kim <[email protected]> * Update .github/CONTRIBUTING.md Co-authored-by: Jonghyeon Ko <[email protected]> * Update .github/CONTRIBUTING.md Co-authored-by: Jonghyeon Ko <[email protected]> * Update .github/CONTRIBUTING.md Co-authored-by: Jonghyeon Ko <[email protected]> --------- Co-authored-by: Jonghyeon Ko <[email protected]> Co-authored-by: Dongkyu Kim <[email protected]> Co-authored-by: Jonghyeon Ko <[email protected]> * test: amountToHangul 테스트 추가 (#135) * test: amountToHangul 테스트 추가 * test: amountToHangul 테스트 코드 수정 * test: amountToHangul 테스트 코드 스타일 변경 * test: amountToHangul test 개선 * fix: assert.throws대신 vitest toThrow로 메서드 변경 * fix: vitest toThrowError 메서드로 변경 --------- Co-authored-by: kinndohyun <[email protected]> Co-authored-by: 박찬혁 <[email protected]> * fix: 소수점 추가 후 발생한 '영'읽기 버그 수정 (#159) * fix: 소수점 추가 후 발생한 '영'읽기 버그 수정 * Create big-cups-call.md --------- Co-authored-by: 박찬혁 <[email protected]> * docs: acronymizeHangul 리턴 타입 표기 수정 (#161) * chore: version packages (#163) Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> * fix: 일관된 toThrowError 메서드 사용 (#166) Co-authored-by: kinndohyun <[email protected]> * chore(eslint): 의도치 않은 naming을 제거하기 위해 cspell 추가 (#164) * chore(eslint): add cspell to check bad naming * chore: update * Create grumpy-singers-love.md --------- Co-authored-by: 박찬혁 <[email protected]> Co-authored-by: Dongkyu Kim <[email protected]> Co-authored-by: Jaemin Kim <[email protected]> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: seunghee <[email protected]> Co-authored-by: taehyun <[email protected]> Co-authored-by: SeongMin Kim <[email protected]> Co-authored-by: Jonghyeon Ko <[email protected]> Co-authored-by: Jonghyeon Ko <[email protected]> Co-authored-by: Dongkyu Kim <[email protected]> Co-authored-by: 김도현 <[email protected]> Co-authored-by: kinndohyun <[email protected]> Co-authored-by: Song Hyo Jin <[email protected]> Co-authored-by: wnhlee <[email protected]>

feat: parseHangul

5e81807

Collection50 requested review from okinawaa and raon0211 as code owners June 23, 2024 16:56

vercel bot had a problem deploying to Preview June 23, 2024 16:56 Failure

manudeli reviewed Jun 24, 2024

View reviewed changes

Collection50 mentioned this pull request Jun 24, 2024

[Feature] 일관된 이름 짓기 규칙 #121

Closed

fix: parseHangul의 이름을 extractHangul로 수정 및 테스트 코드 보완

fca8a59

vercel bot had a problem deploying to Preview June 25, 2024 01:09 Failure

manudeli changed the title ~~feat: 문자열에서 한글만 반환하는 parseHangul을 구현합니다.~~ feat: 문자열에서 한글만 반환하는 extractHangul을 구현합니다. Jun 25, 2024

okinawaa reviewed Jun 29, 2024

View reviewed changes

test: 일관된 테스트 코드 작성이 될 수 있도록 describe 설명 수정

c49d256

vercel bot had a problem deploying to Preview June 29, 2024 13:01 Failure

okinawaa requested changes Jun 29, 2024

View reviewed changes

okinawaa reviewed Jun 29, 2024

View reviewed changes

Collection50 added 2 commits June 29, 2024 23:02

test: 테스트 코드 수정

ee9b012

docs: extractHangul의 문서 작성

ce8e175

vercel bot had a problem deploying to Preview June 29, 2024 14:03 Failure

test: 테스트 문구 수정

3bf4fba

vercel bot had a problem deploying to Preview June 29, 2024 14:09 Failure

okinawaa reviewed Jun 29, 2024

View reviewed changes

Collection50 and others added 2 commits June 29, 2024 23:11

fix: index.ts에 export 추가

f7b29f2

Merge branch 'main' into feat/parseHangul

1d3df38

vercel bot had a problem deploying to Preview June 29, 2024 14:12 Failure

Create fresh-students-sit.md

f8ef0b9

okinawaa approved these changes Jun 29, 2024

View reviewed changes

okinawaa merged commit acd6edb into toss:main Jun 29, 2024
2 of 10 checks passed

vercel bot had a problem deploying to Preview June 29, 2024 14:17 Failure

github-actions bot mentioned this pull request Jun 29, 2024

chore: version packages #146

Merged

okinawaa mentioned this pull request Jun 29, 2024

[Feature]: 문자열에서 한글만 파싱 #108

Closed

Collection50 mentioned this pull request Jul 1, 2024

docs: CONTRIBUTING.md 파일에 메서드 컨벤션을 작성합니다. #132

Merged

1 task

okinawaa mentioned this pull request Jul 12, 2024

feat: 문자열에서 한글을 추출해주는 extractHangul 함수를 제거합니다 #185

Merged

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: 문자열에서 한글만 반환하는 extractHangul을 구현합니다. #130

feat: 문자열에서 한글만 반환하는 extractHangul을 구현합니다. #130

Collection50 commented Jun 23, 2024 •

edited by manudeli

Loading

changeset-bot bot commented Jun 23, 2024 •

edited

Loading

vercel bot commented Jun 23, 2024 •

edited

Loading

codecov-commenter commented Jun 23, 2024 •

edited

Loading

manudeli Jun 24, 2024 •

edited

Loading

Collection50 Jun 24, 2024

manudeli Jun 24, 2024

crucifyer commented Jun 24, 2024

okinawaa commented Jun 24, 2024

okinawaa commented Jun 24, 2024

Collection50 commented Jun 25, 2024

Collection50 commented Jun 25, 2024

okinawaa Jun 29, 2024

Collection50 Jun 29, 2024

okinawaa Jun 29, 2024

Collection50 Jun 29, 2024

okinawaa left a comment

okinawaa Jun 29, 2024 •

edited

Loading

okinawaa Jun 29, 2024

Collection50 commented Jun 29, 2024

okinawaa Jun 29, 2024

Collection50 Jun 29, 2024

okinawaa left a comment

		@@ -0,0 +1,51 @@
		import { extractHangul } from './extractHangul';

		describe('extractHangul 함수 테스트', () => {

	describe('extractHangul 함수 테스트', () => {
	describe('extractHangul', () => {

	it('숫자와 알파벳 추출', () => {
	it('숫자와 알파벳과 특수문자를 제외한 한글 추출', () => {

feat: 문자열에서 한글만 반환하는 extractHangul을 구현합니다. #130

feat: 문자열에서 한글만 반환하는 extractHangul을 구현합니다. #130

Conversation

Collection50 commented Jun 23, 2024 • edited by manudeli Loading

Overview

고민점

PR Checklist

changeset-bot bot commented Jun 23, 2024 • edited Loading

🦋 Changeset detected

vercel bot commented Jun 23, 2024 • edited Loading

codecov-commenter commented Jun 23, 2024 • edited Loading

Codecov Report

manudeli Jun 24, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

crucifyer commented Jun 24, 2024

okinawaa commented Jun 24, 2024

okinawaa commented Jun 24, 2024

Collection50 commented Jun 25, 2024

Collection50 commented Jun 25, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

okinawaa left a comment

Choose a reason for hiding this comment

okinawaa Jun 29, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Collection50 commented Jun 29, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

okinawaa left a comment

Choose a reason for hiding this comment

Collection50 commented Jun 23, 2024 •

edited by manudeli

Loading

changeset-bot bot commented Jun 23, 2024 •

edited

Loading

vercel bot commented Jun 23, 2024 •

edited

Loading

codecov-commenter commented Jun 23, 2024 •

edited

Loading

manudeli Jun 24, 2024 •

edited

Loading

okinawaa Jun 29, 2024 •

edited

Loading