feat : 문장의 각 단어 중 첫 문자만 뽑는 함수추가 ( #128 이슈에 대한 ) #133

KNU-K · 2024-06-25T06:55:48Z

feat : 문장의 각 단어 중 첫 문자만 뽑는 함수추가

test 및 함수 추가

issue 를 보고 해당 PR을 추가하게되었습니다

Overview

문장 내에서 단어의 첫 문자만 뽑는 함수를 추가하였습니다.

PR Checklist

I read and included theses actions below

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

* test 및 함수 추가

changeset-bot · 2024-06-25T06:55:52Z

🦋 Changeset detected

Latest commit: 3ffcd89

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-25T06:55:52Z

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 1:51pm

po4tion · 2024-06-27T17:44:10Z

src/getFirstHangulLetters.ts

+export function getFirstHangulLetters(str: string) {
+ const words = str.split(' ');
+
+ const firstHangulLetters = words.map(word => word.charAt(0));
+
+ return firstHangulLetters;
+}


매개변수가 한글인지 검증하는 로직이 필요하지 않을까요? 지금은 한글이 아니더라도 반환을 해주는데요. 함수명과 기능이 불일치하는 것 같아요. 그리고 매개변수명은 str말고 더 직관적인 이름이 있을 것 같아요!

넵 정정해보겠습니다.

test 추가

KNU-K · 2024-06-28T18:05:58Z

@po4tion 추가했습니다. 확인 부탁드립니다.

okinawaa · 2024-06-29T11:50:36Z

src/getFirstHangulLetters.ts

+/**
+ *
+ * @param getFirstHangulLetters
+ * @description
+ * 한글 문장을 입력받아서, 해당 한글 문장의 초성을을 리턴해줍니다.
+ * 한글 문장이 아닌, 문장은 취급하지않습니다. 추가로 한글 문장 + 영어 문장의 경우에도 취급하지않습니다.
+ */
+export function getFirstHangulLetters(text: string) {


메서드가 하는 역할에 비해서, 메서드이름이 약간 일반적(general)이라고 생각했는데요,
왜냐하면 메서드 이름만 보고 띄어쓰기를 기준으로 나누고, 가장 앞의 글자들을 가져온다는것을 예측하기 힘들 것 같아요. 한번 고민해보겠습니다!

메서드 이름을 getHangulAbbreviation() 나 getHangulAcronym()은 어떨까요?

extractFirstHangulFromWords()과 extractFirstHangul() 도 고려하고 있습니다.

word들에서 첫번째 한글을 추출해서 list 로 return 해주는게 기능이라 해당 이름도 좋을 것 같습니다.

꽤나 유용할 것 같은 기능으로 생각됩니다. @okinawaa

너무 좋은 함수명들이네요, getHangulAcronym 이것이 오해의 소지 없이 정확히 함수의 역할을 설명하고 있는것 같아서, 사용하면 좋을 것 같은데 @KNU-K 님께서는 어떠신가요~?

getHangulAcronym로 바로 수정하겠습니다.

@okinawaa 제가 진행하겠습니다!

앗 감사합니다..!! 연관된 파일 모두 챙겨주시면 감사하겠습니다~!

#129 이부분 진행할까하는데, 혹시 진행하면서 PR에 포함시켜도 될까요??
@okinawaa

명확히 다른기능이라, 두 가지 다른 PR로 진행하였으면 해요

src/_internal/hangul.ts

Co-authored-by: 박찬혁 <[email protected]>

getFirstHangulLetters -> getHangulAcronym

export function isHangulOnly로 변경

okinawaa

아래와 같은 lint오류 세가지가 발생하고 있어서, 해결부탁드립니다

KNU-K

수정했습니다

docs/src/pages/docs/api/getHangulAcronym.en.mdx

Co-authored-by: 박찬혁 <[email protected]>

okinawaa · 2024-06-29T13:34:43Z

src/getHangulAcronym.ts

+ if (!isHangul(text)) {
+ throw new Error('Invalid Hangul text, please input Hangul text only.');
+ }


parseHangul을 사용하면 내부적으로 에러처리까지해줘서 더 좋을 것 같아요

src/getHangulAcronym.ts

안쓰는 메소드 삭제

Co-authored-by: 박찬혁 <[email protected]>

okinawaa

긴 작업 감사합니다 🚀

codecov-commenter · 2024-06-29T13:52:00Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.79%. Comparing base (f0195b2) to head (3ffcd89).

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #133   +/-   ##
=======================================
  Coverage   98.78%   98.79%           
=======================================
  Files          14       15    +1     
  Lines         247      249    +2     
  Branches       55       55           
=======================================
+ Hits          244      246    +2     
  Misses          3        3

KNU-K · 2024-06-29T13:53:12Z

@okinawaa 감사합니다.

* 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로 대체 toss#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]>

feat : 문장의 각 단어 중 첫 문자만 뽑는 함수추가

c811e8d

* test 및 함수 추가

KNU-K requested review from okinawaa and raon0211 as code owners June 25, 2024 06:55

vercel bot had a problem deploying to Preview June 25, 2024 06:56 Failure

KNU-K mentioned this pull request Jun 25, 2024

[Feature]: 문장의 각 단어 중 첫 문자만 뽑는 함수 #128

Closed

po4tion reviewed Jun 27, 2024

View reviewed changes

KNU-K added 2 commits June 29, 2024 03:04

add : 한글 문장인지 여부 판별 함수 추가

2b7fbd4

fix : 한글 문장인지 여부 판별 기저 및 오류 추가 / arg 이름 변경

cc53591

test 추가

vercel bot had a problem deploying to Preview June 28, 2024 18:05 Failure

KNU-K requested a review from po4tion June 28, 2024 18:11

okinawaa reviewed Jun 29, 2024

View reviewed changes

src/_internal/hangul.ts Outdated Show resolved Hide resolved

fix: src/_internal/hangul.ts

dcecb15

Co-authored-by: 박찬혁 <[email protected]>

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

KNU-K requested a review from okinawaa June 29, 2024 12:39

KNU-K added 3 commits June 29, 2024 21:50

fix : rename function

b31a5b3

getFirstHangulLetters -> getHangulAcronym

fix : rename function

2e2b134

export function isHangulOnly로 변경

Merge branch 'main' of https://github.com/KNU-K/es-hangul

ea4cb1b

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

Merge branch 'main' into main

83fd467

okinawaa requested changes Jun 29, 2024

View reviewed changes

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

KNU-K added 2 commits June 29, 2024 21:57

fix : lint error

7bd33ed

Merge branch 'main' of https://github.com/KNU-K/es-hangul

fffd30e

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

KNU-K requested a review from okinawaa June 29, 2024 12:59

KNU-K commented Jun 29, 2024

View reviewed changes

okinawaa reviewed Jun 29, 2024

View reviewed changes

docs/src/pages/docs/api/getHangulAcronym.en.mdx Outdated Show resolved Hide resolved

Update docs/src/pages/docs/api/getHangulAcronym.en.mdx

8079b7d

Co-authored-by: 박찬혁 <[email protected]>

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

okinawaa reviewed Jun 29, 2024

View reviewed changes

src/getHangulAcronym.ts Outdated Show resolved Hide resolved

okinawaa reviewed Jun 29, 2024

View reviewed changes

src/getHangulAcronym.ts Outdated Show resolved Hide resolved

fix : Update hangul.ts

e409273

안쓰는 메소드 삭제

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

KNU-K added 2 commits June 29, 2024 22:40

Update getHangulAcronym.ko.mdx

4e4e5bd

Update getHangulAcronym.en.mdx

c6f1bc4

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

KNU-K and others added 2 commits June 29, 2024 22:41

Update src/getHangulAcronym.ts

ba3ed2a

Co-authored-by: 박찬혁 <[email protected]>

Update src/getHangulAcronym.ts

00b3560

Co-authored-by: 박찬혁 <[email protected]>

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

Update getHangulAcronym.ts

b7dd6a7

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

Update getHangulAcronym.spec.ts

a36ab58

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

KNU-K requested a review from okinawaa June 29, 2024 13:48

okinawaa previously approved these changes Jun 29, 2024

View reviewed changes

Create fair-brooms-drive.md

3ffcd89

okinawaa dismissed their stale review via 3ffcd89 June 29, 2024 13:50

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

okinawaa approved these changes Jun 29, 2024

View reviewed changes

okinawaa merged commit b0e1184 into toss:main Jun 29, 2024
8 of 9 checks passed

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

chore: version packages #145

Merged

KNU-K mentioned this pull request Jun 29, 2024

fix : getHangulacronym함수를 acronymizeHangul 메서드로 대체합니다. #148

Merged

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat : 문장의 각 단어 중 첫 문자만 뽑는 함수추가 ( #128 이슈에 대한 ) #133

feat : 문장의 각 단어 중 첫 문자만 뽑는 함수추가 ( #128 이슈에 대한 ) #133

KNU-K commented Jun 25, 2024 •

edited

Loading

changeset-bot bot commented Jun 25, 2024 •

edited

Loading

vercel bot commented Jun 25, 2024 •

edited

Loading

po4tion Jun 27, 2024

KNU-K Jun 28, 2024

KNU-K commented Jun 28, 2024

okinawaa Jun 29, 2024

KNU-K Jun 29, 2024

KNU-K Jun 29, 2024

okinawaa Jun 29, 2024

KNU-K Jun 29, 2024

KNU-K Jun 29, 2024

okinawaa Jun 29, 2024

KNU-K Jun 29, 2024

okinawaa Jun 29, 2024

KNU-K Jun 29, 2024

okinawaa left a comment

KNU-K left a comment

okinawaa Jun 29, 2024

okinawaa left a comment

codecov-commenter commented Jun 29, 2024

KNU-K commented Jun 29, 2024

feat : 문장의 각 단어 중 첫 문자만 뽑는 함수추가 ( #128 이슈에 대한 ) #133

feat : 문장의 각 단어 중 첫 문자만 뽑는 함수추가 ( #128 이슈에 대한 ) #133

Conversation

KNU-K commented Jun 25, 2024 • edited Loading

Overview

PR Checklist

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

🦋 Changeset detected

vercel bot commented Jun 25, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

KNU-K commented Jun 28, 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

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

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

KNU-K left a 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

codecov-commenter commented Jun 29, 2024

Codecov Report

KNU-K commented Jun 29, 2024

KNU-K commented Jun 25, 2024 •

edited

Loading

changeset-bot bot commented Jun 25, 2024 •

edited

Loading

vercel bot commented Jun 25, 2024 •

edited

Loading