【Atom】에디터의 자동 포맷 설정을 통일하자

팀 개발에서 포맷 통합의 중요성

팀 개발에서 Github 등의 버전 관리 시스템을 도입하고 있는 것은 더 이상 당연하다고 생각합니다만, 거기서 반드시 발생하는 것이 이 포맷 통일에 관한 문제입니다.
예를 들어, 한 사람은 파일 끝에 반드시 빈 줄을 삽입하는 설정을 하고 있는데, 자신이 빈 줄을 삽입하지 않는 설정으로 하고 있다면, 자신이 만든 파일을 다른 사람이 편집하면, 미묘한 형식 업데이트가 발생합니다. 또한 그 반대도 발생할 수 있습니다.

특정한 사람이 편집할 때마다 포맷에 관한 차등이 발생해 버리면, 쓸데없는 커밋 이력이 남아 버려, 또 코드 리뷰를 하는 사람으로부터 하면 꽤 보기 어렵기 때문에, 그다지 좋지 않습니다.
팀별로 각 구성원이 사용하는 편집기 설정을 통합하여 쓸데없는 커밋이 발생하지 않도록주의하십시오.

Atom에서 포맷 설정

Preference > Packages를 선택하고 검색 필드에 whitespace를 입력하여 검색합니다.
Atom에는 이 whitespace라는 플러그인이 기본적으로 포함되어 있으며 여기에서 공간에 관한 설정을 할 수 있습니다.


또한 몇 가지 기본적으로 켜져 있는 설정이 있고 저장 시 자동 포맷해 주기 때문에 변경하고 싶을 때는 이 설정을 확인해 봅시다.

파일 끝의 줄 바꿈

파일의 말미에 개행이 삽입할지 어떨지의 설정은, Ensure Single Trailing Newline 그리고 실시합니다. 개행하지 않도록 하려면 이 체크를 해제합니다.

커서 행 공간

커서가 있는 행의 여분의 공백을 삭제하고 싶지 않을 때는 Ignore Whitespace On　Current Line 를 체크합니다. 삭제하려면 체크를 해제합니다.

빈 줄 공간

공백 전용 행이 있는 경우 공백을 삭제하지 않으려면 Ignore Whitespace Only Line 를 선택합니다. 삭제하려면 체크를 해제합니다.

파일을 저장할 때 자동으로 공백 삭제

파일을 저장할 때 위에서 설정한 것과 같은 여분의 공간을 자동으로 삭제하려면 Remove　Trailing　Whitespace 를 선택합니다. 필요하지 않을 때는 체크를 해제합니다.

주의점

무의식적으로 코드 차이를 만들지 않도록주의

이것은 에디터의 설정에 의한다고 생각합니다만….
이 자동 포맷 기능은 마음대로 들여쓰기 갖추어 주거나 ​​매우 편리합니다만, 이 기능에 의해 자신의 눈치채지 않는 곳에서 차분이 발생해 버리는 일이 있습니다.

예를 들어, 파일을 저장했을 때 자동 포맷하는 설정으로 하고 있으면, 의도하지 않고 관계없는 파일을 편집해 버려, git status 합니다.

처음부터 에디터의 설정과 같이 포맷 된 파일을 편집한다면 문제 없다고 생각합니다.
그렇지 않은 파일을 편집할 때는 자동 저장 설정은 하지 않아도 좋지 않을까 개인적으로는 생각합니다.