4편 - PhpStorm 추가 설정하기

  1. Code Style Configuration
  2. Run Configuration

주의) 컴퓨터를 어느 정도 다룰 줄 아는 독자를 대상으로 한 가이드입니다.
+ 개발 환경 구축 가이드이기 때문에, 플러그인 개발은 다루지 않습니다.

0. 시작하기 앞서...

const ENVIRONMENTAL_THINGS = [
  "플러그인 코드를 작성하기 위한 에디터 프로그램" : "PhpStorm"
];
const BIOLOGICAL_THINGS = [
  "3편 가이드가 아직 기억이 남아 있는 두뇌",
  "사진과 화면을 비교할 수 있는 정상적인 눈",
  "눌러야하는 버튼을 제대로 누를 수 있는  정상적인 손가락"
];

이번 편은 3편 가이드에 이어서 '반드시 할 필요는 없지만 하면 좋은 설정들'에 대해 알려드릴게요.

따로 서론 없이 바로 시작하겠습니다.

 


1. Code Style Configuration

const 내가_생각하는_IDE의_최고존엄_기능 = [
	"하이라이팅",
    "문법 오류 경고",
    "자동 완성",
    "자동 정렬"
];

IDE에는 자동 완성 만큼이나 중요한 자동 정렬 기능이 존재합니다.
사실상 이 자동 정렬이 간단한 프로젝트에서도 IDE를 사용하는 이유죠.

   

1-1. 코드 스타일을 수정하는 이유

기본 코드 스타일도 크게 나쁘진 않습니다.
손으로 정렬하면서 실수하는 것보단 환상적일 정도로 훌륭하죠.

하지만 PMMP의 플러그인을 만드는 데 PMMP와 코드 스타일이 다른 건 문제가 있죠.

PMMP는 @pmmp/PocketMine-MP/CONTRIBUTING.md#code-syntax 에 코드 스타일의 규칙을 아래와 같이 정해 놓았습니다.

이는 몇가지 예외를 제외하고 PSR-2를 따릅니다.
중괄호{}는 반드시 같은 라인에서 열어야하고, 공백이 없어야합니다.
else if는 반드시 elseif 로 사용해야 합니다.
제어문여는 중괄호의 앞 뒤에는 반드시 공백이 없어야합니다.
코드는 들여 쓰기를 위해 TAP을 사용해야 합니다.
긴 배열은 여러 줄로 나눠질 수 있고, 이렇게 나눠진 줄은 한 번 들여 쓰기 해야 합니다.
PHP파일은 반드시 <?php 태그로 시작하고, ?>태그로 닫지 않아야 합니다.
코드는 반드시 네임스페이스를 사용해야합니다.
문자열은 필요한 경우가 아니라면 반드시 큰 따옴표"를 사용해야 합니다.
모든 코드에는 가능한 경우 매개 변수 및 타입 선언이 있어야 합니다.
Strict Type은 반드시 활성화 해야합니다.
모든 상수 선언 앞에는 반드시 접근 제한자가 명시되어야 합니다.

저 같은 경우엔 TAB을 사용하라는 규칙을 제외한 모든 규칙을 지키려고 노력하고 있습니다.

1-2. 코드 스타일을 수정하는 방법

설정 창을 연 후에 Editor > Code Style > PHP로 들어가면 PHP의 코드 스타일을 수정할 수 있습니다.

하지만 굉장히 다양하고 많은 설정이 존재하기 때문에 일일이 다 수정하시는 건 꽤 힘듭니다.

 

1-3. 코드 스타일 파일 다운로드

빠른 설정을 위해 제가 사용하는 PhpStorm 코드 스타일 파일을 공유해드리겠습니다.

PresentKim/_codestyle
Contribute to PresentKim/_codestyle development by creating an account on GitHub.

phpstorm.xml 파일을 복사해 원하는 곳에 저장하세요.

원하는 이름.xml로 텍스트 파일을 하나 생성하고, 내용을 붙여 넣으시면 됩니다.

   

1-4 코드 스타일 파일 불러오기

코드 스타일 설정 창에서 톱니바퀴 버튼을 누르고, Import Scheme...를 누릅니다.

Select Path창에서 저장했던 코드 스타일 파일을 불러옵니다.
그 후 이름을 지정하고 OK를 누르면 코드 스타일 적용이 완료됩니다.

 

 


2. Run Configuration

IDE는 단순 코드 에디터가 아닌 통합_개발_환경의 준말입니다.
코딩과 디버깅, 컴파일, 배포가 모두 가능한 환경을 제공해주는 프로그램을 의미하죠.

마찬가지로 IDE인 우리의 PhpStorm에서도 디버깅이 한번에 가능합니다.
이번 가이드에서는 간단하게 PMMP를 PhpStorm에서 실행하는 방법에 대해 알려드리겠습니다.

먼저 이를 위해선 Run/Debug 기능을 사용해야 합니다.
상단 바를 잘 보면 Run이라는 탭이 존재합니다.
이 탭이 바로 Run/Debug 기능의 탭입니다. (사진 참고)

지금은 아무런 설정이 없어서 비활성화 되어 있습니다.
이제 여기에 PMMP를 실행하는 Run을 하나 추가해보도록 하죠.

2-1. Run/Debug 설정 창 열기

방금 열었던 Run탭에서 Edit Configurations... 를 눌러 설정 창을 열어줍니다.

2-2. 쉘 스크립트 Run 추가하기

설정 창이 열리면 수 많은 설정 템플릿이 존재합니다.
하지만 우리는 이미 start.bat을 만들어 놨으니 이 놈을 활용하도록 할게요.

수 많은 템플릿 중 Shell Script를 선택합니다.

그 후 우측 상단에 있는 Create configuration을 눌러줍니다.

   

그러면 아래 처럼 Unnamed 쉘 스크립트 설정이 하나 생성됩니다.

Name에 원하는 이름을 적습니다. (저는 PMMP로 설정했습니다)

Script path에 우리의 start.bat의 경로를 적어주고,
`Working directory`에 우리의 pmmp의 경로를 적어줍니다. (`start.bat`파일이 있는 폴더죠)

그 후 OK를 눌러 설정을 저장하면 아래와 같이 Run이 활성화됩니다.

   

자 이제 Shift+F10을 눌러주거나 직접 Run '설정한 이름'을 눌러주면...

하단의 Terminal 탭에서 PMMP가 실행됩니다! ㅎㅎ

자 이제, PMMP를 켜고.. PhpStorm을 켜고... PMMP 콘솔창 보러 갔다가.. 다시 PhpStorm으로 돌아오고... 이런 과정이 필요 없어졌습니다.

그냥 PhpStorm을 켜고, Shift+F10을 누르면 PMMP가 아래에 있어요!
기존 cmd에서 사용하던 것과 동일하게 사용하면 됩니다.

   

동일한 방법으로 update.bat도 등록해두셔도 좋습니다 :)


           

   

   

 

일단 이번 가이드도 이렇게 마무리하도록 하겠습니다.

그럼 ByeBye!