Sensei란 무엇인가요?

Sensei 플러그인은 소스 코드에서 특정 코드 패턴을 쉽게 찾고, 재작성 규칙을 적용하여 일치하는 코드를 수정할 수 있는 방법을 제공합니다. 이 모든 과정은 IntelliJ IDE 내에서 실시간으로 이루어집니다.

‍

‍

예를 들어, 사유가 명시되지 않은 JUnit `@Disabled` 어노테이션을 찾는 규칙을 만들면, Sensei는 IDE에서 해당 코드를 강조 표시하여 문제를 알려줍니다.

또한 `alt+enter`를 누르면 `Add a todo comment parameter` 옵션을 선택할 수 있습니다.

이 옵션을 선택하면 코드가 수정되어 상용구(boilerplate) 사유가 추가됩니다. 이를 직접 수정할 수 있으며, 수정하지 않을 경우 TODO 패널에 표시됩니다.

예: `@Disabled`가 `@Disabled("TODO: add a description here")`로 변경됩니다.

Sensei는 정적 분석 코드 스캐너의 기능과 코드 재작성 엔진을 결합한 도구입니다.

IntelliJ 의도 액션(Intention Actions)

위 설명에 따르면, Sensei를 사용하지 않을 경우 가장 명확한 대안은 IntelliJ의 의도 액션(Intention Actions) 기능을 사용하는 것입니다.

Sensei가 IntelliJ 의도 액션과 다른 점은 프로젝트별로, 혹은 개별 개발자 수준에서 맞춤형 매처(matcher)와 재작성 규칙을 생성할 수 있도록 설계되었다는 것입니다.

저희는 매칭 규칙과 재작성 규칙을 쉽게 작성하고 실험할 수 있는 GUI를 구현하고자 노력했습니다.

개인적인 역량 향상에 어떻게 도움이 될까요?

새로운 라이브러리를 배울 때는 메서드와 서식에 익숙해지는 데 시간이 걸립니다. 그래서 저는 다음과 같은 개인용 레시피를 만들곤 합니다.

• 공식 문서나 튜토리얼 페이지로 연결
• 가장 효과적인 상용구 템플릿 제공
• 잘못된 코딩 관행 수정
• 라이브러리 사용을 돕는 상용구 코드 추가

Sensei를 사용하여 제가 선택한 현재의 관행을 상기시키고 효과적인 습관을 기르는 데 도움이 되는 임시 레시피를 만들 수 있습니다. 이 레시피들은 더 이상 필요하지 않게 되면 삭제할 수 있어 일시적입니다.

팀의 역량 향상에 어떻게 도움이 될까요?

마찬가지로 팀이 합의된 코딩 표준을 체득하도록 도울 수 있습니다.

풀 리퀘스트 리뷰에서 반복적으로 지적되는 사항들에 대해 적용할 수 있는 레시피 쿡북을 만드는 것입니다. 쿡북은 프로젝트와 함께 버전 관리 시스템에 저장되므로 프로젝트의 모든 구성원이 사용할 수 있으며, 더 이상 알림이 필요하지 않을 때 비활성화할 수 있습니다.

Sensei는 조기에 피드백을 제공하도록 돕습니다

Sensei를 통해 우리가 구현하고자 한 것은 코딩 과정 초기에 개선에 필요한 피드백과 수정 조치에 대한 알림을 제공하는 방법입니다.

기다리는 대신

• 정적 분석 결과
• 코드 리뷰 의견

코딩하는 동안 우리가 적용하고자 하는 사용자 지정 표준에 대한 피드백을 바로 확인할 수 있습니다.

또한 표준을 준수하는 코드를 작성할 수 있도록 알림이나 실제 코드 재작성 규칙을 제공합니다.

Sensei는 유연합니다

그런 면에서 Sensei는 다음과 같은 요소들이 결합된 도구입니다.

• 정적 분석기
• 코딩 튜터
• 재작성 엔진

Sensei는 매우 유연하기 때문에 "Sensei란 무엇인가?"라는 질문에 답하기가 조금 까다로울 정도입니다.

Sensei는 프로그래밍 워크플로우의 빈틈을 채워줍니다

우리는 Sensei가 팀과 함께 작업 중인 코딩 스타일이나 라이브러리 사용법의 특정 요소를 개선하도록 돕는, 프로그래머 워크플로우의 빠진 조각이 되기를 바랐습니다.

이러한 유연성 때문에 정적 분석 도구나 IntelliJ 내장 기능보다 Sensei를 익히는 데 시간이 조금 더 걸릴 수 있습니다. 하지만 시간을 투자해 직접 경험해 본다면 개인의 개발 과정에서 학습 속도를 높이는 새로운 방법을 얻게 될 것입니다.

어떻게 시작할까요?

[Intellij Marketplace]에서 Sensei를 다운로드하여 설치한 후

Sensei를 가장 효과적으로 활용하는 방법은 자신의 코딩 과정을 살펴보고 다음을 고려하는 것입니다.

• 자주 찾아보는 문서는 무엇인가요?
  -- 해당 문서로 연결되는 Sensei 레시피를 추가할 수 있습니다.
• 반복적으로 저지르는 단순한 실수는 무엇인가요?
  -- 잘못된 코딩 패턴을 일시적으로 매처(matcher)로 정의하고, 원하는 코드로 수정해 주는 빠른 수정(Quick Fix) 기능을 작성할 수 있습니다.
• 라이브러리를 사용하기 위해 작성하는 상용구 코드는 무엇인가요?
  -- 코드를 대신 작성해 주는 빠른 수정 규칙을 만들 수 있습니다.

Sensei는 기존에 사용하는 정적 분석 도구와 함께 작동하도록 설계되었습니다. 정적 분석에서 동일한 위반 사항이 계속 보고된다면, 해당 조건을 Sensei 레시피로 재현해 보세요. 그런 다음 빠른 수정 기능을 추가하면 단순히 실수를 식별하는 것을 넘어 올바른 코드를 빠르게 작성하도록 훈련할 수 있습니다.