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

refactor: svg 설정 및 프로젝트 정리 #126

Merged
merged 11 commits into from
Jun 26, 2024

Conversation

hsgh085
Copy link
Collaborator

@hsgh085 hsgh085 commented Jun 25, 2024

💡 작업 내용

  • svg 설정
  • svg 파일 컨벤션에 맞게 정리
  • api 폴더 구조 정리
  • hooks/api 폴더 구조 정리
  • temp.ts -> theme.ts, Theme.ts -> theme.ts 으로 파일명 변경

💡 자세한 설명

✅ svg 설정

svg 아이콘에서 제어하고 싶은 속성은 current 값으로 주면 제어 가능하도록 변경했습니다.

예시

// email.svg
<svg
    width="current"
    height="current"
    viewBox="0 0 34 34"
    fill="none"
    xmlns="http://www.w3.org/2000/svg"
>
   ...
</svg>

// LandingPage.tsx
...
<Input
     placeholder="placeholder"
     icon={<Email width="16" height="16" />}
     btn={<Email width="34" height="34" />}
/>
...

✅ svg 파일 컨벤션에 맞게 정리

  1. svg 폴더 내에는 .svg 파일만 존재하도록 파일 정리
  2. .svg 파일명은 케밥 케이스로 변경
  3. .svg 파일을 /svg/index.ts에 export한 후 사용, export 시에는 파스칼 케이스로 이름 재정의

✅ api 폴더 구조 정리

api 폴더 내에는 스웨거에 있는 큰 카테고리를 파일 명으로 하여 해당 파일 내에 api 함수 정리

✅ hooks/api 폴더 구조 정리

hooks/api 폴더 내에는 스웨거에 있는 큰 카테고리를 폴더 명으로 하여 해당 폴더 내에 각각의 react-query hook을 파일로 만들어 저장

  • 참고
    api/mypage.ts와 hooks/api/mypage 내에 있는 코드들은 이전에 스웨거에 mypage라는 카테고리 내에 api 함수가 존재했으나 현재 배포된 스웨거에는 삭제 조치된 상태입니다. 해당 코드들은 삭제하면 에러가 터지기에 삭제 조치하지 않고 남겨두었습니다. 마이페이지 리팩토링 이후 삭제 조치할 예정입니다!

✅ github 파일명 변경 원격 저장소에 반영시키기

결론부터 말씀드리자면,
git config core.ignorecase false 명령어를 팀원 모두 켜주시면 감사합니다!

pr 후 스토리북 자동 배포 과정에서 에러가 발생해 로그를 확인해보니, 대문자에서 소문자로 변경된 파일을 찾지 못했습니다. 커밋 내역을 확인해보니 로컬에서는 파일명이 소문자로 변경되어있지만, git은 대소문자를 구분하지 못해 커밋에 반영되지 않아 생긴 문제였습니다. 이를 해결하기 위해 git config core.ignorecase false 해당 명령어로 git이 대소문자를 구분할 수 있도록 변경했습니다. 하지만 팀원 중 하나라도 해당 옵션을 설정하지 않는다면 pull 이 불가능하다고하여 팀원 모두 사전에 이러한 에러를 방지하고자 켜주시면 감사하겠습니다😀

📗 참고 자료 (선택)

git 파일명 변경 원격저장소에 반영하기

📢 리뷰 요구 사항 (선택)

🚩 후속 작업 (선택)

✅ 셀프 체크리스트

  • PR 제목을 형식에 맞게 작성했나요?
  • 브랜치 전략에 맞는 브랜치에 PR을 올리고 있나요? (master/main이 아닙니다.)
  • 이슈는 close 했나요?
  • Reviewers, Labels, Projects를 등록했나요?
  • 작업 도중 문서 수정이 필요한 경우 잘 수정했나요?
  • 테스트는 잘 통과했나요?
  • 불필요한 코드는 제거했나요?

closes #125

@hsgh085 hsgh085 added ✔︎pull requests pull requests 코드 체크 요청 👩🏻‍💻 frontend 프론트엔드 작업 🪄refactor 리팩토링 labels Jun 25, 2024
@hsgh085 hsgh085 requested review from kwaksj329 and areumH June 25, 2024 16:16
@hsgh085 hsgh085 self-assigned this Jun 25, 2024
Copy link
Collaborator

@areumH areumH left a comment

Choose a reason for hiding this comment

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

수정된 파일들이 엄청 많네요🫢 고생하셨어요 !!!!
명령어 켜두었습니다! 정보 공유 감사해요👍

Copy link
Member

@kwaksj329 kwaksj329 left a comment

Choose a reason for hiding this comment

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

참고사항과 해당 명령어 설정 모두 확인했습니다. 👍🏻

@hsgh085 hsgh085 merged commit 4e87254 into dev Jun 26, 2024
3 checks passed
@hsgh085 hsgh085 deleted the refactor/125-svg-folder-organize branch September 27, 2024 17:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
👩🏻‍💻 frontend 프론트엔드 작업 ✔︎pull requests pull requests 코드 체크 요청 🪄refactor 리팩토링
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

svg 설정 및 프로젝트 정리
3 participants