fix: 일관된 한글 표기법 적용 #138

Collection50 · 2024-06-26T16:28:42Z

Overview

[Feature]: 초성, 종성, 중성에 일관된 변수명을 사용하기 #131 를 해결했습니다.

문서(docs)에는 chosung으로 안내하도록 수정했습니다.
외부로 노출되는 초성, 종성, 중성의 함수 인터페이스는 sung~, seong~을 혼용했고, sung~ 함수에 @deprecated를 적용했습니다.
내부에서만 사용하거나 테스트 코드의 경우에는 용이한 마이그레이션을 위해 seong을 사용했습니다.

PR Checklist

I read and included theses actions below

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

close #131

changeset-bot · 2024-06-26T16:28:46Z

🦋 Changeset detected

Latest commit: 44db24e

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-26T16:28:46Z

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

Name	Status	Preview	Comments	Updated (UTC)
es-hangul	❌ Failed (Inspect)			Jul 12, 2024 3:47pm

okinawaa · 2024-06-29T11:32:49Z

src/index.ts

@@ -1,5 +1,5 @@
 export * from './assemble';
-export * from './chosungIncludes';
+export * from './choseongIncludes';


아직 BC를 발생시키기 전이기때문에,
chosungIncludes는 라이브러리를 사용하는 사람들이 안전하게 사용하도록 chosungIncludes, choseongIncludes 을 동시에 export 해주고,

2버전으로 넘어갈때, chosungIncludes를 제거하는것은 어떤가요?
그전에 chosungIncludes 에 jsdoc으로 deprecated 주석을 남겨두는것도 좋을 것 같아요

chosung~ 버전의 함수와 choseong~ 버전의 함수가 일단 공존하는게 좋다는 말씀일까요??
만약 말씀을 잘 이해한 것이라면 2개 버전의 함수가 모두 존재하고, export도 하는 것으로 작업하겠습니다 !!

네네 맞습니다! 오픈소스이다보니,
major update를 하지않았는데도 불구하고, 유저가 서비스의 코드를 수정해야하는상황을 막고 싶었어요!

네 알겠습니다 !

👍👍👍

chosungIncludes에는 jsdoc으로 deprecated와 choseongIncludes로 사용할 수 있게 처리해주시면 감사하겠습니다

okinawaa · 2024-07-03T06:32:05Z

docs/src/components/demo/choseong-includes-demo.tsx

@@ -1,7 +1,7 @@
 import React, { useState } from 'react';
 import { chosungIncludes } from 'es-hangul';

-export function ChosungIncludesDemo() {
+export function chosungIncludesDemo() {
  const [searchWord, setSearchWord] = useState<string>('홍길동');


이거 소문자로 바꾸신 이유가 있으신가요?
이 부분도 sung이 아닌, seong이 되면 좋겠어요!

네 알겠습니다 ! 👍

해당 PR에서 hangul을 제외하는 것도 진행해도 괜찮은지 여쭙고 싶습니다 !
만약 PR을 분리해야 한다면, 제가 맡고 싶습니다 :)

PR을 분리하면 좋을 것 같아요!
맡아주신다니 영광입니다, BC가 없도록 두가지 메서드씩 모두 살려두는 방향으로 작업해주시면 좋을 것 같아요!

sung => seong 이 작업 및 컨플리긑 해결 부탁드립니다 🙏

완료했습니다 !

Collection50 · 2024-07-05T09:18:05Z

안녕하세요 ! @okinawaa

Jongsung, Chosung 등을 사용할 수 없다고 오류가 발생해요 !
해결 방법을 알려주시면 적용하겠습니다 !

minsoo-web

아직 *sung 으로 남는 표기가 많은 것 같아요..! 확인 한 번 부탁드립니다!

또한 eslint 에러로 표기되는 이슈는 #172 이 merge 되면 warning 으로 반영된다는 점 참고 부탁드립니다!

minsoo-web · 2024-07-05T12:58:08Z

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

deprecated 되었다는 표기를 남기고 새로운 문서를 만드는 것이 좋지 않을까요? 🤔
패키지 상에서는 deprecated 인데, 문서는 없어지는 것이 우려됩니다.

리뷰해주셔서 감사합니다 ! @minsoo-web

chosungIncludes는 라이브러리를 사용하는 사람들이 안전하게 사용하도록 chosungIncludes, choseongIncludes 을 동시에 export 해주고,

chosung~과 choseong~ 모두 작성하는 것으로 위 문장을 이해했는데 잘못 이해한 부분이 있다면 말씀해주시면 감사하겠습니다 !

새로운 문서를 만드는 것이 좋지 않을까요? 🤔

문서 또한 chosung~과 choseong~ 모두 작성하는 것으로 진행할까요??

chosung~~과 choseong~~ 모두 작성하는 것으로 위 문장을 이해했는데 잘못 이해한 부분이 있다면 말씀해주시면 감사하겠습니다 !

네네! 같은 방향으로 이해한 것 같습니다.
다만, chosung 이 잘못된 표기니까, deprecated 처리 하되 문서는 url이 chosung 이 포함된 url 이 있다면, choseong 으로 이동할 수 있도록 가이드 하면 어떨까요?

예시)
기존:
https://es-hangul.slash.page/docs/api/chosungIncludes

