트리플 JavaScript/TypeScript 코딩 가이드 작성
Closed this issue · 9 comments
eslint-config-airbnb의 코딩 가이드처럼 이상적인 코드에 대한 문서를 작성하고, 해당 규칙을 강제하기 위한 수단으로 ESLint를 사용합니다.
고민이 필요한 것
- prettier를 어떻게 볼 것인가?
- 각 플러그인의 추천 규칙은 어떻게 볼 것인가?
#122 의 내용과 관련이 있습니다.
저희가 협의했던 내용 + 플러그인의 기본 추천 규칙 + prettier로 초안을 만들면 어떨까요? opinionated한 standard는 제거하구요.
다음 내용도 eslint 규칙은 없지만 가이드에 추가되면 좋을 거 같습니다.
- 콜백 prop으로 전달하는 함수의 네이밍 컨벤션
- next.js 페이지 모듈 컨벤션
- next.js 쿼리 사용 컨벤션
코딩 가이드와 프레임워크 사용 가이드(React, Next.js)는 구분을 해주는 게 어떨까요? Koa.js 코드 작성할 때 위주로 필요한 컨벤션들도 있는데 구분지을 수 있으면 좋을 것 같아요!
가이드를 따로 쓰자고 마음 먹으니 각 플러그인 별 추천 규칙을 사용할지 말지 고민되네요.
자동으로 괜찮은 규칙들을 켜는 건 편해보이지만,
opinionated한 standard와 자동 수정되는 prettier까진 인정하고 가도, 선정 근거가 빈약한 추천 규칙을 추가하는 것이 가이드의 역할을 약하게 만드는 것 같습니다.
추천 규칙을 사용한다면 가이드로 규칙을 중복 관리하는 것이 비효율적인 것 같아요. 가이드엔 규칙이 따로 없는 큰 이야기만 적고 규칙은 추천 규칙에 다 위임해버리는 식이 되면 좋겠습니다.
추천 규칙 없이 standard + prettier + 이제껏 논의한 규칙으로만 간다면 standard, prettier가 커버하지 않는 규칙은 가이드가 커버해야합니다. 다음 작업이 필요하겠어요.
- 전체 규칙을 검토해보고 추가할 만한 규칙을 추려내는 작업이 필요합니다.
- 플러그인 버전이 올라갈 때마다 새로 추가된 규칙에 대한 논의 자리가 필요합니다 (renovate로 자동화할 수 있을 거 같습니다.)
고민 포인트를 정리하면
- 추천 규칙을 사용하고 가이드를 최소화하자
- 각 플러그인 별 추천 규칙을 걷어내고 가이드를 철저하게 관리하자
요 두가지 중에 선택입니당
저는 2번이 더 땡기는 것 같지만.. 가이드를 저 혼자 관리할 건 아니라 생각하여 더 많은 분들의 의견이 궁금합니당 🙇
문법이 그대로라면 2일텐데 문법은 계속 나오니 길게 보면 1이 더 나을 것 같습니다! 장투하라고 배웠습니다!
저도 2번이 탐나긴 하는데, 매번 가이드를 관리해야하는게 좀 걸리는군요.
장투의 길로 1번 가겠습니다.
추천 규칙을 사용한다고 명시하고 가이드에서 추천 규칙에서 추가했던 규칙들은 빼겠습니다~!