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

[all] lint/prettier husky, lint-staged 적용 #722

Closed
wants to merge 3 commits into from
Closed

Conversation

choisohyun
Copy link
Contributor

@choisohyun choisohyun commented Sep 11, 2024

Related issue

close #662

Result

  • eslint, prettier 실패 시 문구

Screenshot 2024-09-11 at 10 03 02 PM
Screenshot 2024-09-11 at 10 58 47 PM

  • 성공 시 문구

Screenshot 2024-09-11 at 11 03 16 PM

Work list

  • lint, prettier에 대한 각자의 ide 설정이 다르기 때문에 제한을 두지 않으면 커밋이 가능합니다. 따라서 포맷팅이 되지 않은 상태의 코드도 머지될 수 있습니다.
  • 포맷팅이 되지 않은 경우 이후에 다른 사람의 작업물이 포맷팅되면서 diff에 포함되는 일이 발생할 수 있습니다.
  • 이것을 방지하기 위해 pre-commit 단계에서 lint, prettier 검사를 할 수 있도록 husky, lint-staged 설정을 추가합니다.
  • 각 패키지에서 실행될 수 있도록 packages/**/package.json에 설정을 추가해 주었습니다.

Discussion

  • pre-commit을 무시하고 커밋할 수 있어서 ci 단계에서도 린트검사를 하면 좋을 것 같긴 하지만..... 우선은 작게 제한두는 것으로 적용해 보았습니다
  • 이슈 둘러보다가 시작한 건데 원래 이슈랑 차이가 좀 있는 것 같긴 하네요 😅

Copy link
Contributor

@ytaek ytaek left a comment

Choose a reason for hiding this comment

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

음 허스키 적용은 전체 협의(엔진, vscode, view 모두) 후에 결정하면 좋을 것 같습니다.
이게 호불호가 있는 부분이기도 하고,
package 별로 정책이 조금씩 다르기도 하구요.

아니면 우선 engine 부분만 적용해보는건 어떨까요?

"prettier:fix": "prettier '**/*.{ts,tsx,json,yaml,md}' --write"
"prettier:fix": "prettier '**/*.{ts,tsx,json,yaml,md}' --write",
"prepare": "husky install",
"lint-staged": "npm run lint-staged --workspaces --if-present"
Copy link
Contributor

Choose a reason for hiding this comment

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

(궁금) lint-staged 는 어떤게 다른 건지요?

@xxxjinn
Copy link
Contributor

xxxjinn commented Sep 21, 2024

음 허스키 적용은 전체 협의(엔진, vscode, view 모두) 후에 결정하면 좋을 것 같습니다. 이게 호불호가 있는 부분이기도 하고, package 별로 정책이 조금씩 다르기도 하구요.

아니면 우선 engine 부분만 적용해보는건 어떨까요?

저두 이 말씀에 동의합니다.! 개인적으로 husky를 쓸 때 자꾸 정해둔 걸 까먹거나 해서 번거로운 경우가 있어서 선호하지는 않는 편이지만, 한 편으로는 오픈소스 기여라면 아무래도 여러 사람들이 커밋을 올리니 그 형식이 통일되는 것이 깔끔하고 좋을 것 같아요🙂

@ytaek
Copy link
Contributor

ytaek commented Sep 27, 2024

@choisohyun 님, 커멘트 적힌 대로 husky 적용 부분은 engine 팀과 얘기해보시고 반영 여부를 결정해주시면 감사하겠습니다!

@choisohyun
Copy link
Contributor Author

우선 close 하겠습니다!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[engine] 엔진 lint/prettier 적용
3 participants