iOS开发笔记-52: SwiftLint使用指南(新手常见问题

[CocoaPods的问题我不赘述了,点击跳转]

我没有用全局安装，使用的是pod安装

# Swift Style 检查，规范代码风格
    pod 'SwiftLint'

然后

'注意这里的RunScript 脚本要放最下面
"${PODS_ROOT}/SwiftLint/swiftlint"

添加完后再编译的话会有上千个警告和报错
不要慌
不要慌
不要慌

1:首先是解决空格的问题

然后，配置一下代码规则
需要新建一个.swiftlint.yml

具体详细的配置即可参考官方 README_CN 的文档。

新手常用的.swiftlint.yml 案例 （用这个基本就解决第三方的报错和警告了，至于test文件之类的可以在excluded: 里再添加）

disabled_rules: # 执行时排除掉的规则
  - colon
  - comma
  - control_statement
  - line_length
  - vertical_whitespace
  - trailing_whitespace
opt_in_rules: # 一些规则仅仅是可选的
  - empty_count
  - missing_docs
  # 可以通过执行如下指令来查找所有可用的规则:
  # swiftlint rules
included: # 执行 linting 时包含的路径。如果出现这个 `--path` 会被忽略。
  # - Source
excluded: # 执行 linting 时忽略的路径。 优先级比 `included` 更高。
  - Carthage
  - Pods
  - Source/ExcludedFolder
  - Source/ExcludedFile.swift

# 可配置的规则可以通过这个配置文件来自定义
# 二进制规则可以设置他们的严格程度
force_cast: warning # 隐式
force_try:
severity: warning # 显式
# 同时有警告和错误等级的规则，可以只设置它的警告等级
# 隐式
line_length: 200
# 可以通过一个数组同时进行隐式设置
type_body_length:
  - 300 # warning
  - 400 # error
# 或者也可以同时进行显式设置
file_length:
  warning: 500
  error: 1200
# 命名规则可以设置最小长度和最大程度的警告/错误
# 此外它们也可以设置排除在外的名字
type_name:
  min_length: 4 # 只是警告
  max_length: # 警告和错误
    warning: 40
    error: 50
  excluded: iPhone # 排除某个名字
identifier_name:
  min_length: # 只有最小长度
    error: 4 # 只有错误
  excluded: # 排除某些名字
    - id
    - URL
    - GlobalAPIKey
reporter: "xcode" # 报告类型 (xcode, json, csv, checkstyle, junit, html, emoji)