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 : docs, docs-list #147

Merged
merged 7 commits into from
Apr 16, 2024
Merged

refactor : docs, docs-list #147

merged 7 commits into from
Apr 16, 2024

Conversation

Ubinquitous
Copy link
Member

What

docs와 docs list page를 리팩터링했습니다.

How

app/(docs)/docs/[title]/page.tsx

  • 사용하지 않는 dayjs locale import 삭제
  • list라고 되어있던 props명 frameNameList로 더 명시적으로 변경
  • 복잡하게 꼬여있던 useSuspenseQueries 두 줄로 선언하여 명시
  • like과 isILike를 useQueries를 사용하던 상태에서 useQuery 두줄로 변경 (더욱 코드를 보았을 때 명시적일 거라 생각했으며, 굳이 useSuspenseQueries를 쓰는 이유가 없다고 판단)
  • handleQueryInvalidate가 handleLikeToggleClick 함수 이외에 사용되지 않기에 이를 handleLikeToggleClick 함수 내로 이동
  • handleQueryInvalidate를 onSuccessToggleLike로 이름 변경
  • 시멘틱 태그 적용, 불필요한 태그 삭제
  • 코드 이해를 돕기 위한 주석 추가
  • 매직 리터럴로 명시되어있던 FrameEncoder mode EditorType enum으로 처리
  • 이름 없던 컴포넌트를 DocsComponent로 선언해 더욱 읽기 쉽게 변경
  • map에서 유효성 검사하던 문장을 filter문으로 리팩터링
  • 컴포넌트에 여러 props 하나씩 주던걸 전개 연산자로 변경

app/(docs)/docs/[title]/index.tsx

  • 상세한 주석 추가
  • 기존에 사용하던 frameList 탐색문 더욱 깔끔하게 리팩터링
  • list로 주던 props명 더 명시적이게 frameNameList로 변경

etc.

  • 문서 헤더에 마진 추가
  • EditorType enum에 READ, WRITE 추가
  • react-query 관련 코드에 주석 추가

ScreenShot

@Ubinquitous Ubinquitous self-assigned this Apr 14, 2024
Copy link
Member

@5ewon 5ewon left a comment

Choose a reason for hiding this comment

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

주석 설명 감사합니다. 굳굳

@Ubinquitous Ubinquitous merged commit 90d89ef into main Apr 16, 2024
2 checks passed
@Ubinquitous Ubinquitous deleted the refactor/docs-list branch November 15, 2024 16:24
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.

2 participants