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

Add codemod to transform foundation to css variable #1781

Merged

Conversation

yangwooseong
Copy link
Collaborator

@yangwooseong yangwooseong commented Dec 8, 2023

Self Checklist

  • I wrote a PR title in English and added an appropriate label to the PR.
  • I wrote the commit message in English and to follow the Conventional Commits specification.
  • I added the changeset about the changes that needed to be released. (or didn't have to)
  • I wrote or updated documentation related to the changes. (or didn't have to)
  • I wrote or updated tests related to the changes. (or didn't have to)
  • I tested the changes in various browsers. (or didn't have to)
    • Windows: Chrome, Edge, (Optional) Firefox
    • macOS: Chrome, Edge, Safari, (Optional) Firefox

Related Issue

Summary

  • styled component 의 foundation 객체를 사용한 스타일링을 css variable 로 변환하는 codemod 를 추가합니다.
  • 변환 결과의 전 후를 보려면 테스트 코드나 이슈를 참조해주세요.

Details

  • theme, rounding, border, elevation, transition 에 대하여 개별로 transform 함수를 작성해서, 사용처에서 하나씩 사용하거나 한꺼번에 사용할 수 있게 했습니다. theme 마이그레이션만 해도 몇 백 줄이 변하기 때문에 개별적으로 적용할 수 있게 열어주는 게 좋을 것 같았습니다. spacing 은 데스크 코드에서 사용처가 없기 때문에 손으로 지워도 되리라 생각합니다.

  • 어플리케이션에서 테스트 해보려면 @channel.io/bezier-codemod 패키지를 빌드 한 후 아래 명령어로 테스트 가능합니다. 테스트 결과 80~90% 이상 커버를 해주는 것을 확인했습니다. 동작 속도는 개별 transform 별로 30초~1분 정도 걸립니다.

npx bezier-react/packages/bezier-codemod/node_modules/.bin/bezier-codemod
  • transform 이 커버하지 못하는 코드 조각은 다음과 같습니다. 아래와 같은 코드를 만났을 경우 처리하지 않고 그대로 두는 것이 의도입니다. 이에 대한 테스트 코드 또한 별도로 작성했습니다.

argument 가 foundation 이외에 여러 개 있을 경우

const div = styled.div`
  ${({ foundation, isRounding }) =>
  isRounding && foundation?.elevation?.ev3()};
`

constant 를 사용하는 경우

  background-color: ${({ foundation }) =>
    foundation?.theme[SOME_CONSTANT]};
  • transform 이 끝나면 바뀐 파일 갯수를 2배로 보여주는 버그가 있습니다. 아래 코드에서 파일이 두 번씩 들어가서 그런 것 같은데, 아직 정확한 원인은 찾지 못했습니다. 여기서 바로 해결하지 않고 이슈로 남겨두겠습니다.

App.tsx

const sourceFiles = project.addSourceFilesAtPaths(filePath)

Breaking change? (Yes/No)

  • No

References

@yangwooseong yangwooseong self-assigned this Dec 8, 2023
Copy link

changeset-bot bot commented Dec 8, 2023

🦋 Changeset detected

Latest commit: d112f31

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

This PR includes changesets to release 1 package
Name Type
@channel.io/bezier-codemod Minor

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

Copy link

codecov bot commented Dec 8, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (957e4f8) 87.24% compared to head (d112f31) 87.23%.

Additional details and impacted files
@@            Coverage Diff             @@
##            alpha    #1781      +/-   ##
==========================================
- Coverage   87.24%   87.23%   -0.01%     
==========================================
  Files         283      282       -1     
  Lines        3974     3973       -1     
  Branches      830      830              
==========================================
- Hits         3467     3466       -1     
  Misses        435      435              
  Partials       72       72              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@yangwooseong yangwooseong added the feat Issue or PR related to a new feature label Dec 8, 2023
@yangwooseong yangwooseong marked this pull request as ready for review December 8, 2023 05:56
@@ -0,0 +1,32 @@
const borderBaseStyle = css`
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

이렇게 변하지 않는 코드를 위한 테스트 코드도 필요하기 때문에, 아예 fixtures/ 밑에서 변하는 경우, 안변하는 경우 각각의 디렉토리를 만들어서 그 밑에 테스트 코드를 만드는 것도 좋을 것 같네요.

Comment on lines +8 to +9
.filter(v => v.getDescendantsOfKind(SyntaxKind.ArrowFunction).length === 0)
.filter(v => v.getDescendantsOfKind(SyntaxKind.BindingElement).length === 1)
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

윗 줄은 아래처럼 중첩되어 있을 경우 안에 있는(즉, AST 상에서 leaf 에 가까운) 화살표 함수를 얻기 위한 로직이고, 아랫줄은 ${({ foundation }) => 처럼 property 하나만 가지고 있을 때만 필터링하는 로직입니다.

const Command = styled.div`
  ${({ disabled }) =>
    disabled &&
    css`
      &&& {
        ${({ foundation }) =>
          foundation?.transition.getTransitionsCSS([
            'background-color',
            'color',
            'opacity',
          ])}
      }
    `}
`

color: var(--txt-black-dark);
border-radius: var(--radius-12);
border-bottom: 0.5px solid var(--bdr-black-light);
box-shadow: var(--ev-1);
Copy link
Contributor

Choose a reason for hiding this comment

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

기존 elevation에 background-color도 포함되어있어서, bgColor, shadow 2개 속성을 포함하도록 변환해줘야할 거 같습니다!

border-radius: var(--radius-12);
border-bottom: 0.5px solid var(--bdr-black-light);
box-shadow: var(--ev-1);
transition: color var(--transition-duration-s) cubic-bezier(0.3, 0, 0, 1);
Copy link
Contributor

Choose a reason for hiding this comment

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

transtion: color var(--transition-s) 도 가능할 거 같아요. shorthand로 조합할 수 있게 만들어놨어요. (테스트 필요)

    --transition-duration-l: 450ms;
    --transition-duration-m: 300ms;
    --transition-duration-s: 150ms;
    --transition-timing-function-default: cubic-bezier(0.3, 0, 0, 1);
    --transition-l: var(--transition-duration-l) var(--transition-timing-function-default);
    --transition-m: var(--transition-duration-m) var(--transition-timing-function-default);
    --transition-s: var(--transition-duration-s) var(--transition-timing-function-default);

Copy link
Collaborator Author

@yangwooseong yangwooseong Dec 11, 2023

Choose a reason for hiding this comment

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

조합된 var(--transition-l) variable 로 테스트 해보니 잘 되네요!


const Wrapper = styled.div`
color: var(--txt-black-dark);
border-radius: var(--radius-12);
Copy link
Contributor

Choose a reason for hiding this comment

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

기존 radius도 overflow:hidden 스타일을 가지고 있어요. 큰 문제는 없을 거 같지만, 안전한 마이그레이션을 위해서 추가해주면 좋을 거 같습니다.


### Foundation to CSS Variable

**`css-variable-to-css-variable`**
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
**`css-variable-to-css-variable`**
**`foundation-to-css-variable`**

**`css-variable-to-css-variable`**

Replace foundation to css variable
You can also use individual transform function such as `css-variable-to-css-theme`, `css-variable-to-css-rounding`, and so on.
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
You can also use individual transform function such as `css-variable-to-css-theme`, `css-variable-to-css-rounding`, and so on.
You can also use individual transform function such as `foundation-to-css-variable-theme`, `foundation-to-css-variable-rounding`, and so on.

Comment on lines 42 to 47
FoundationToCssVariableTheme = 'css-variable-to-css-variable-theme',
FoundationToCssVariableBorder = 'css-variable-to-css-variable-border',
FoundationToCssVariableElevation = 'css-variable-to-css-variable-elevation',
FoundationToCssVariableRounding = 'css-variable-to-css-variable-rounding',
FoundationToCssVariableTransition = 'css-variable-to-css-variable-transition',
FoundationToCssVariable = 'css-variable-to-css-variable',
Copy link
Contributor

Choose a reason for hiding this comment

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

foundation-to ?

Comment on lines 39 to 45
if (hasTop && hasRight && hasBottom && hasLeft) { borderStyle += `border: ${thinkNess}px solid var(--${color});\n` } else {
if (hasTop) {
if (hasAdded) { borderStyle += ' ' }
hasAdded = true
borderStyle += `border-top: ${thinkNess}px solid var(--${color});\n`
}
if (hasRight) {
if (hasAdded) { borderStyle += ' ' }
hasAdded = true
borderStyle += `border-right: ${thinkNess}px solid var(--${color});\n`
}
if (hasBottom) {
if (hasAdded) { borderStyle += ' ' }
hasAdded = true
borderStyle += `border-bottom: ${thinkNess}px solid var(--${color});\n`
}
if (hasLeft) {
if (hasAdded) { borderStyle += ' ' }
hasAdded = true
borderStyle += `border-left: ${thinkNess}px solid var(--${color});\n`
}
}
Copy link
Contributor

Choose a reason for hiding this comment

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

  return css`
    box-sizing: border-box;
    border-color: ${color};
    border-style: ${getBorderStyle(top)} ${getBorderStyle(right)} ${getBorderStyle(bottom)} ${getBorderStyle(left)};
    border-width: ${width}px;
  `
  • 기존 getBorder 가 반환하던 interpolation과 동일하면 더 좋을 거 같습니다! 사이즈도 좀 줄어들 거 같구요. 애플리케이션에서 어차피 잘 Minify 하겠지만요.
  • box-sizing은 넣어야하나 고민이네요. 전역 스타일에서 처리해줄텐데... 어떻게 생각하시는지 궁금합니다

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

저도 안넣어주는 게 좋을 것 같네요!

@sungik-choi
Copy link
Contributor

💯

@yangwooseong yangwooseong force-pushed the feat/codemod-for-foundation branch from 12a45d8 to d112f31 Compare December 12, 2023 04:51
@yangwooseong yangwooseong merged commit c59d2b2 into channel-io:alpha Dec 12, 2023
9 of 10 checks passed
sungik-choi pushed a commit that referenced this pull request Dec 12, 2023
This PR was opened by the [Changesets
release](https://github.com/changesets/action) GitHub action. When
you're ready to do a release, you can merge this and the packages will
be published to npm automatically. If you're not ready to do a release
yet, that's fine, whenever you add more changesets to alpha, this PR
will be updated.

⚠️⚠️⚠️⚠️⚠️⚠️

`alpha` is currently in **pre mode** so this branch has prereleases
rather than normal releases. If you want to exit prereleases, run
`changeset pre exit` on `alpha`.

⚠️⚠️⚠️⚠️⚠️⚠️

# Releases
## @channel.io/[email protected]

### Minor Changes

- Add transform functions to help to migrate foundation to css variable
generated by `@channel.io/bezier-tokens` package.
([#1781](#1781)) by
@yangwooseong
They cover theme, transition, elevation, rounding, and border of
foundation.

## @channel.io/[email protected]

### Minor Changes

- Implement multi theme feature based on data attributes.
([#1756](#1756)) by
@sungik-choi

## @channel.io/[email protected]

### Minor Changes

- Add composition tokens, such as box-shadow.
([#1769](#1769)) by
@sungik-choi

- Now serving one combined styles.css file. This is a breaking change
for anyone who was importing the individual CSS files. You will need to
update your import to `@channel.io/bezier-tokens/css/styles.css`.
([#1769](#1769)) by
@sungik-choi

- Add z-index and opacity tokens.
([#1766](#1766)) by
@sungik-choi

- Add categories by token to the JavaScript build file.
([#1766](#1766)) by
@sungik-choi

### Patch Changes

- Remove duplicate styles in styles.css
([#1779](#1779)) by
@sungik-choi

## [email protected]

### Patch Changes

-   Updated dependencies
    -   @channel.io/[email protected]

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
@yangwooseong yangwooseong changed the title Add codmod to transform foundation to css variable Add codemod to transform foundation to css variable Dec 12, 2023
@yangwooseong yangwooseong deleted the feat/codemod-for-foundation branch December 12, 2023 11:18
@yangwooseong yangwooseong added the bezier-codemod Issue or PR related to bezier-codemod label Dec 14, 2023
sungik-choi pushed a commit that referenced this pull request Mar 26, 2024
This PR was opened by the [Changesets
release](https://github.com/changesets/action) GitHub action. When
you're ready to do a release, you can merge this and the packages will
be published to npm automatically. If you're not ready to do a release
yet, that's fine, whenever you add more changesets to main, this PR will
be updated.


# Releases
## @channel.io/[email protected]

### Major Changes

- **Breaking Changes: Property updates in `Avatar` component**
([#1871](#1871)) by
@yangwooseong

No longer support `interpolation` property. Replace any usage of
`interpolation` property with appropriate `style` or `className`
implementations.

- **Breaking changes: Remove TagBadge-related types**
([#2114](#2114)) by
@sungik-choi

    -   Remove `color` prop of `TagProps` and `TagBadgeBgColorPreset`.
- Remove `TagBadgeSize`. Please change it to `TagSize` and `BadgeSize`.
- Remove `TagBadgeVariant`. Please change it to `TagVariant` and
`BadgeVariant`.

- **Breaking Changes: Property updates in `SegmentedControl` component**
([#1866](#1866)) by
@sungik-choi

No longer support `as` and `interpolation` property. Replace any usage
of `interpolation` property with appropriate `style` or `className`
implementations.

- **Breaking Changes: Property updates in `ListItem` component**
([#1925](#1925)) by
@sungik-choi

- No longer support `interpolation` property. Replace any usage of
`interpolation` property with appropriate `style` or `className`
implementations.
- No longer support `iconStyle`, `iconClassName`, `iconInterpolation`,
`contentStyle`, `contentClassName` and `contentInterpolation`. This
decision was made to reduce excessive flexibility in the interface.
- No longer support `leftIcon` property. Removed for consistency with
other component interfaces. Replace it to `leftContent`.
- No longer support `name` property. The second argument (name) of
`onClick` is also removed. If you need an identifier, combine functions
outside of the component.
- No longer support `hide`, `nested`, `optionKey` and
`disableIconActive` property. Removed because it is a legacy property.
Replace `hide` property with conditional rendering.
- The size changes according to the `ListItemSize`. This is a change to
unify the design. Please change it like below.
        -   `ListItemSize.S` -> `ListItemSize.XS`
        -   `ListItemSize.M` -> `ListItemSize.S`
        -   `ListItemSize.L` -> `ListItemSize.M`
        -   `ListItemSize.XL` -> `ListItemSize.L`

    **Minor Changes:**

    -   Fix incorrect text size for `XL`(now `L`) size.

- **Breaking Changes: Property updates in `Overlay` component**
([#1949](#1949)) by
@sungik-choi

- No longer support `as` and `interpolation` property. Replace any usage
of `interpolation` property with appropriate `style` or `className`
implementations.
- No longer support `containerInterpolation` property. Replace any usage
of `containerInterpolation` property with appropriate `containerStyle`
or `containerClassName` implementations.
    -   No longer support `wrapperTestId` property.

- **Breaking Changes: Remove `TooltipProvider` and Property updates in
`Tooltip` component**
([#1974](#1974)) by
@sungik-choi

- No longer support `TooltipProvider` and `TooltipProviderProps`.
`Tooltip` component was implemented via radix-ui's Tooltip, which
required the use of a `TooltipProvider`, which caused all subcomponents
to be re-rendered and caused a performance hit. We decided that the
ability to share hover delay time between `Tooltip` components via
`TooltipProvider` was not a feature we needed, even with the performance
penalty. Also, by providing `TooltipProvider` built-in to `AppProvider`,
we were unnecessarily importing modules from our library usage that
didn't require `Tooltip`.
    -   `Tooltip` component now contains a `TooltipProvider` inside it.

    **Minor Changes:**

    -   Change the default value of `delayShow` prop from `300` to `0`.

- **Breaking Changes: Property updates in `Tag` and `Badge` component**
([#1872](#1872)) by
@yangwooseong

No longer support `interpolation` property. Replace any usage of
`interpolation` property with appropriate `style` or `className`
implementations.

- **Breaking Changes: Property updates in `CheckableAvatar` component**
([#1921](#1921)) by
@sungik-choi

No longer support `interpolation` property. Replace any usage of
`interpolation` property with appropriate `style` or `className`
implementations.

- **Breaking Changes: `AlphaSmoothCornersBox` component is now
`SmoothCornersBox` component.**
([#2079](#2079)) by
@sungik-choi

- **Breaking Changes: Property updates in `LegacyTooltip` component**
([#1945](#1945)) by
@sungik-choi

- No longer support `interpolation` property. Replace any usage of
`interpolation` property with appropriate `style` or `className`
implementations.
- No longer support `contentInterpolation` property. Replace any usage
of `contentInterpolation` property with appropriate `contentStyle` or
`contentClassName` implementations.
- No longer support `contentWrapperInterpolation` property. Replace any
usage of `contentWrapperInterpolation` property with appropriate
`contentWrapperStyle` or `contentWrapperClassName` implementations.

- **Breaking Changes: `AlphaCenter` component is now `Center` component.
Property updates in `Center` component**
([#1854](#1854)) by
@sungik-choi

- No longer support `as` and `interpolation` property. Replace any usage
of `interpolation` property with appropriate `style` or `className`
implementations.
    -   Now supports margin props, layout props and `display` prop.

- **Breaking Changes: Property updates in `FormLabel`, `FormHelperText`,
and `FormErrorMessage` component**
([#1893](#1893)) by
@yangwooseong

No longer support `as` and `interpolation` property. Replace any usage
of `interpolation` property with appropriate `style` or `className`
implementations.

- **Breaking Changes: Property updates in `NavGroup` and `NavItem`
component**
([#1931](#1931)) by
@sungik-choi

`leftIcon` renamed to `leftContent`. Changed to improve consistency of
interface property names across libraries.

- **Breaking Changes: The enum type that the component receives as props
is changed to a string (or number) literal type**
([#2059](#2059)) by
@yangwooseong

    The properties that change are:

    -   `AvatarGroupEllipsisType`
    -   `IconSize`
    -   `LegacyTooltipPosition`
    -   `ModalTitleSize`
    -   `OverlayPosition`
    -   `ProgressBarSize`, `ProgressBarVariant`
    -   `SpinnerSize`
    -   `SwitchSize`
    -   `TagBadgeSize`, `TagBadgeVariant`
    -   `TextAreaHeight`
    -   `TextFieldSize`, `TextFieldVariant`
    -   `ToastPlacement`, `ToastAppearance`, `ToastPreset`
    -   `TooltipPosition`

Also, `SpinnerThickness` props of `Spinner` is not supported any more.

When changed to string literal type, it is changed to the kebab-cased
value of enum. e.g. `TooltipPosition.TopCenter` -> `top-center`. Among
the above enums, `TextAreaHeight` is converted to number literal type.
e.g. `TextAreaHeight.Row16` -> `16`, and `IconSize.normal` is converted
to `m` for consistency

- **Breaking Changes: Property updates in `FormControl`, `Select`, and
`TextField` component**
([#1948](#1948)) by
@yangwooseong

- `FormControl` component no longer supports `leftLabelWrapperHeight`
props.
- `FormControl` component now supports `size` props, which is passed as
context to the child component such as `TextField` and `Select` and
specified as the size property.
- The size property of `Select` and `TextField` component changes from
enum to string literal union type. Also, `SelectSize` and
`TextFieldSize` enum are deprecated.

- **Breaking changes: Remove `testId` and related properties**
([#1971](#1971)) by
@sungik-choi

No longer supports `testId` and related properties(e.g.
`wrapperTestId`). `testId` is a property used internally by the library
for testing with testing-library (`getByTestId`). We don't see a need to
expose this as a public API, so we remove it.

If you were using it, please replace it with the `data-testid` property.
See <https://testing-library.com/docs/queries/bytestid/>.

- **Breaking Changes: Property updates in `FormControl` component**
([#1935](#1935)) by
@yangwooseong

No longer support `as` and `interpolation` property. Replace any usage
of `interpolation` property with appropriate `style` or `className`
implementations.

- **Breaking Changes: Property updates in `Select` component**
([#1913](#1913)) by
@sungik-choi

- No longer support `as` and `interpolation` property. Replace any usage
of `interpolation` property with appropriate `style` or `className`
implementations.
- No longer support `dropdownInterpolation` property. Replace any usage
of `dropdownInterpolation` property with appropriate `dropdownStyle` or
`dropdownClassName` implementations.
- The type of `zIndex` property is changed to a z-index token. (e.g.
`"modal"`)

- **Breaking Changes: Reorganizing `SectionLabel` component**
([#1936](#1936)) by
@sungik-choi

`SectionLabel` is a complex component that can be used both in the form
of an accordion and as a simple heading. To better meet the needs of
both, we've changed the internal implementation of the component.

We've also made changes to make styling overrides as predictable as they
are for other components. The style override property, which was
unnecessarily open, is now removed.

- Remove the internal div wrapper. `style`, `className` properties are
now injected into the component instead of the old `wrapperStyle`,
`wrapperClassName`.
- No longer support `as` and `interpolation` property. Replace any usage
of `interpolation` property with appropriate `style` or `className`
implementations.
- No longer support additional style properties of `wrapper`,
`contentWrapper`, `leftWrapper` and `rightWrapper`.
- No longer support `divider` property. Replace it by adding `Divider`
component to the component's before.
- The side content property is changed. It is no longer possible to
override `iconColor`.
- When injecting `onClick` handler, the root element now behaves as a
`button` element. This change is to better support keyboard focus
control.

- **Breaking Changes: Property updates in `Emoji` component**
([#1881](#1881)) by
@yangwooseong

No longer support `as` and `interpolation` property. Replace any usage
of `interpolation` property with appropriate `style` or `className`
implementations.

- **Breaking Changes: Property updates in `Radio` component**
([#1923](#1923)) by
@sungik-choi

No longer support `as` and `interpolation` property. Replace any usage
of `interpolation` property with appropriate `style` or `className`
implementations.

- **Breaking Changes: Deprecated modules for internal use**
([#1963](#1963)) by
@sungik-choi

    -   No longer provides `useEventHandler` and `useMergeRefs` hook.
- No longer provides `useId` hook. Use `useId` hook of `react` instead.
- No longer provides `getRootElement` hook. Use `useWindow` hook
instead.
    -   No longer provides `StyleUtils` and `StringUtils` utils.

- **Breaking Changes: Property updates in `ProgressBar` component**
([#1947](#1947)) by
@sungik-choi

- No longer support `as` and `interpolation` property. Replace any usage
of `interpolation` property with appropriate `style` or `className`
implementations.
- No longer support `activeStyle`, `activeClassName` and
`activeInterpolation` property.
    -   No longer support `activeTestId` property.

- **Breaking Changes: Property updates in `Tabs`-related components**
([#1960](#1960)) by
@sungik-choi

No longer support `as` and `interpolation` property. Replace any usage
of `interpolation` property with appropriate `style` or `className`
implementations.

- **Breaking Changes: Property updates in `Text` component**
([#1820](#1820)) by
@sungik-choi

`typo` prop in the `Text` component has been changed to accept only
string literals in order to simplify the API and improve the
predictability of text styling, particularly in the context of the
removal of `styled-components` from `bezier-react`, which has led to the
unavailability of CSS Interpolation.

    **Migration Instructions:**

Use
[`v2-text-component-interface`](https://github.com/channel-io/bezier-react/tree/alpha/packages/bezier-codemod#change-interface-of-text)
transformer from `bezier-codemod` for automated migration.

- **Breaking Changes: Reorganizing `KeyValueListItem` component**
([#1941](#1941)) by
@sungik-choi

    -   **Renamed to `KeyValueItem`.**
- - No longer support `interpolation` property. Replace any usage of
`interpolation` property with appropriate `style` or `className`
implementations.
- No longer support `valueWrapperStyle`, `valueWrapperClassName`,
`valueWrapperInterpolation`, `keyWrapperStyle`, `keyWrapperClassName`
and `keyWrapperInterpolation`. This decision was made to reduce
excessive flexibility in the interface.
- No longer support `AdditionalColorProps` and `show` property of
ItemAction.
- The icon inside ItemAction is now implemented through `Button`
component.
- The Value Container will now always have 100% of the parent's width.

- Add new margin properties to `Icon` component
([#1863](#1863)) by
@yangwooseong

    -   `margin`
    -   `marginHorizontal`
    -   `marginVertical`

- **Breaking Changes: Property updates in `NavItem` and `NavGroup`
component**
([#1905](#1905)) by
@yangwooseong

No longer support `as` and `interpolation` property. Replace any usage
of `interpolation` property with appropriate `style` or `className`
implementations.

- **Breaking Changes: The enum type that the component receives as props
is changed to a string literal type**
([#2059](#2059)) by
@yangwooseong

    The properties that change are:

    -   `AvatarSize`
    -   `BannerVariant`
    -   `ButtonColorVariant`, `ButtonStyleVariant`, `ButtonSize`
    -   `EmojiSize`
    -   `SegmentedControlSize`
    -   `TabSize`
    -   `ListItemVariant`, `ListItemSize`
    -   `StatusType`, `StatusSize`

When changed to string literal type, it is changed to the kebab-cased
value of enum. e.g. `ButtonStyleVariant.MonoChromeDark` ->
`monochrome-dark`, `StatusType.OnlineCrescent` -> `online-crescent`

- **Breaking Changes: Property updates in `Modal`-related components**
([#1903](#1903)) by
@sungik-choi

    -   No longer supports `as` and `interpolation` props.
- The type of `zIndex` property is changed to a z-index token. (e.g.
`"modal"`)

- **Breaking Change: Removal of `LegacySegmentedControl` Component**
([#1786](#1786)) by
@sungik-choi

We have removed the `LegacySegmentedControl` component from our library.
This change follows its deprecation in `next-v1.204`.

    **Reasons for Removal:**

    -   To enhance web accessibility and improve keyboard navigation.
- To align with our goals of design modernization and consistent user
experience.

    **Impact:**

`LegacySegmentedControl` component is no longer available and cannot be
used in your projects. Replace all instances of `LegacySegmentedControl`
with `SegmentedControl` component.

- **Breaking Changes: Property updates in `LegacyStack` components**
([#1944](#1944)) by
@sungik-choi

- No longer support `interpolation` property. Replace any usage of
`interpolation` property with appropriate `style` or `className`
implementations.
    -   No longer export `AxisAlignment` type.

- **Breaking Changes: Property updates in `TextField` component**
([#1904](#1904)) by
@sungik-choi

- No longer support `interpolation`-related properties. Replace any
usage of `interpolation` -related properties with appropriate `***style`
or `***className` implementations.
- No longer support `inputStyle` and `inputClassName` properties.
Replace any usage of `inputStyle` and `inputClassName` with appropriate
`style` or `className` implementations.
    -   Change the value of `TextFieldVariant` enum value to string.

- **Breaking Changes: Remove the default offset(`GNB_WIDTH`) in
`Toast`**
([#2117](#2117)) by
@sungik-choi

Remove the style because it was dependent on a specific application. Use
`{ left: 68 }` instead.

- **Breaking Changes: Property updates in `Banner` component**
([#1891](#1891)) by
@sungik-choi

No longer support `as` and `interpolation` property. Replace any usage
of `interpolation` property with appropriate `style` or `className`
implementations.

    **Other changes in `Banner` component**

    -   now supports HTML attributes.
    -   now supports style props.

- **Breaking Change: Removal of `LegacyRadio` Component**
([#1943](#1943)) by
@sungik-choi

- `LegacyRadio` component has been removed from the library. Please use
`RadioGroup` and `Radio` component instead.
- Now if `Radio` has no label, its size is reduced by an indicator.

- **Breaking Changes: Property updates in `Checkbox` component**
([#1918](#1918)) by
@sungik-choi

No longer support `interpolation` property. Replace any usage of
`interpolation` property with appropriate `style` or `className`
implementations.

- **Breaking Changes: Property updates in `Switch` component**
([#1885](#1885)) by
@yangwooseong

No longer support `as` and `interpolation` property. Replace any usage
of `interpolation` property with appropriate `style` or `className`
implementations.

- Export the css style sheet for the new design system.
([#1492](#1492)) by
@sungik-choi

- **Breaking Changes: Reorganizing `OutlineItem` component**
([#1930](#1930)) by
@sungik-choi

`OutlineItem` component was originally designed as a component to draw a
tree-like view, _but it was not used as intended in production_. We
simplified the component's responsibilities by removing unused
properties while retaining the component's ability to apply indentation
to subcomponents.

- No longer support `paddingLeft` property. **By default, 6px of left
padding has been added.** If you need to make changes, override the
style.
- No longer support `interpolation` property. Replace any usage of
`interpolation` property with appropriate `style` or `className`
implementations.
- No longer support `iconStyle`, `iconClassName`, `iconInterpolation`,
`contentStyle`, `contentClassName` and `contentInterpolation`. This
decision was made to reduce excessive flexibility in the interface.
- No longer support `leftIcon` property. Removed for consistency with
other component interfaces. Replace it to `leftContent`.
    -   No longer support `leftIconColor` and `leftIconTestId` property.
- No longer support `name` property. The second argument (name) of
`onClick` is also removed. If you need an identifier, combine functions
outside of the component.
- No longer support `hide`, `optionKey` and `disableIconActive`
property. Replace `hide` property with conditional rendering.
- No longer support `onOpen`, `onClickArrow`, `selectedOutlineItemIndex`
and `onChangeOption` property.

- **Breaking Changes: Property updates in `Slider` component**
([#1883](#1883)) by
@yangwooseong

- No longer support `as` and `interpolation` property. Replace any usage
of `interpolation` property with appropriate `style` or `className`
implementations.
- `dir` type is narrowed from `string | undefined` to `ltr | rtl |
undefined`

- **Breaking Changes: Property updates in `Button` component**
([#1882](#1882)) by
@sungik-choi

- No longer support `interpolation` property. Replace any usage of
`interpolation` property with appropriate `style` or `className`
implementations.
- `ButtonSize` and `ButtonColorVariant` enums have been updated to use
kebab case.

- **Breaking Change: No longer supports `smoothCorners` mixin. Use
`AlphaSmoothCornersBox` components instead.**
([#1892](#1892)) by
@sungik-choi

    ```tsx
    // Before
    const Box = styled.div`
      ${smoothCorners({
        borderRadius: 10,
        shadow: '0 5px 15px 0 var(--shdw-large)',
        shadowBlur: 15,
        backgroundColor: 'var(--bgtxt-absolute-white-dark)',
        hasBackgroundImage: true,
      })}
    `

    <Box>...</Box>

    // After
    <AlphaSmoothCornersBox
      borderRadius={10}
      shadow={{
        offsetX: 0,
        offsetY: 5,
        blurRadius: 15,
        spreadRadius: 0,
        color: 'shdw-large',
      }}
      backgroundColor="bgtxt-absolute-white-dark"
      backgroundImage="..."
    >...</AlphaSmoothCornersBox>
    ```

- **Breaking Changes: `Toast`-related modules**
([#1950](#1950)) by
@sungik-choi

- No longer support `actionContent` and `onClick` properties in
`ToastOptions`.
- Value type of `zIndex` property in `ToastOptions` is changed from
`number` to `ZIndex` token.
    -   No longer export `ToastIconColor` enum.

- **Breaking Changes: Property updates in `TextArea` component**
([#1914](#1914)) by
@sungik-choi

- No longer support `as` and `interpolation` property. Replace any usage
of `interpolation` property with appropriate `style` or `className`
implementations.
- No longer support `wrapperStyle`, `wrapperClassName` and
`wrapperInterpolation` property. It was never properly implemented
before, and the Wrapper element inside was also removed.

- **Breaking Changes: Deprecate support for `styled-components` related
modules**
([#1962](#1962)) by
@sungik-choi

- No longer support legacy foundation modules. Use the `useToken` hook
and components to replace it
        -   `LightFoundation` and `DarkFoundation`
        -   `Spacing`
        -   `ev1`, `ev2`, `ev3`, `ev4`, `ev5` and `ev6`
- `createThemes`, `Theme`, `SemanticNames`, `LightTheme` and `DarkTheme`
        -   `TransitionDuration` and `Transition`
        -   `Border`
- `Typography`, `TypoAbsoluteNumber`, `LineHeightAbsoluteNumber` and
`TypographyType`
- `absoluteCenter`, `disableAutoMinimum`, `hideScrollbars` and
`ellipsis`
        -   `ThemeVarsAdditionalType` and `ThemeVars`
        -   `GlobalStyle`
        -   `Foundation`
        -   `GlobalStyleProp`
- `createGlobalStyle`, `styled`, `css`, `FoundationProvider`,
`useFoundation`, `keyframes`, `StyleSheetManager` and `ServerStyleSheet`
- No longer support `BezierProvider`. Use the `AppProvider` instead
- No longer support `gap` and `touchableHover` mixins. Please implement
and use your own

    ```tsx
    function gap(spacing: number): InjectedInterpolation {
      return css`
        gap: ${spacing}px;

        @supports not (gap: ${spacing}px) {
          margin-top: ${-spacing}px;
          margin-left: ${-spacing}px;

          > * {
            margin-top: ${spacing}px;
            margin-left: ${spacing}px;
          }
        }
      `;
    }

    function touchableHover(
      interpolation: InjectedInterpolation,
    ): InjectedInterpolation {
      return css`
        @media (hover: hover) {
          &:hover {
            ${interpolation}
          }
        }

        @media (hover: none) {
          &:active {
            ${interpolation}
          }
        }
      `;
    }
    ```

- No longer support `inputTextStyle`, `inputPlaceholderStyle`,
`inputWrapperStyle`, `focusedInputWrapperStyle` and
`erroredInputWrapperStyle`. Please migrate using
`@channel.io/bezier-codemod`'s `v2-interpolation-to-css-variable`
transformer.

- **Breaking Changes: `AlphaStack` component has been changed to a
`Stack` component, and `Stack` component has been changed to
`LegacyStack` component.**
([#1837](#1837)) by
@sungik-choi

Changes to remove the dependency of `Stack` and `StackItem` to allow
stack layouts to be configured without additional DOM elements. And
improved the existing `AlphaStack` to support more Flex layout related
properties like reverse, wrap, and more align options, etc. See
StackProps for more information.

We also added new `HStack` and `VStack` components, which are shorthand
components that fix the direction prop of `AlphaStack`. As mentioned
above, the existing components become `LegacyHStack`, `LegacyVStack`.

The layout implemented by `StackItem` can be partially replaced by the
Layout component's `grow`, `shrink` common properties and margin common
properties. Note that the `align`, `justify` (align-self, justify-self
in CSS flex) properties provided by `StackItem` are not provided by the
Layout component.

    ```jsx
    /* AS-IS */
    return (
      <Stack
        direction="horizontal"
        spacing={8}
        style={{ width: 300, height: 50 }}
      >
        <StackItem grow shrink weight={1} />
        <StackItem weight={0} size={10} marginBefore={20}>
          <Stack direction="vertical" />
        </StackItem>
      </Stack>
    );

    /* TO-BE */
    return (
      <Stack direction="horizontal" spacing={8} width={300} height={50}>
        <Box grow={1} shrink={1} />
        <Stack direction="vertical" shrink={0} width={10} ml={12} />
      </Stack>
    );
    ```

The changes also apply to other components that use `Stack` internally,
and there are a few breaking changes.

- `RadioGroup`, `ButtonGroup`, `FormGroup` no longer support `as` prop.

- **Breaking Change: Removal of `ListMenuTitle` Component**
([#1900](#1900)) by
@yangwooseong

    -   It was no longer being managed or utilized by our designers.
- If you are currently using `ListMenuTitle` in your application, please
replace it with the `SectionLabel` component for similar functionality.

### Minor Changes

- Implement multi theme feature based on data attributes
([#1756](#1756)) by
@sungik-choi

- Move `@channel.io/bezier-tokens` from dev depdency to dependency
([#1985](#1985)) by
@sungik-choi

- Add the `TooltipPrimitive` component, which is the same as the
[`Tooltip` component in
radix-ui](https://www.radix-ui.com/primitives/docs/components/tooltip).
You can use it by importing it from the `/alpha` path.
([#2049](#2049)) by
@sungik-choi

    ```tsx
    import {
      TooltipPrimitive,
      TooltipPrimitiveArrow,
      TooltipPrimitiveContent,
      TooltipPrimitivePortal,
      TooltipPrimitiveProvider,
      TooltipPrimitiveTrigger,
    } from "@channel.io/bezier-react/alpha";
    ```

- When you pass a value of number type to the dimension-related
properties of margin prop and layout prop, they implicitly add px units
as a suffix. See:
<https://react.dev/reference/react-dom/components/common#common>
([#1823](#1823)) by
@sungik-choi

- Add `Box` component. `Box` component is responsible for the primitive
layout and provides easy access to the design tokens in the design
system ([#1785](#1785))
by @sungik-choi

    ```tsx
<Box width="100px" height="100px" p="6px" m="6px"
bgColor="bg-black-light" />
    ```

- Fixes style inheritance issues by explicitly giving CSS custom
properties an initial value
([#1846](#1846)) by
@sungik-choi

- Apply bezier-tokens to bezier-react's style sheet and fix some invalid
css selector
([#1495](#1495)) by
@sungik-choi

- Add the `DialogPrimitive` component, which is the same as the
[`Dialog` component in
radix-ui](https://www.radix-ui.com/primitives/docs/components/dialog).
You can use it by importing it from the `/alpha` path.
([#2049](#2049)) by
@sungik-choi

    ```tsx
    import {
      DialogPrimitive,
      DialogPrimitiveClose,
      DialogPrimitiveContent,
      DialogPrimitiveDescription,
      DialogPrimitiveOverlay,
      DialogPrimitivePortal,
      DialogPrimitiveTitle,
      DialogPrimitiveTrigger,
    } from "@channel.io/bezier-react/alpha";
    ```

- `ButtonGroup` now supports HTML attributes
([#1890](#1890)) by
@sungik-choi

- `Banner` will now render content even if the `content` prop is not a
string. The same applies to link-related props.
([#1972](#1972)) by
@sungik-choi

- Rename `AlphaAppProvider` to `AppProvider`
([#1834](#1834)) by
@sungik-choi

- Rename the `style.css` file to `styles.css`
([#1791](#1791)) by
@sungik-choi

- Add `align` prop to `Text` component. This prop is used to set
horizontal alignment of text
([#1820](#1820)) by
@sungik-choi

    ```tsx
    <Text align="left" />
    <Text align="center" />
    <Text align="right" />
    ```

- Remove `borderStyle` prop from Layout props
([#1848](#1848)) by
@sungik-choi

- Add `useRootElement` hook. It is only available to `WindowProvider`
children, and provides easy access to the root element of window context
value. ([#1981](#1981))
by @sungik-choi

    ```tsx
    const { window, document, rootElement } = useWindow();
    // Same as useWindow().rootElement
    const rootElement = useRootElement();
    ```

### Patch Changes

- Fixes an issue with color inheritance across components.
([#2009](#2009)) by
@sungik-choi

- Add missing default margin styles of `LegacyStackItem`
([#2004](#2004)) by
@sungik-choi

- Fixes issue with `ModalBody`, `ModalFooter` not applying styling
correctly when wrapped in other elements.
([#2017](#2017)) by
@sungik-choi

- Add `overflow: hidden` to `ListItem` component
([#2013](#2013)) by
@yangwooseong

- Fix invalid `aria-modal` value in Modal Content.
([#2052](#2052)) by
@sungik-choi

- Fix `TabAction` typography style for size M.
([#2035](#2035)) by
@sungik-choi

- Minify the CSS output
([#1791](#1791)) by
@sungik-choi

- Update background color of `TextField`'s secondary variant.
([#2016](#2016)) by
@sungik-choi

- Mute the error of `smoothCornerScript` when called twice.
([#2010](#2010)) by
@chaejunlee

- Now exports the `tokens` object from `@channel.io/bezier-tokens`.
([#1992](#1992)) by
@sungik-choi

- Adds icon and typo size for avatar size `"72"`, which were missing
from `AvatarGroup`.
([#2071](#2071)) by
@sungik-choi

- Add missing `overflow: hidden` style to item wrapper of `KeyValueItem`
component.
([#2036](#2036)) by
@sungik-choi

- Fixes `Overlay` not closing in other windows.
([#2037](#2037)) by
@sungik-choi

- Fixes a bug where onHide is called when clicking inside the overlay,
causing the overlay to close.
([#1977](#1977)) by
@yangwooseong

- Fix invalid style migrations of `Tabs` component.
([#2014](#2014)) by
@sungik-choi

- Add missing spreading props to `ThemeProvider` and related components.
([#1986](#1986)) by
@sungik-choi

- Fix `ListItem`'s left icon color specificity issue.
([#2018](#2018)) by
@sungik-choi

- Fix `Badge` component style issue
([#2068](#2068)) by
@yangwooseong

- Fixes an issue where multi line truncated in `Text` was not being
applied. ([#1994](#1994))
by @sungik-choi

-   Updated dependencies
    -   @channel.io/[email protected]

## @channel.io/[email protected]

### Minor Changes

- Changes in `v2-text-component-interface` codemod
([#1932](#1932)) by
@yangwooseong
Previously, both the component name and the name of the property were
checked, but now only the name of the component property is checked.

- Add codemod for Stack component
([#1836](#1836)) by
@yangwooseong

- Add more various cases to `v2-enum-member-to-string-literal`
([#2059](#2059)) by
@yangwooseong

- Fix typo in `v2-z-index-interpolation-to-css-variable` codemod. It now
transforms `${ZIndex.Float}` enum to `var(--z-index-floating)`, not
`var(--z-index-float)`.
([#1924](#1924)) by
@yangwooseong

- Add codemod to transform interface of `Text` component
([#1849](#1849)) by
@yangwooseong

- Enhancement in `v2-foundation-to-css-variable-transition` codemod
([#1917](#1917)) by
@yangwooseong

- It will properly remove import statement if it converts code where
`TransitionDuration` is used.

- Changes in `v2-remove-alpha-from-alpha-stack` transform
([#1894](#1894)) by
@yangwooseong

    -   It is renamed as `v2-remove-alpha-from-alpha-components`.
    -   It covers `AlphaCenter` as well.

- Add `v2-foundation-to-css-variable-spacing` codemod to convert the
foundation's spacing variable to pixels
([#1907](#1907)) by
@yangwooseong

    This transforms

    ```tsx
    import { styled } from "@channel.io/bezier-react";

    export const Wrapper = styled.div`
      padding: ${({ foundation }) => foundation?.spacing.s5};
    `;
    ```

    into

    ```tsx
    import { styled } from "@channel.io/bezier-react";

    export const Wrapper = styled.div`
      padding: 12px;
    `;
    ```

- Changes in `v2-**-interpolation-to-css-variable` transform.
([#1928](#1928)) by
@yangwooseong

- it is renamed to `v2-interpolation-to-css-variable-**`. e.g.
`v2-interpolation-to-css-varable-input`,
`v2-interpolation-to-css-variable-typography`, and so on
- it provides integrated transform named
`v2-interpolation-to-css-variable` that handles all interpolation
transform

- Enhance `import-styled-from-styled-component` codemod to cover other
APIs from `styled-components`
([#1852](#1852)) by
@yangwooseong

- Add `Typography` transform logic to interpolation codemod
([#1841](#1841)) by
@yangwooseong

- Add v2 prefix to codemods related to major version 2
([#1844](#1844)) by
@yangwooseong

- Add codemod for z-index interpolation and enum
([#1845](#1845)) by
@yangwooseong

- Add more various cases to `v2-enum-member-to-string-literal`. Now it
covers following enums.
([#2059](#2059)) by
@yangwooseong

    -   `AvatarGroupEllipsisType`
    -   `IconSize`
    -   `LegacyTooltipPosition`
    -   `ModalTitleSize`
    -   `OverlayPosition`
    -   `ProgressBarSize`, `ProgressBarVariant`
    -   `SpinnerSize`
    -   `SwitchSize`
    -   `TagBadgeSize`, `TagBadgeVariant`
    -   `TextAreaHeight`
    -   `TextFieldSize`, `TextFieldVariant`
    -   `ToastPlacement`, `ToastAppearance`, `ToastPreset`
    -   `TooltipPosition`

- Add `inputPlaceholderStyle` migration logic to
`v2-input-interpolation-to-css-variable` codemod
([#1926](#1926)) by
@yangwooseong

- Add transform functions to help to migrate foundation to css variable
generated by `@channel.io/bezier-tokens` package. They cover theme,
transition, elevation, rounding, and border of foundation
([#1781](#1781)) by
@yangwooseong

- Added a codemod to switch the library for importing 'styled' object
from @channel.io/bezier-react to styled-components
([#1789](#1789)) by
@yangwooseong

- Add codemod for mixin interpolation
([#1787](#1787)) by
@yangwooseong

### Patch Changes

- Fix bug in `v2-import-from-bezier-to-styled-components` codemod when
there are only named imports as following:
([#1987](#1987)) by
@yangwooseong

    ```tsx
    // As-is
    import { css } from "@channel.io/bezier-react";

    // To-be
    import { css } from "styled-components";
    ```

- Fix `hasNamedImportInImportDeclaration` util to check all named
imports ([#2060](#2060))
by @yangwooseong

## @channel.io/[email protected]

### Minor Changes

- Apply deep freeze to the `tokens` object.
([#1992](#1992)) by
@sungik-choi

- Add the missing `bg-header-float` semantic color token
([#1842](#1842)) by
@sungik-choi

- Add composition tokens, such as box-shadow
([#1769](#1769)) by
@sungik-choi

- Now serving one combined styles.css file. This is a breaking change
for anyone who was importing the individual CSS files. You will need to
update your import to `@channel.io/bezier-tokens/css/styles.css`.
([#1769](#1769)) by
@sungik-choi

- Add z-index and opacity tokens
([#1766](#1766)) by
@sungik-choi

- Remove invalid radius tokens
([#1934](#1934)) by
@sungik-choi

    -   `radius-10`
    -   `radius-14`
    -   `radius-100-p`

- Fix invalid letter spacing token values
([#1821](#1821)) by
@sungik-choi

- First release
([#1685](#1685)) by
@sungik-choi

- Add categories by token to the JavaScript build file
([#1766](#1766)) by
@sungik-choi

- Remove unused tokens and add missing unit to radius tokens
([#1752](#1752)) by
@sungik-choi

### Patch Changes

- Remove duplicate styles in styles.css
([#1779](#1779)) by
@sungik-choi

## [email protected]

### Minor Changes

- Upgrade to use @channel.io/[email protected]
([#2001](#2001)) by
@sungik-choi

### Patch Changes

- Enhance icon extract logic by catching error
([#2073](#2073)) by
@yangwooseong

-   Updated dependencies
    -   @channel.io/[email protected]

## @channel.io/[email protected]

### Minor Changes

- Create a package to support autocomplete for Bezier Design Tokens
([#2091](#2091)) by
@yangwooseong

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bezier-codemod Issue or PR related to bezier-codemod feat Issue or PR related to a new feature
Projects
No open projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Writing code to convert foundation interpolation to CSS Variable
2 participants