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

feat: support Stylelint v16 #540

Draft
wants to merge 8 commits into
base: main
Choose a base branch
from
Draft

Conversation

ybiquitous
Copy link
Member

@ybiquitous ybiquitous commented Mar 22, 2024

Which issue, if any, is this issue related to?

Closes #511

Is there anything in the PR that needs further explanation?

See https://stylelint.io/CHANGELOG#1600

Note that this PR bumps stylelint and stylelint-scss in dev deps.

@ybiquitous ybiquitous added the pr: dependencies relates to dependencies label Mar 22, 2024
@ybiquitous ybiquitous changed the title ci: test Stylelint v16 feat: support Stylelint v16 Mar 22, 2024
@ybiquitous
Copy link
Member Author

It seems that a segmentation fault error happens, related to:
https://stylelint.io/migration-guide/to-16/#jest-preset-stylelint

@ybiquitous
Copy link
Member Author

It may be timing to switch from Jest to Vitest... 🤔

@ota-meshi
Copy link
Member

I didn't know that Jest had such a problem:sweat: I think it's good to switch to Vitest if possible.

@ybiquitous
Copy link
Member Author

@ota-meshi Have you some experience of Vitest? I don't know it so much, honestly 😅

@ota-meshi
Copy link
Member

Sorry, I'm not familiar with Vitest 😅

@kizu
Copy link
Member

kizu commented May 2, 2024

Hey hey! Just want to mention that it would be really nice to make the vs code extension work with the v16 of stylelint, so we could upgrade its version in our codebase! Is there any rough ETA for when this PR could be finished?

@ybiquitous
Copy link
Member Author

@kizu I have no time to tackle this PR, including dependency problems, for now. 😓

If you are interested, you could tackle this challenge.

yangwooseong added a commit to channel-io/bezier-react that referenced this pull request Aug 21, 2024
…ken (#2412)

<!--
  How to write a good PR title:
- Follow [the Conventional Commits
specification](https://www.conventionalcommits.org/en/v1.0.0/).
  - Give as much context as necessary and as little as possible
  - Prefix it with [WIP] while it’s a work in progress
-->

## Self Checklist

- [x] I wrote a PR title in **English** and added an appropriate
**label** to the PR.
- [x] I wrote the commit message in **English** and to follow [**the
Conventional Commits
specification**](https://www.conventionalcommits.org/en/v1.0.0/).
- [x] I [added the
**changeset**](https://github.com/changesets/changesets/blob/main/docs/adding-a-changeset.md)
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) **(TODO)**
- [ ] I wrote or updated **tests** related to the changes. (or didn't
have to)
- [x] 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

<!-- Please link to issue if one exists -->

<!-- Fixes #0000 -->

- resolves #1996 

## Summary

<!-- Please brief explanation of the changes made -->

- bezier-tokens에 있는 토큰이외의 css variable을 사용했을 때 에러나 워닝을 보여주는 stylelint
config 패키지를 추가합니다.

## Details

<!-- Please elaborate description of the changes -->

- 공식 문서에는 plugin을 만들 때 export default createPlugin(...) 이런 식으로 소개하고 있는데
막상 해보면 vscode stylelint extension 에서 에러가 나는 등 문제가 있어서 polaris 코드를 참고해서
만들었습니다. 추측컨대 vscode-stylelint 쪽에서 [v16 지원을 하고 있지
않아서](stylelint/vscode-stylelint#540) stylelint
최신 문법과 호환이 안되고 있어서 발생하는 문제로 보입니다.
- V2 token (e.g. `--alpha-color-fg-black-darkest`) 까지 사용가능하게 했습니다. 
- styled-components와 scss 모두 대응이 가능합니다. styled-components는 customSyntax를
postcss-styled-syntax로 지정해서 .ts, .tsx 파일을 오버라이드했습니다.
- 테스트 코드를 작성하고 싶었으나 외부 모듈을 읽고 있어서 작성하기가 까다로워서 생략했습니다. 
- 버저닝 관리를 어떻게 해야할지는 고민입니다. bezier-token 버전이 올라갈 때마다 bezier-react 버전과
stylelint-bezier 버전이 올라가야 하고(이건 changeset이 해줌), 만약 bezier-token 에서 토큰
이름이 바뀌거나 없어진다면 bezier-react 의 peerDeps 에 있는 stylelint-bezier 버전까지
올려야합니다. 제 생각에는 peerDeps에 있는 버전을 관리하는 것은 어쩔 수 없이 수동으로 해야할 것 같은데, 혹시 다른
아이디어 있다면 부탁드립니다..! @sungik-choi


https://github.com/user-attachments/assets/1b94c6ed-e91f-444d-a8ad-e56a7e6efa79


### Breaking change? (Yes/No)

<!-- If Yes, please describe the impact and migration path for users -->

- No

## References

<!-- Please list any other resources or points the reviewer should be
aware of -->

- #2102
- https://stylelint.io/awesome-stylelint#custom-syntaxes

---------

Co-authored-by: Ed Sungik Choi <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pr: dependencies relates to dependencies
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants