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

feat: 폴더 구조를 플랫화합니다 #242

Merged
merged 4 commits into from
Sep 6, 2024
Merged

feat: 폴더 구조를 플랫화합니다 #242

merged 4 commits into from
Sep 6, 2024

Conversation

okinawaa
Copy link
Member

@okinawaa okinawaa commented Sep 5, 2024

Overview

함수 자체의 개수는 많지 않은데, 테스트 파일 혹은 상수 파일들로 인해서 src 내부의 파일이 많아보이는 상황이 있었어요.
src 폴더내부에서 함수 폴더를 플랫하게 가져갑니다

image

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 Sep 5, 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 Sep 5, 2024 4:43pm

Copy link

changeset-bot bot commented Sep 5, 2024

⚠️ No Changeset found

Latest commit: b72ac24

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

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

@codecov-commenter
Copy link

codecov-commenter commented Sep 5, 2024

Codecov Report

Attention: Patch coverage is 98.52941% with 1 line in your changes missing coverage. Please review.

Project coverage is 99.66%. Comparing base (6d684b6) to head (b72ac24).

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #242      +/-   ##
==========================================
- Coverage   99.83%   99.66%   -0.17%     
==========================================
  Files          31       36       +5     
  Lines         600      601       +1     
  Branches      145      145              
==========================================
  Hits          599      599              
- Misses          1        2       +1     

@okinawaa
Copy link
Member Author

okinawaa commented Sep 5, 2024

@BO-LIKE-CHICKEN 폴더구조 변경에 대한 PR입니다!

Copy link
Contributor

@BO-LIKE-CHICKEN BO-LIKE-CHICKEN left a comment

Choose a reason for hiding this comment

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

폴더 구조를 플랫하게 가져가는김에 아래의 목적을 달성하기 위해 다음의 두 방향 중 하나로 개선이 이루어지면 좋을 것 같아요. 🙂

src 1-depth에 있는 폴더들은 모두 es-hangul에서 제공하는 api로만 이루어진다. (_internal 제외)

  1. constants.ts에 있는 파일도 사용되는 함수에 맞추어 분리된다.
  2. 분리되어있던 상수들이 constants.ts에 합쳐지고 constants.ts가 _internal로 이동된다.

@okinawaa
Copy link
Member Author

okinawaa commented Sep 5, 2024

너무 좋은 의견 감사합니다! 1번처럼 사용해서 응집도를 높히는쪽으로 작업해보겠습니다!


생각보다 하나의 constant를 여러 함수에서 부르는 경우가 많아서,
한 가지 함수에서만 사용되는경우 1번처럼 그 함수에 종속시키고
두 가지 이상 함수에서 사용되는 상수인경우 _internal/constants에 위치시키겠습니다!

@okinawaa
Copy link
Member Author

okinawaa commented Sep 5, 2024

constants파일 분리하였어요!

image

Copy link
Contributor

@BO-LIKE-CHICKEN BO-LIKE-CHICKEN left a comment

Choose a reason for hiding this comment

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

저에게도 이렇게 개선된 것이 보기에 더 좋아보여요 🙌

고생하셨습니다

@okinawaa
Copy link
Member Author

okinawaa commented Sep 6, 2024

@BO-LIKE-CHICKEN 너무감사해요!!!

@okinawaa okinawaa merged commit dc0bb4b into main Sep 6, 2024
10 checks passed
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.

3 participants