개요

코드 스타일 통일을 위해 IntelliJ에 Linter와 Formatter를 적용해보았다

옛날에 파이썬 쓸 때, black, flake8같은 도구들이 매우 좋았는데 자바에는 없나 싶어서 찾아보니 있었다!

 


CheckStyle 설치

IntelliJ에서 설정 → Plugins → Marketplace에 CheckStyle 플러그인 설치

나는 이미 설치되어있어서 Installed에 있지만 Marketplace에서 설치해야한다.

 

 


Linter(CheckStyle), Formatter(Code Style) 적용

네이버 캠퍼스 핵데이 Java 코딩 컨벤션

1. Formatter (Code Style)

naver-intellij-formatter.xml 설치

설정 → Editor → Code Style → Java에서 설치한 naver-intellij-formatter.xml import

적용

 

2. Linter (CheckStyle)

naver-checkystyle-rules.xml, naver-checkstyle-suppressions.xml 설치

설정 → Tools → Checkstyle에서 설치한 naver-checkstyle-rules.xml import

next → 설치한 naver-checkstyle-suppressions.xml 등록

주의점!! CheckStyle 버전을 8.24로 해야한다고 한다.

 


Google Java Style

1. Formatter (Code Style)

intellij-java-google-style.xml 설치

설정 → Editor → Code Style → Java에서 설치한 intellij-java-google-style.xml import

  •  

적용

2. Linter (CheckStyle)

google_checks.xml 설치

설정 → Tools → Checkstyle에서 설치한 google_checks.xml import

별도의 Property 작성이나 버전 변경 없이 그대로 사용

참고사항!! Missing JavaDoc Warning은 표시하고 싶지 않을 때

설치한 google_checks.xml에서 이 부분에 위처럼 작성

 


Reference

https://velog.io/@geun/Intellij-Formatter-Checkstyle-세팅하기

 

[Intellij] Formatter, Checkstyle 세팅하기!

Formatter, Linter를 적용해서 클린 코드를 작성해봅시다..!

velog.io

https://naver.github.io/hackday-conventions-java/#class-noun

 

캠퍼스 핵데이 Java 코딩 컨벤션

중괄호({,}) 는 클래스, 메서드, 제어문의 블럭을 구분한다. 5.1. K&R 스타일로 중괄호 선언 클래스 선언, 메서드 선언, 조건/반복문 등의 코드 블럭을 감싸는 중괄호에 적용되는 규칙이다. 중괄호

naver.github.io

https://stackoverflow.com/questions/23868476/how-to-fully-disable-javadoc-checking-with-checkstyle-maven-plugin

 

How to fully disable javadoc checking with checkstyle maven plugin

i want to use the Maven Checkstyle plugin with a custom configuration that tells Checkstyle to not warn or error on missing Javadoc. Is there a way to do this?

stackoverflow.com

 

# 개요

IntelliJ에서 No Matching in any candidates test task 뜨면서 테스트가 안 되는 상황이 발생하면서

간단하게 정리하고 다음에 또 찾아보지 않게 기록함


# 상황

다른 로컬에서 작업하다가 노트북에서 이어서 작업해야해서 Github에 올려놓고 노트북에서 pull 이후에 테스트를 실행했는데 이런 에러가 뜨면서 테스트 실행이 안된다.


# 해결

정확히는 모르겠지만 Gradle 프로젝트라서 발생한 오류같다. 찾아보니 Settings → Build, Execution, Deployment → Build Tools → Gradle에서 Run tests using을 Gradle에서 IntelliJ로 바꿔주면 된다고 한다.

Gradle로 되어있는 부분을 IntelliJ로 변경

주의할점

변경했다고 바로 Alt + Shift + X 눌러서 최근 실행 다시 실행 하지 말고 Ctrl + F10으로 실행해야한다.

근데 한글은 왜깨져;;

 

IntelliJ와 git bash 연동하기

Window에서 IntelliJ를 처음 설치하면 기본 터미널은 윈도우 cmd이다.

윈도우 기본 cmd 특) ls 안됨 ㅂㄷㅂㄷ

기본 cmd에서도 git 명령어가 안 되는 것은 아니지만 그래도 git bash가 더 가시성도 좋고 현재 branch도 표시를 해주니까 git bash로 변경해보자.

 

Ctrl + Alt + S → Tools → Terminal

Ctrl + Alt + S키는 Settings인데 (File → Settings도 가능) 여기서 Tools → Terminal 탭을 보면 Shell path가 cmd.exe이다. 이것을 git bash로 바꿔주면 끝!

 

 

 

 

"git bash path" -login -i

본인의 sh.exe파일은 git/bin 디렉토리에 있다. 본인 로컬의 git 경로를 찾아서 넣어주고, 경로에 쌍 따옴표(" ")를 붙여주고 -login, -i를 붙여주면 된다.

"C:\Program Files\Git\bin\sh.exe" -login -i

 

 

 

 

설정 후 터미널 창을 열면 git bash가 잘 나온다

참 쉽죠?

'Etc' 카테고리의 다른 글

인증/인가 - Session vs Token  (0) 2024.07.05
내가 배운 팀 프로젝트 협업 1 - 코딩 컨벤션  (0) 2021.10.17

+ Recent posts