Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: 패키지가 노출하는 인터페이스를 명확히 하기 위해 index.ts를 named export로 수정합니다 #157

Merged
merged 2 commits into from
Jun 30, 2024

Conversation

manudeli
Copy link
Member

@manudeli manudeli commented Jun 30, 2024

Overview

코멘트로 의도를 남겨요

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.

Copy link

vercel bot commented Jun 30, 2024

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 Jun 30, 2024 3:35pm

Copy link

changeset-bot bot commented Jun 30, 2024

🦋 Changeset detected

Latest commit: a549ece

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

@codecov-commenter
Copy link

codecov-commenter commented Jun 30, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.60%. Comparing base (0bd21e7) to head (a549ece).

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #157   +/-   ##
=======================================
  Coverage   99.60%   99.60%           
=======================================
  Files          16       16           
  Lines         255      255           
  Branches       56       56           
=======================================
  Hits          254      254           
  Misses          1        1           

@manudeli manudeli changed the title fix: exposing public apis strictly fix: 패키지가 노출하는 인터페이스를 명확히 하기 위해 index.ts를 named export로 수정합니다 Jun 30, 2024
@manudeli manudeli self-assigned this Jun 30, 2024
Comment on lines +1 to +21
export { assembleHangul } from './assemble';
export { chosungIncludes } from './chosungIncludes';
export { combineHangulCharacter, combineVowels, curriedCombineHangulCharacter } from './combineHangulCharacter';
export { convertQwertyToHangul, convertQwertyToHangulAlphabet } from './convertQwertyToHangulAlphabet';
export { disassembleHangul, disassembleHangulToGroups } from './disassemble';
export { disassembleCompleteHangulCharacter } from './disassembleCompleteHangulCharacter';
export { hangulIncludes } from './hangulIncludes';
export { josa } from './josa';
export { removeLastHangulCharacter } from './removeLastHangulCharacter';
export {
canBeChosung,
canBeJongsung,
canBeJungsung,
getChosung,
hasBatchim,
hasProperty,
hasSingleBatchim,
hasValueInReadOnlyStringList,
} from './utils';
export { extractHangul } from './extractHangul';
export { acronymizeHangul } from './acronymizeHangul';
Copy link
Member Author

@manudeli manudeli Jun 30, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

모든 인터페이스가 *로 노출되면 안될 것 같아보여서(테스트용으로 export했을 수 있기 때문에) 현재 이미 노출되고 있는 것은 노출되도록 변경했습니다.

utils와 같은 폴더의 경우 노출되면 안되는 인터페이스 같아서 이슈로도 함께 남겨요. 잘못 노출된 인터페이스는 점진적으로 제거되면 좋을 거 같아요

@manudeli manudeli marked this pull request as ready for review June 30, 2024 15:37
Copy link
Member

@okinawaa okinawaa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

감사합니다!
utils 내부에 있는 함수들중에,
정말로 외부에 노출해야한다면 파일을 분리하고,
내부적으로만 사용할것이라면 _internal에 구현하는게 좋겠네요

@okinawaa okinawaa merged commit f7e60ae into main Jun 30, 2024
10 checks passed
@github-actions github-actions bot mentioned this pull request Jun 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants