[IntelliJ] Code Style 설정

혼자서 개발을 진행 할 때는 들여쓰기가 2개든 4개든 상관이 없습니다. 하지만, 여러 명에서 같이 작업을 하게 된다면 문제가 됩니다.
각자의 스타일이 다 다르기 때문에 코드가 눈에 잘 안들어오기도 할 뿐더러, Auto Formatting을 설정해 놓았다면 설정 해놓은 코드 스타일대로 변경이 되면서 변경된 것도 없는데 Git에 변경된 걸로 감지 되게 됩니다.
그런 상태로 Pull Request를 요청하게 되면 실제 코드가 변경된 파일과 스타일만 변경된 파일을 구분하기가 쉽지 않습니다.
이런 경우를 방지 하고자 코드스타일을 맞추고 개발을 진행하게 됩니다.
언어마다 다르지만 보통 특정 회사(Google, Airbnb 등)의 코드 스타일을 따라 갑니다.
IntelliJ에서는 그런 설정을 쉽게 할 수 있도록 지원합니다.

Code Style 적용

저는 Kotlin을 사용하고 있기 때문에 Kotlin을 적용하지만, 다른 언어들도 동일하게 적용하면 됩니다.

Preference -> Editor -> Code Style -> Kotlin -> Set From -> Kotlin style guide

Kotlin style guide: Kotlin 공식 사이트 에서 제공하는 컨벤션 입니다.

Auto Formatting(option + command + L)을 해보면 적용 된 걸 알 수 있습니다.

Kotlin 추가 스타일 적용

Preference -> Editor -> Code Style -> Kotlin -> Wrapping and Braces 에서 추가적으로 원하는 스타일을 적용 할 수 있습니다.

저는 Align 'when' branches in columns를 체크 하였습니다.

val a = "a"

when (a) {
	"a" -> println("a")
	"abcabc" -> println("b")
}

위와 같이 ->의 위치를 일정하게 만들어 줍니다.

Java 추가 스타일 적용

Preference -> Editor -> Code Style -> Java -> Wrapping and Braces 에서 추가적으로 원하는 스타일을 적용 할 수 있습니다.

Java의 경우 Simple ~~~ 되어 있는 부분을 다 체크 했습니다.

간단한 한줄 짜리 코드 일 경우 줄 한 줄로 나타나게 하는 옵션 입니다.

Auto Formatting 전에 잘못 된 부분 확인하기

Preference -> Editor -> Inspections -> Kotlin ->
Style issues -> File is not formatted according to project settings 체크

File is not formatted according to project settings 체크

해당 프로젝트가 아닌 IDE 전체에 적용하고 싶다면 Profile을 Stored In IDE -> Default로 선택 한 뒤 설정 하면 됩니다.

적용 전

적용 후

:은 한칸을 뛰어야 하므로 Waring이 발생한 걸 볼수 있습니다.

Waring 대신 Error 발생으로 만들기

Waring 보다 더 강력하게 확인하기 위해서 Error로 변경하려면 Severity을 변경해주시면 됩니다.

저장 시 Auto Formatting 되도록 설정

지금까지 Auto Formatting 후 저장을 하기 위해서는 option + command + L을 누른 후 command + S를 눌러야 했습니다.

이제는 저장(command + S)만 눌러도 Auto Formatting 후 저장이 되도록 설정해 보겠습니다.

Macros 설정

Macros를 통해 Auto Formatting과 저장을 하나로 묶어 줍니다.

상단의 Edit -> Macros -> Start Macro Recording

클릭 후, Auto Formatting 후 저장을 눌러 녹화해 준 뒤 녹화를 정지합니다.

option + command + L -> command + S -> Stop Macro Recording

해당 녹화본에 대해 원하는 이름을 설정합니다.

키 매핑

Preference -> Keymap -> Auto Formatting And Save(위에서 설정한 이름) 입력 ->Add KeyBoard Shortcut -> command + S -> Save -> Remove(기존에 command + S 를 사용중이던 키 매핑을 삭제합니다)

이후, 저장(command + S)를 해보면 Auto Formatting 후 저장이 됩니다.

Inlay Hints (꿀팁)

Inlay Hints를 사용하면 어떤 파라미터 값을 넘겨야하는지 같은 힌트를 볼 수 있습니다.

Preferences -> Editor -> Code Style -> Inlay Hints -> Kotlin

자바에서 유용한 옵션

Usages 옵션을 체크하면 해당 코드가 어디에 얼마나 쓰이고 있는지 알려주며, 클릭 시 사용중인 파일 목록을 보여줍니다.

참고 사이트

IntelliJ Kotlin Code Style 설정법