변경 후:
https://es-hangul.slash.page/docs/api/chosungIncludes (deprecated) > choseongIncludes 를 사용해주세요!
https://es-hangul.slash.page/docs/api/choseongInclues

이런 느낌이죠!!

아니면, deprecated features 라는 페이지를 만들어서 기재해두어도 괜찮을 것 같아요!
ref: https://v2.chakra-ui.com/getting-started/migration#5-deprecated-features

넵 알겠습니다 !

chosung은 deprecated 처리

chousng의 문서는 삭제하지 않고 choseong과 함께 존재

정리하자면 위와 같이 진행하면 되는 것일까요??

제가 바라는 방향성입니다!!
문의 주신 내용에 대해서는 @okinawaa 님이 답변 주시면 너무 좋을 것 같아요!!

제가 확답 드리지 못하는 이유는, 저는 메인테이너도 코드오너도 아니기 때문입니다 !!

넵 저도 @minsoo-web 님 의견 너무 좋습니다~ 문서도 살려두면 좋겠네요!

okinawaa · 2024-07-09T04:39:45Z

@Collection50

Jongsung, Chosung 등을 사용할 수 없다고 오류가 발생해요 !
해결 방법을 알려주시면 적용하겠습니다 !

#172 이 머지되어서 해결되었을 것 같아요! 감사합니다.

Collection50 · 2024-07-09T05:41:32Z

안녕하세요 @okinawaa !

작업 완료 했습니다 !

codecov-commenter · 2024-07-09T05:42:26Z

Codecov Report

Attention: Patch coverage is 92.30769% with 4 lines in your changes missing coverage. Please review.

Project coverage is 95.18%. Comparing base (135e419) to head (44db24e).

Additional details and impacted files

@@             Coverage Diff             @@
##              main     #138      +/-   ##
===========================================
- Coverage   100.00%   95.18%   -4.82%     
===========================================
  Files           16       17       +1     
  Lines          275      291      +16     
  Branches        66       67       +1     
===========================================
+ Hits           275      277       +2     
- Misses           0       13      +13     
- Partials         0        1       +1

okinawaa · 2024-07-12T14:55:32Z

src/index.ts에서 chosengIncludes를 export 해줘야할것 같아요

okinawaa · 2024-07-12T15:30:09Z

컨플릭트도 해결 부탁드릴게요!

okinawaa

긴 작업 정말 감사합니다!

okinawaa · 2024-07-12T15:37:13Z

_internal/src 쪽에서 CI 오류가 발생하고있어요.

Collection50 · 2024-07-12T16:02:35Z

_internal/src 쪽에서 CI 오류가 발생하고있어요.

해결했습니다 !

okinawaa

감사합니다!

