[swift] SwiftLint 적용해보기 (brew 이용)

SwiftLint란?

표준이라고 할 수 있는 코딩 스타일 등을 모아놓은 가이드라인에 따라 코드를 작성할 수 있게 도와주는 도구

스위프트 스타일 및 컨벤션을 강제함으로써 코드에 통일성을 줄 수 있기 때문에 협업에 자주 사용됨

 

 

설치 방법 (brew 이용)

1. brew를 통한 설치 : 커맨드라인에서 작업

brew install swiftlint

 

2. SwiftLint를 설치하고자 하는 프로젝트 열기

(1) 해당 프로젝트를 누르고(2) Target에서 해당 프로젝트를 누르고(3) Build Phases 항목에서(4) + 버튼을 눌러줌(5) New Run Script Phase

 

 

3. shell 부분을 수정해주기

export PATH="$PATH:/opt/homebrew/bin"
if which swiftlint > /dev/null; then
  swiftlint
else
  echo "warning: SwiftLint not installed, download from https://github.com/realm/SwiftLint"
fi

 

4. Run Script -> SwiftLint로 이름 바꾸고 위치를 compile resource 위로 올리기

그냥 드래그 하면 옮겨집니당!

 

5. custom하기

기본적으로 제공되는 규칙? 룰이 존재하지만, 만약에 추가하고 싶은 룰이나, 빼고 싶은 룰이 있다면 yml 파일을 만들어주면 됩니당!

프로젝트에서 command + N을 눌러 other-Empty파일 하나를 추가해주세요!

파일이 숨겨질 수 있도록 .swiftlintlint.yml라는 파일명으로 저장해주세요!!

생성된 .swiftlintlint.yml 파일에 포함되어야 할 룰과 아닌 룰을 적어주면 됩니다!

 

disabled_rules:
- line_length

included:
  
excluded:
  - Pods
  - HomeTap/AppDelegate.swift
  - HomeTap/SceneDelegate.swift

저는 기본적으로 AppDelegate, SceneDelegate, Pods 파일은 제외되도록 설정하였습니다!

그리고 초보다 보니 한 줄이 길어지는 경우가 많은데,,,길어지면 자꾸 에러가 떠서 이것도 disabled에 추가했어요.

 

일주일 정도 쓰다보니 변수명 제한(Identifier_Name)도 좀 짜증나고 있어요.

제가 설명충이라 변수명이 자꾸 길어져서요 ㅠㅠ 제가 고쳐야겠지만, 할 일이 많은 지금은 일단 패스해야 할 듯해요.

 

---

이렇게 적용하고 나면, 아래처럼 난리가 납니다.

생각보다 규칙이 엄격하더라구요.

 

아직까지 제 코드는 엉망이지만, 이렇게 좋아져가겠져?

오늘도 혹시 틀린 게 있다면 알려주십셔 슨배님덜!!