iOS

[iOS] Warning 없는 Clean Code 만들기 (SwiftLint, Pods file)

빨간체리반지 2020. 10. 7. 13:53

SwiftLint?

Swift 스타일과 규칙을 적용하는데 사용하는 도구.

좀 더 깔끔한 소스(Clean Code)를 만들고 싶다면, 사용해보길 권한다.

 

 

적용

1. CocoaPod 설치

pod 'SwiftLint'

 

2. script 적용

Target > Build Phases > + > New Run Script Phase > Shell에 아래코드 추가

# 자동으로 소스 수정을 원하는 경우, 뒤에 autocorrect 를 붙이면 된다

${PODS_ROOT}/SwiftLint/swiftlint autocorrect

 

 

3. Pods 파일은 SwiftLint 무시하도록 설정

Project Root 위치에 .swiftlint.yml 파일 생성 > 아래 소스 추가하기

disabled_rules:

 

included:

 

excluded:

- Pods

 

- disabled_rules는 무시할 규칙들 추가하는 곳

- included는 추가로 SwiftLint로 검사할 파일/디렉토리 명시

- excluded는 SwiftLint 검사를 무시할 파일/디렉토리 명시

 

4. 소스 수정

빌드 시 나타나는 Warning 들 수정해주면 된다

 

추가

 

 

** Pods 파일에서 생성되는 default warning 무시하는 법

    => Podfile에 아래 줄 추가하고, pod install 하기

# 모든 pod의 warning 무시하기
inhibit_all_warnings!

 

# 특정 pod의 warning 무시하기

pod 'FBSDKCoreKit', :inhibit_warnings => true

 

링크

 

 

(SwiftLint)

 

realm/SwiftLint

A tool to enforce Swift style and conventions. Contribute to realm/SwiftLint development by creating an account on GitHub.

github.com

 

(SwiftLint 설명 영상)

 

"Watch Your Language!" The Road to Cleaner Code w/ SwiftLint

Learn how to use SwiftLint as an ever-watchful protector of code cleanliness in your project.

academy.realm.io

 

(참고 사이트)

 

iOS ) 내 프로젝트에 SwiftLint를 적용해보자

안녕하세요 :) Zedd입니다. 오늘은 SwiftLint사용법~.~ 간단해요!!!!! 얼른 해봅시댜 근데 SwiftLint github가면 다 나와있어요 :) 그리고 코코아팟을 사용할 줄 안다는 가정하에 글을 쓰겠습니다. 코코아팟

zeddios.tistory.com