* fix: 일관된 한글 표기법 적용 * fix: 기존의 함수를 유지한 채, deprecated 되도록 수정 * fix: main 브랜치와 merge를 위한 수정 * fix: conflict 수정 * fix: 문서에는 chosung prefix를 사용하도록 수정 * fix: ChoseongIncludesDemo 함수명 수정 * chore: cspell.json 으로 설정을 변경합니다. (#172) * fix: 일관된 한글 표기법 적용 * fix: 기존의 함수를 유지한 채, deprecated 되도록 수정 * docs: chosung~ 문서 작성 * fix: choseongIncludes의 인덱싱 처리 * Create fifty-wolves-melt.md * fix: import CI 오류 해결 --------- Co-authored-by: Minsoo Kim <[email protected]> Co-authored-by: 박찬혁 <[email protected]>

* docs * Update docs/src/pages/docs/introduction.ko.mdx Co-authored-by: Jonghyeon Ko <[email protected]> * Update docs/src/pages/index.ko.mdx Co-authored-by: Jonghyeon Ko <[email protected]> * chore: version packages (#183) Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> * fix: 일관된 한글 표기법 적용 (#138) * fix: 일관된 한글 표기법 적용 * fix: 기존의 함수를 유지한 채, deprecated 되도록 수정 * fix: main 브랜치와 merge를 위한 수정 * fix: conflict 수정 * fix: 문서에는 chosung prefix를 사용하도록 수정 * fix: ChoseongIncludesDemo 함수명 수정 * chore: cspell.json 으로 설정을 변경합니다. (#172) * fix: 일관된 한글 표기법 적용 * fix: 기존의 함수를 유지한 채, deprecated 되도록 수정 * docs: chosung~ 문서 작성 * fix: choseongIncludes의 인덱싱 처리 * Create fifty-wolves-melt.md * fix: import CI 오류 해결 --------- Co-authored-by: Minsoo Kim <[email protected]> Co-authored-by: 박찬혁 <[email protected]> * english * Update docs/src/pages/docs/introduction.ko.mdx Co-authored-by: Jonghyeon Ko <[email protected]> * english * Update docs/src/pages/index.ko.mdx * Update docs/src/pages/docs/introduction.ko.mdx --------- Co-authored-by: Jonghyeon Ko <[email protected]>

crucifyer · 2024-07-15T05:37:44Z

HANGUL_CHARACTERS_BY_FIRST_INDEX
HANGUL_CHARACTERS_BY_MIDDLE_INDEX
HANGUL_CHARACTERS_BY_LAST_INDEX
이것도 초,중,종으로 통일이 필요하지 않을까요?

fix: 일관된 한글 표기법 적용

bdeca9f

Collection50 requested review from okinawaa and raon0211 as code owners June 26, 2024 16:28

vercel bot had a problem deploying to Preview June 26, 2024 16:29 Failure

okinawaa reviewed Jun 29, 2024

View reviewed changes

okinawaa mentioned this pull request Jun 29, 2024

[Docs]: 공식 문서 최신화 #58

Closed

Collection50 mentioned this pull request Jul 1, 2024

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

Merged

1 task

fix: 기존의 함수를 유지한 채, deprecated 되도록 수정

a611eeb

vercel bot had a problem deploying to Preview July 1, 2024 12:43 Failure

fix: main 브랜치와 merge를 위한 수정

67011d4

vercel bot had a problem deploying to Preview July 1, 2024 12:50 Failure

Merge branch 'main' into fix/unify-hangul-name

2f6b51a

vercel bot had a problem deploying to Preview July 1, 2024 12:52 Failure

fix: conflict 수정

5ff9af8

vercel bot had a problem deploying to Preview July 1, 2024 12:54 Failure

fix: 문서에는 chosung prefix를 사용하도록 수정

a6c0c35

vercel bot had a problem deploying to Preview July 1, 2024 13:00 Failure

Collection50 requested review from manudeli and okinawaa July 1, 2024 13:01

okinawaa reviewed Jul 3, 2024

View reviewed changes

Collection50 and others added 2 commits July 5, 2024 16:23

fix: ChoseongIncludesDemo 함수명 수정

63ee040

Merge branch 'main' into fix/unify-hangul-name

cfbf101

vercel bot had a problem deploying to Preview July 5, 2024 07:24 Failure

This was referenced Jul 5, 2024

chore: eslint + vscode extension setting for cspell #171

Closed

chore: cspell.json 으로 설정을 변경합니다. #172

Merged

minsoo-web reviewed Jul 5, 2024

View reviewed changes

fix: 기존의 함수를 유지한 채, deprecated 되도록 수정

5ee57f9

vercel bot had a problem deploying to Preview July 9, 2024 05:36 Failure

docs: chosung~ 문서 작성

cad9916

vercel bot had a problem deploying to Preview July 9, 2024 05:41 Failure

Collection50 requested a review from okinawaa July 9, 2024 14:21

fix: choseongIncludes의 인덱싱 처리

b54423c

vercel bot had a problem deploying to Preview July 12, 2024 15:19 Failure

Merge branch 'main' into fix/unify-hangul-name

33ba976

vercel bot had a problem deploying to Preview July 12, 2024 15:35 Failure

Create fifty-wolves-melt.md

672e8e1

okinawaa previously approved these changes Jul 12, 2024

View reviewed changes

vercel bot had a problem deploying to Preview July 12, 2024 15:36 Failure

fix: import CI 오류 해결

44db24e

Collection50 dismissed okinawaa’s stale review via 44db24e July 12, 2024 15:46

vercel bot had a problem deploying to Preview July 12, 2024 15:47 Failure

okinawaa approved these changes Jul 13, 2024

View reviewed changes

okinawaa merged commit 6160363 into toss:main Jul 13, 2024
9 of 10 checks passed

github-actions bot mentioned this pull request Jul 13, 2024

chore: version packages #187

Merged

manudeli mentioned this pull request Jul 15, 2024

HANGUL_CHARACTERS_BY_FIRST_INDEX, HANGUL_CHARACTERS_BY_MIDDLE_INDEX, HANGUL_CHARACTERS_BY_LAST_INDEX #190

Closed

kangju2000 mentioned this pull request Jul 26, 2024

fix: 문서 배포 오류 수정 #199

Merged

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: 일관된 한글 표기법 적용 #138

fix: 일관된 한글 표기법 적용 #138

Collection50 commented Jun 26, 2024 •

edited

Loading

changeset-bot bot commented Jun 26, 2024 •

edited

Loading

vercel bot commented Jun 26, 2024 •

edited

Loading

okinawaa Jun 29, 2024

Collection50 Jun 29, 2024

okinawaa Jun 29, 2024

Collection50 Jun 29, 2024

manudeli Jun 30, 2024

manudeli Jun 30, 2024

okinawaa Jul 3, 2024

Collection50 Jul 3, 2024 •

edited

Loading

okinawaa Jul 5, 2024

okinawaa Jul 5, 2024

Collection50 Jul 5, 2024

Collection50 commented Jul 5, 2024

minsoo-web left a comment

minsoo-web Jul 5, 2024

Collection50 Jul 5, 2024

minsoo-web Jul 7, 2024

Collection50 Jul 7, 2024

minsoo-web Jul 8, 2024

okinawaa Jul 9, 2024

okinawaa commented Jul 9, 2024

Collection50 commented Jul 9, 2024

codecov-commenter commented Jul 9, 2024 •

edited

Loading

okinawaa commented Jul 12, 2024

okinawaa commented Jul 12, 2024

okinawaa left a comment

okinawaa commented Jul 12, 2024

Collection50 commented Jul 12, 2024

okinawaa left a comment

crucifyer commented Jul 15, 2024

fix: 일관된 한글 표기법 적용 #138

fix: 일관된 한글 표기법 적용 #138

Conversation

Collection50 commented Jun 26, 2024 • edited Loading

Overview

PR Checklist

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

🦋 Changeset detected

vercel bot commented Jun 26, 2024 • edited Loading

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

Collection50 Jul 3, 2024 • edited Loading

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

Collection50 commented Jul 5, 2024

minsoo-web left a 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 commented Jul 9, 2024

Collection50 commented Jul 9, 2024

codecov-commenter commented Jul 9, 2024 • edited Loading

Codecov Report

okinawaa commented Jul 12, 2024

okinawaa commented Jul 12, 2024

okinawaa left a comment

Choose a reason for hiding this comment

okinawaa commented Jul 12, 2024

Collection50 commented Jul 12, 2024

okinawaa left a comment

Choose a reason for hiding this comment

crucifyer commented Jul 15, 2024

Collection50 commented Jun 26, 2024 •

edited

Loading

changeset-bot bot commented Jun 26, 2024 •

edited

Loading

vercel bot commented Jun 26, 2024 •

edited

Loading

Collection50 Jul 3, 2024 •

edited

Loading

codecov-commenter commented Jul 9, 2024 •

edited

Loading