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.

Sign up for GitHub

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

Jump to bottom

[Feature/28] checkstyle action 기반으로 lint 검사기 구현 #35

Merged
merged 12 commits into from
Mar 3, 2024
Merged

[Feature/28] checkstyle action 기반으로 lint 검사기 구현 #35

merged 12 commits into from
Mar 3, 2024

Conversation

luke0408
Copy link
Member

@luke0408 luke0408 commented Mar 2, 2024

Type of change

  • Feature : 새로운 기능 추가
  • Bug fix : 버그 수정
  • Refactor : 코드 리팩토링 작업
  • Document : 문서작업
  • Test : 테스트 코드 작성 및 테스트 작업
  • Style : 코드 스타일 및 포맷팅 작업
  • CI/CD : CI/CD 작업 수정
  • Chore : 패키지 매니저, 라이브러리 업데이트 등의 작업

PR Desciption

변경 사항 설명

  • 코드 스타일 적용
    • 네이버 캠퍼스 핵데이 코딩 컨벤션 기반 컨벤션에서 커스텀을 했으며 이와 관련한 내용은 노션에 작성하겠습니다.
    • .editorconfig : 인텔리제이 외의 툴에서도 공유 가능한 root 설정
    • .gitattributes : github push 시에 적용 되는 공유 설정
    • namo-intellij-formatter.xml : 인텔리제이에서 사용될 커스텀 코드 포메터 설정 파일
    • namo-checkstyle-rule.xml : checkstyle을 위한 커스텀 린트 설정 파일
    • namo-checkstyle-suppressions.xml : checkstyle의 예외 사항을 정리한 파일

  • 코드 스타일 적용
    • checkstyle 플러그인 지원 기능을 통해 전체 코드에 대한 자동 포멧팅 진행
    • 코드 스타일과 설정 적용 방법에 대해서는 노션에서 다루겠습니다.

  • checksytle 기반 java lint 관리 workflow 작성

Requirements for Reviewer

리뷰어가 특별히 봐주었으면 하는 부분이 있다면 작성해주세요
ex) 메서드 XXX의 이름을 더 잘 짓고 싶은데 혹시 좋은 명칭이 있을까요?

  • x

PR Log

PR 작업하면서 고민했던 내용, 해결한 내용, 고민 중인 내용 등

새롭게 배운 것

  • 코드 포멧팅 작성 및 설정 방법
  • github action을 통해 lint 검사를 진행하는 방법

고민 중인 사항

  • 코드 스타일을 어디까지 지키도록 할 것인지

첨부 자료

관련 이슈

luke0408 added 8 commits March 2, 2024 18:43
@luke0408
🎨 Style: gitattributes file 작성
db45ae9 
<body>
- gitattributes
  - 새줄 문자가 LF로 변환 될 수 있도록 설정

<footer>
- 관련: #28
@luke0408
🎨 Style: editorconfig
f99ae60 
<body>
- editorconfig
  - editor 단위의 코드 style 설정 파일

<footer>
- 관련: #28
@luke0408
🎨 Style: intellij formatter 작성
0263acf 
<body>
- namo-intellij-formatter.xml
  - intellij 에서 사용될 코드 포매팅 스팩 작성
  - naver 캠퍼스 헥데이 java 코딩 컨벤션의 스팩을 기반으로 하며 import 관련 설정이 변경됨

<footer>
- 관련: #28
@luke0408
🎨 Style: checkstyle rules 작성
3f9894e 
<body>
- namo-checkstyle-rule.xml
  - checkstyle 플러그인에 적용할 커스텀 룰

<footer>
- 관련: #28
@luke0408
🎨 Style: Code formatter 설정 변경
df7a822 
<body>
- 공통
  - domain 단위로 import 분리
  - jakarta 관련 import 설정 추가
- namo-intellij-formatter.xml
  - intellij 포멧 설정 적용 확인

<footer>
- 관련: #28
@luke0408
🎨 Style: 사소한 설정 수정
fd4478d 
<body>
- namo-checkstyle-rules.xml
  - import 설정 오타 수정
  - [list-uppercase-abbr] 관련 예외 단어 추가

<footer>
- 관련: #28
@luke0408
🎨 Style: 코드 포멧팅 적용
d2eb83e 
<body>
- code formatting
  - 자동 수정 기능을 이용하여 수정 진행

<footer>
- 관련: #28
@luke0408
✨ Feat: checkstyle workflow 작성
fd9cde8 
<footer>
- 관련: #28
@luke0408 luke0408 requested a review from a team as a code owner March 2, 2024 13:16
@luke0408 luke0408 requested review from galug and removed request for a team March 2, 2024 13:16
@luke0408 luke0408 linked an issue Mar 2, 2024 that may be closed by this pull request
[Feat] checkstyle action 기반으로 lint 검사기 구현 #28
Closed
5 tasks
@github-actions github-actions bot added 🎨 style 코드 스타일 관련 ✨ feature 기능 구현 관련 🔧 chore 기타 내용 labels Mar 2, 2024
github-actions[bot]
github-actions bot reviewed Mar 2, 2024
View reviewed changes
@luke0408 luke0408 merged commit 35d7795 into main Mar 3, 2024
1 check passed
@luke0408 luke0408 deleted the feature/28 branch March 3, 2024 07:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@github-actions github-actions[bot] github-actions[bot] left review comments

@galug galug galug approved these changes

Assignees

@luke0408 luke0408

Labels
🎨 style 코드 스타일 관련 ✨ feature 기능 구현 관련 🔧 chore 기타 내용
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[Feat] checkstyle action 기반으로 lint 검사기 구현
2 participants
@luke0408 @galug