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

docs(hooks): useDebounce 훅의 문서 내 예시 추가 완료 #104

Merged
merged 4 commits into from
May 5, 2024

Conversation

Sangminnn
Copy link
Collaborator

@Sangminnn Sangminnn commented May 5, 2024

Overview

이전에 논의한 바와 같이 useBlockPromiseMultipleClick 훅에서 useDebounce와의 비교를 언급하였기에 두 훅에 대해 더 쉽게 이해할 수 있도록 누락되어있던 useDebounce 함수의 사용 예시를 추가했습니다.
더 좋은 의견이 있으시다면 편하게 말씀주시면 감사드리겠습니다. :)

useDebounce.mov

PR Checklist

  • [O] All tests pass.
  • [O] All type checks pass.
  • [O] I have read the Contributing Guide document.
    Contributing Guide

@Sangminnn Sangminnn requested a review from ssi02014 as a code owner May 5, 2024 11:53
Copy link

changeset-bot bot commented May 5, 2024

⚠️ No Changeset found

Latest commit: 39ece45

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.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

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

Copy link

codecov bot commented May 5, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 82.85%. Comparing base (d6173fb) to head (39ece45).

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #104   +/-   ##
=======================================
  Coverage   82.85%   82.85%           
=======================================
  Files          67       67           
  Lines         560      560           
  Branches      118      118           
=======================================
  Hits          464      464           
  Misses         84       84           
  Partials       12       12           
Components Coverage Δ
@modern-kit/react 72.50% <ø> (ø)
@modern-kit/utils 97.81% <ø> (ø)

Copy link
Contributor

@ssi02014 ssi02014 left a comment

Choose a reason for hiding this comment

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

너무 좋은 작업 진행해주셔서 너무나 감사드립니다!
혹시 Usage쪽도 Example 예제와 동일하게 맞춰주실 수 있으실까요!?

## Example

const Example = () => {
Copy link
Contributor

Choose a reason for hiding this comment

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

export를 추가안해도 정상 동작하나보네요..!? 혹시 vsc 상에서도 색깔이라던가.. 코드 정리가 되서 잘 노출되나요?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@ssi02014 제가 별도 확장프로그램을 사용하지않았어서 그런지 코드 하이라이팅이 전반적으로 안되어있었네요!
설치한 이후에도 설정을 제대로 하지 않아서 그런지 별도 차이는 보이지 않으나 다른 코드와의 통일성을 위해 추가해두겠습니다!

@Sangminnn
Copy link
Collaborator Author

@ssi02014 Usage와 Example의 코드가 동일하도록 수정해두었습니다 :)
아직 미숙한 부분이 많은데 잘 체크해주셔서 감사합니다! 🙇

Comment on lines 65 to 90
export const Example = () => {
const [count, setCount] = useState(1);
const [debouncedCount, setDebouncedCount] = useState(1);

const countUp = () => {
setCount(count + 1);
};

const countUpWithDebounce = useDebounce(() => {
setDebouncedCount(debouncedCount + 1);
}, 1000);

return (
<div>
<div style={{ display: "flex" }}>
<button onClick={countUp}>버튼 클릭</button>
<div style={{ width: "50px" }} />
<button onClick={countUpWithDebounce}>debounce 버튼 클릭</button>
</div>
<div>
<p>count: {count}</p>
<p>debouncedCount: {debouncedCount}</p>
</div>
</div>
);
};
Copy link
Contributor

@ssi02014 ssi02014 May 5, 2024

Choose a reason for hiding this comment

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

export const Example = () => {
  const [count, setCount] = useState(1);
  const [debouncedCount, setDebouncedCount] = useState(1);
  const countUp = () => {
    setCount(count + 1);
  };
  const countUpWithDebounce = useDebounce(() => {
    setDebouncedCount(debouncedCount + 1);
  }, 1000);
  return (
    <div>
      <div style={{ display: "flex" }}>
        <button onClick={countUp}>버튼 클릭</button>
        <div style={{ width: "50px" }} />
        <button onClick={countUpWithDebounce}>debounce 버튼 클릭</button>
      </div>
      <div>
        <p>count: {count}</p>
        <p>debouncedCount: {debouncedCount}</p>
      </div>
    </div>
  );
};
  • 아이고 죄송합니다! 마지막으로 놓치고 가이드를 못드린 부분인데요 ㅠㅠ build:docs를 진행할 때 공백 줄바꿈이 있으면 매번 build에 실패하더라구여😭 mdx특징인지.. docusaurus 문제인지 정확히는 모르겠습니다 모든 줄바꿈 공백을 제거해주시면 감사드립니다!!!

  • 아 참고로 저는 해당 확장프로그램을 설치하긴 했네요!

