Swift Lint 설명과 적용방법

Swift Lint 개요

swift코드에서 린트(Lint)규칙을 적용하여 코드 스타일의 문제 발견, 수정 권장사항을 제공한다. 이로서 코드 품질향상과 스타일 일관성유지를 기대할 수 있다.
https://github.com/realm/SwiftLint

주요기능

1. 코드 스타일 검증 : 코드스타일 규칙을 적용하여 문제 찾아주는 기능. 들여쓰기, 공백, 주석 스타일 등의 문제 발견이 가능하다
2. 커스터마이징 : lint규칙을 프로젝트 요구사항에 맞게 설정할 수 있다. 협업 시 규칙에 따라 추가하거나 제거할 수 있다
3. 자동 수정 : 일부 문제는 자동으로 수정해줄 수 있다.

---

Swift Lint 설치 방법

1. 해당 프로젝트 폴더에서 터미널을 연다.
2. 아래 명령어 입력 > 패스워드 입력 (Home brew 설치과정, 이미 설치되있다면 5번)

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

3. 진행되었으면 아래 입력

(echo; echo 'eval "$(/opt/homebrew/bin/brew shellenv)"') >> /Users/limhyejeong/.zprofile
eval "$(/opt/homebrew/bin/brew shellenv)"

4. 아래 한줄 씩 입력해보고 제대로 되었는지 체크

brew --version // 버전확인
brew update // 업데이트

5. 아래 명령어로 swiftlint 설치

brew install swiftlint

6. xcode로 돌아와서 아래 과정.
   https://velog.io/@subok/SwiftLint-%EC%84%A4%EC%B9%98%ED%95%B4%EB%B3%B4%EA%B8%B0

이 지경이 되면 잘 설치된 것이다.

---

규칙 커스텀

1. 루트디렉토리 터미널 열고 아래를 입력하면 규칙파일 생성

   파일만 생성할때는 touch .swiftlint.yml

규칙 내용까지 생성해주고 싶을 때는

echo "line_length:\n  warning: 120\n  error: 145\n  ignores_comments: true\n  ignores_urls: true" > .swiftlint.yml

의미

1. warning: 120
   코드 줄의 길이가 120자를 초과하면 경고(노랑)
2. error: 145
   코드 줄의 길이가 145자를 초과하면 오류 띄움(빨강)
3. ignores_comments: true
   주석은 줄 길이 검사에서 제외.
4. ignores_urls: true
   코드 내 URL은 줄 길이 검사에서 제외

해당 프로젝트 경로로 들어가면 .swiftlint.yml파일이 생성된다. 숨겨져서 안보인다면 shift + cmd + .

이후에 저 파일에서 편집해줄 수 있다.