search

channel-io / bezier-react

React components library that implements Bezier design system.
https://main--62bead1508281287d3c94d25.chromatic.com
Apache License 2.0
185 stars 46 forks source link

Add `ProgressBarSize`, `ProgressBarVariant` string literal type and deprecate enum #1595

Closed Dogdriip closed 9 months ago

Dogdriip commented 9 months ago

Self Checklist

Related Issue

Summary

Details

Breaking change or not (Yes/No)

References

changeset-bot[bot] commented 9 months ago

🦋 Changeset detected

Latest commit: b6ac62630255071849f3664c35f021d746049837

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages | Name | Type | | ------------------------ | ----- | | @channel.io/bezier-react | Patch | | bezier-figma-plugin | Patch |

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[bot] commented 9 months ago

Codecov Report

Patch coverage: 100.00% and project coverage change: -0.06% :warning:

Comparison is base (842c80b) 87.00% compared to head (b6ac626) 86.94%. Report is 2 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #1595 +/- ## ========================================== - Coverage 87.00% 86.94% -0.06% ========================================== Files 281 281 Lines 3879 3877 -2 Branches 817 817 ========================================== - Hits 3375 3371 -4 - Misses 430 432 +2 Partials 74 74 ``` | [Files Changed](https://app.codecov.io/gh/channel-io/bezier-react/pull/1595?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=channel-io) | Coverage Δ | | |---|---|---| | [...ct/src/components/ProgressBar/ProgressBar.types.ts](https://app.codecov.io/gh/channel-io/bezier-react/pull/1595?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=channel-io#diff-cGFja2FnZXMvYmV6aWVyLXJlYWN0L3NyYy9jb21wb25lbnRzL1Byb2dyZXNzQmFyL1Byb2dyZXNzQmFyLnR5cGVzLnRz) | `0.00% <ø> (-100.00%)` | :arrow_down: | | [...t/src/components/ProgressBar/ProgressBar.styled.ts](https://app.codecov.io/gh/channel-io/bezier-react/pull/1595?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=channel-io#diff-cGFja2FnZXMvYmV6aWVyLXJlYWN0L3NyYy9jb21wb25lbnRzL1Byb2dyZXNzQmFyL1Byb2dyZXNzQmFyLnN0eWxlZC50cw==) | `100.00% <100.00%> (ø)` | | | [...r-react/src/components/ProgressBar/ProgressBar.tsx](https://app.codecov.io/gh/channel-io/bezier-react/pull/1595?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=channel-io#diff-cGFja2FnZXMvYmV6aWVyLXJlYWN0L3NyYy9jb21wb25lbnRzL1Byb2dyZXNzQmFyL1Byb2dyZXNzQmFyLnRzeA==) | `100.00% <100.00%> (ø)` | |

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

github-actions[bot] commented 9 months ago

Chromatic Report

🚀 Congratulations! Your build was successful!

yangwooseong commented 9 months ago

breaking change 를 발생시키면 메이저 버전을 올려야 해서, enum과 union type 을 동시에 지원하되 enum type 을 deprecated 시키고 사용할 때 경고를 띄워주면 어떨까요? (# 참고). semver 를 지키려면 메이저 버전 올릴 때까지 breaking change 가 없는게 좋을 것 같습니다

yangwooseong commented 9 months ago

minor version bump 를 위한 changset 은 필요할 것 같습니다! codemod 까지 포함하는 pr 이 될까요? 아니라면 제목에서 [WIP]은 없애도 될듯 합니다!

Dogdriip commented 9 months ago

breaking change 를 발생시키면 메이저 버전을 올려야 해서, enum과 union type 을 동시에 지원하되 enum type 을 deprecated 시키고 사용할 때 경고를 띄워주면 어떨까요? (https://github.com/channel-io/bezier-react/pull/1562#pullrequestreview-1599485916 참고). semver 를 지키려면 메이저 버전 올릴 때까지 breaking change 가 없는게 좋을 것 같습니다

레거시 대응도 했어야 하는데 생각치 못했네요... 👍 우선 enum과 string literal 타입 둘 다 사용할 수 있도록 두고, enum에 @deprecated 달아두었습니다.

minor version bump 를 위한 changset 은 필요할 것 같습니다! codemod 까지 포함하는 pr 이 될까요? 아니라면 제목에서 [WIP]은 없애도 될듯 합니다!

codemod 구현 후 changeset 추가해서 WIP 뗄 예정이었습니다 😅 우선 draft로 돌려두겠습니다!

sungik-choi commented 9 months ago

breaking change 를 발생시키면 메이저 버전을 올려야 해서, enum과 union type 을 동시에 지원하되 enum type 을 deprecated 시키고 사용할 때 경고를 띄워주면 어떨까요? (# 참고). semver 를 지키려면 메이저 버전 올릴 때까지 breaking change 가 없는게 좋을 것 같습니다

1602

Dogdriip commented 9 months ago

codemod 구현 후 changeset 추가해서 WIP 뗄 예정이었습니다 😅 우선 draft로 돌려두겠습니다!

codemod는 후속 PR에서 enum -> string literal을 제너릭하게 사용할 수 있도록 작성하겠습니다.

breaking change 를 발생시키면 메이저 버전을 올려야 해서, enum과 union type 을 동시에 지원하되 enum type 을 deprecated 시키고 사용할 때 경고를 띄워주면 어떨까요? (# 참고). semver 를 지키려면 메이저 버전 올릴 때까지 breaking change 가 없는게 좋을 것 같습니다

1602

우선은 deprecated 태그만 달아두겠습니다. 🥲

sungik-choi commented 9 months ago

codemod 구현 후 changeset 추가해서 WIP 뗄 예정이었습니다 😅 우선 draft로 돌려두겠습니다!

codemod는 후속 PR에서 enum -> string literal을 제너릭하게 사용할 수 있도록 작성하겠습니다.

breaking change 를 발생시키면 메이저 버전을 올려야 해서, enum과 union type 을 동시에 지원하되 enum type 을 deprecated 시키고 사용할 때 경고를 띄워주면 어떨까요? (# 참고). semver 를 지키려면 메이저 버전 올릴 때까지 breaking change 가 없는게 좋을 것 같습니다

1602

  • 런타임에서 특정 string이 enum member인지 / string literal인지 구분할 수 있는 방법이 없어서 (있다면 코멘트 주시면 감사하겠습니다...)
  • (+ 특정 Enum이 import되었는지 확인하는 건 더 어려워서)

우선은 deprecated 태그만 달아두겠습니다. 🥲

Enum은 deprecated 표시가 명확히 잘 되어서, 그거로도 충분할 거 같습니다 👍