스크린샷 2024-05-05 오후 9 40 46

Copy link
Contributor

@ssi02014 ssi02014 May 5, 2024

Choose a reason for hiding this comment

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

  • mdx확장프로그램을 설치하면 아래와 같이 export를 사용하지 않으면 vsc상에서 뭔가 정상적이지 않은 느낌으로 노출됩니다 ㅋㅋㅋ😂
  • 그리고 Example 예제들에서 export를 누락하면 그때도 build:docs로 빌드를 진행 했을 때 실패해서 모두 추가해줬던 걸로 기억하네여

mdx 확장프로그램 설치 export 제외

스크린샷 2024-05-05 오후 9 42 51

mdx 확장프로그램 설치 export 추가

스크린샷 2024-05-05 오후 9 43 02

Copy link
Contributor

@ssi02014 ssi02014 May 5, 2024

Choose a reason for hiding this comment

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

위에 언급 내용 누락 시 발생 에러😂

스크린샷 2024-05-05 오후 9 46 21
  • 결과적으로 실제 테스트 해 볼 수 있는 용도로 추가하는 Example예제에는 모든 공백 줄바꿈을 제거하고 exports를 추가해주시면 감사드립니다!

@Sangminnn
Copy link
Collaborator Author

Sangminnn commented May 5, 2024

@ssi02014 전혀 모르던 부분인데 너무 감사합니다! 👍👍👍

mdx 확장프로그램 설치 이후 말씀주신 현상도 잘 확인하여 Example 내 공백 제거 및 export 추가해두었습니다!

다음 기여에서는 더 신경써서 올리겠습니다! :)

스크린샷 2024-05-05 오후 9 48 47

Comment on lines 1 to 2
import { useState } from 'react';
import { useDebounce } from '@modern-kit/hooks'
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
import { useState } from 'react';
import { useDebounce } from '@modern-kit/hooks'
import { useState } from 'react';
import { useDebounce } from '@modern-kit/react'
  • 해당 부분도 @modern-kit/react로 수정해주시면 감사드립니다!
  • 아 음.. 죄송합니다 제가 다시 확인해보니 공백 줄바꿈은 개선이되었나봅니다...!? 과거에는 안됐던 것으로 기억하는데.. 허허 exports만 추가해도 빌드가 정상 동작하네요 쓰읍 😭

@ssi02014
Copy link
Contributor

ssi02014 commented May 5, 2024

      - name: document build 🔨
        run: yarn build:docs
        if: github.event.pull_request.user.login == 'dependabot[bot]'
  • github action workflow(pull-request)에 위와 같이 build:docs에 조건식을 걸어놨었는데 추가 문서 작업이 있을 경우를 대비해 해당 조건식도 제거해놔야 겠네요🤔

@Sangminnn
Copy link
Collaborator Author

@ssi02014 헉 마침 제가 개인적으로 하는 프로젝트의 구조와 착각하여 react를 utils로 적었던 것을 알아버렸습니다 ..!
안그래도 올린 이후 남겨주신 코멘트를 보고 직전에 build:docs 를 시도했는데 오류가 나와서 알아버렸네요 😵‍💫
바로 수정 및 build:docs 성공하는 부분까지도 확인하여 올렸습니다! 감사합니다! 👍x10

Copy link
Contributor

@ssi02014 ssi02014 left a comment

Choose a reason for hiding this comment

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

useDebounce 문서 보강 작업해주셔서 다시 한번 감사드립니다! LGTM

@ssi02014 ssi02014 merged commit 7188855 into modern-agile-team:main May 5, 2024
3 checks passed
@Sangminnn Sangminnn deleted the docs/useDebounce branch May 5, 2024 13:13
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