SwiftLint代码规范属性说明(二)

• 这篇文章是继前两篇文章的继续更新
• --这篇文章对SwiftLint进行了简单介绍和针对Xcode的相关配置
• --这里介绍了上半部分的相关属性的介绍
• 下面来具体介绍一下SwiftLint的其他的代码规则的相关说明

---

规则51: legacy_cggeometry_functions

当获取某个视图的宽、高、最小X、最大X值等等， swiftlint推荐使用swift的标准语法， 尽量不要使用从Objective-C中的遗留版本， 尽量语法swift化

识别码	默认是否启用	是否支持自动更正	类型
legacy_cggeometry_functions	启用	yes	idiomatic

代码示例:

/// 这样不推荐使用CGRectGetWidth(someView.frame)/// 推荐使用下面的形式rect.widthrect.heightrect.minXrect.midXrect...................复制代码

规则52: legacy_constant

和属性legacy_cggeometry_functions一样， 结构范围常数尽量分开、明确、具体， 不要使用OC的遗留整体常数

识别码	默认是否启用	是否支持自动更正	类型
legacy_constant	启用	yes	idiomatic

代码示例:

/// 规范的写法，不会触发warningCGPoint.zero/// 不规范的写法， 会触发warningCGPointZeroCGRectZero复制代码

规则53: legacy_constructor

swiftlint要求系统自带构造器， 使用swift语法化， 不要使用OC版本的构造器

识别码	默认是否启用	是否支持自动更正	类型
legacy_constructor	启用	yes	idiomatic

代码示例:

/// swift语法，相信之后系统也会强制规定使用CGPoint（x: 10， y: 20）/// 错误的构造器语法CGPointMake(10, 20)复制代码

规则54: legacy_nsgeometry_functions

ns类几何函数， 和前面的几个属性一样， 使用swift点语法函数， 不使用以前的版本。

识别码	默认是否启用	是否支持自动更正	类型
legacy_nsgeometry_functions	启用	yes	idiomatic

代码示例:

/// 正确view.width/height/minX/// 错误NSWidth(view.frame)复制代码

规则55: let_var_whitespace

let和var语句应该用空白行与其他语句分开

识别码	默认是否启用	是否支持自动更正	类型
let_var_whitespace	未启用	no	style

代码示例:

//推荐这样写let a = 0var x = 1x = 2//不建议写法var x = 1x = 2复制代码

规则56: line_length

行的字符长度属性。这个强烈不推荐使用。官方的规定是超过120字符就给warning， 超过200个字符就直接报error！！！我们又不是写底层脚本的，所以建议这种方式禁用！！

识别码	默认是否启用	是否支持自动更正	类型
line_length	启用	no	metrics

规则57: literal_expression_end_indentation

字典和数组的开头和结尾要有相同的缩进格式

识别码	默认是否启用	是否支持自动更正	类型
literal_expression_end_indentation	未启用	no	style

规则58: mark

标记方法或者属性。这个推荐使用， 可以统一方法标记的格式， 有利于review查找某个方法或者属性的时候更清晰。使用也非常简单： “MARK”前空一格，”MARK:”后空一格。

识别码	默认是否启用	是否支持自动更正	类型
mark	启用	yes	lint

代码示例:

//推荐写法// MARK: good// MARK: - good// MARK: -//不建议写法//MARK: bad// MARK:bad//MARK:bad//  MARK: bad// MARK:  bad// MARK: -bad复制代码

规则59: multiline_arguments

调用函数和方法时, 其参数应该在同一行上，或者每行一个

识别码	默认是否启用	是否支持自动更正	类型
multiline_arguments	未启用	no	style

代码示例:

//不建议以下写法foo(0, param1: 1, param2: true,    param3: [3])    foo(    0, param1: 1,    param2: true, param3: [3])复制代码

规则60: multiline_parameters

声明函数和方法时, 其参数应该在同一行上，或者每行一个

识别码	默认是否启用	是否支持自动更正	类型
multiline_parameters	未启用	no	style

代码示例:

//不建议以下写法protocol Foo {   func foo(param1: Int,             param2: Bool, param3: [String]) { }}protocol Foo {   func foo(param1: Int, param2: Bool,             param3: [String]) { }}复制代码

规则61: multiple_closures_with_trailing_closure

当函数有多个闭包时, 不建议使用尾随闭包语法

识别码	默认是否启用	是否支持自动更正	类型
multiple_closures_with_trailing_closure	启用	no	style

代码示例:

//不建议写法foo.something(param1: { $0 }) { $0 + 1 }UIView.animate(withDuration: 1.0, animations: {    someView.alpha = 0.0}) { _ in    someView.removeFromSuperview()}复制代码

规则62: nesting

嵌套。类型嵌套至多一级结构， 函数语句嵌套至多五级结构。

识别码	默认是否启用	是否支持自动更正	类型
nesting	启用	no	metrics

规则63: nimble_operator

快捷操作符。和自由匹配函数相比， 更喜欢快捷操作符， 比如：>=、 ==、 <=、 <等等。

识别码	默认是否启用	是否支持自动更正	类型
nimble_operator	未启用	yes	idiomatic

代码示例:

/// 会触发warning(person.voice).toNot(equal("Hello world"))     // 判断字符串相同10.to(beGreaterThan(5))     // 10比5大99.to(beLessThan(100))       // 99比100小// 改为以下(person.voice) != "Hello world"   // 判断字符串相同10 > 5                // 10比5大99 < 100              // 99比100小复制代码

规则64: no_extension_access_modifier

在extension扩展前面,不建议使用(fileprivate, public)等修饰符

识别码	默认是否启用	是否支持自动更正	类型
no_extension_access_modifier	未启用	no	idiomatic

代码示例:

//不推荐写法private extension String {}public extension String {}open extension String {}internal extension String {}fileprivate extension String {}复制代码

规则65: no_grouping_extension

只有class和protocol可以使用extension,其他类型不可使用

识别码	默认是否启用	是否支持自动更正	类型
no_grouping_extension	未启用	no	idiomatic

代码示例:

//不推荐写法enum Fruit {}extension Fruit {}extension Tea: Error {}struct Tea {}class Ham { class Spam {}}extension Ham.Spam {}extension External { struct Gotcha {}}extension External.Gotcha {}复制代码

规则66: notification_center_detachment

对象移除通知只能在deinit移除self,函数中不能removeObserver(self)

识别码	默认是否启用	是否支持自动更正	类型
notification_center_detachment	启用	no	lint

代码示例:

//不会触发warningclass Foo {    deinit {       NotificationCenter.default.removeObserver(self)   }}class Foo {    func bar() {       NotificationCenter.default.removeObserver(otherObject)   }}//会触发warningclass Foo {    func bar() {       NotificationCenter.default.removeObserver(self)   }}复制代码

规则67: number_separator

数字分割线。当在大量的小数中， 应该使用下划线来作为千分位分割线

识别码	默认是否启用	是否支持自动更正	类型
number_separator	未启用	yes	style

代码示例:

/// 推荐使用这种形式let xxx = 1_000_000_000.000_1print(xxx)/// 不推荐使用这种形式（在swift let xxx = 1000000000.0001print(xxx)复制代码

规则68: object_literal

swiftlint表示比起图片和颜色初始化，更喜欢对象初始化。因为swift初始化可以用表情，图片，颜色等，这不符合项目中的一些习惯用法

识别码	默认是否启用	是否支持自动更正	类型
object_literal	未启用	no	idiomatic

代码示例:

//不会触发warninglet image = #imageLiteral(resourceName: "image.jpg")let color = #colorLiteral(red: 0.9607843161, green: 0.7058823705, blue: 0.200000003, alpha: 1)let image = UIImage(named: aVariable)let image = UIImage(named: "interpolated \(variable)")let color = UIColor(red: value, green: value, blue: value, alpha: 1)let image = NSImage(named: aVariable)let image = NSImage(named: "interpolated \(variable)")let color = NSColor(red: value, green: value, blue: value, alpha: 1)//会触发warninglet image = ↓UIImage(named: "foo")let color = ↓UIColor(red: 0.3, green: 0.3, blue: 0.3, alpha: 1)let color = ↓UIColor(red: 100 / 255.0, green: 50 / 255.0, blue: 0, alpha: 1)let color = ↓UIColor(white: 0.5, alpha: 1)复制代码

规则69: opening_brace

花括号之前应该有一个空格,且与声明在同一行

识别码	默认是否启用	是否支持自动更正	类型
opening_brace	启用	yes	style

代码示例:

//建议写法func abc() {}[].map() { $0 }[].map({ })if let a = b { }while a == b { }guard let a = b else { }复制代码

规则70: operator_usage_whitespace

操作符使用规则， 操作符两边应该有空格。比如 “+” “-” “？？”

识别码	默认是否启用	是否支持自动更正	类型
operator_usage_whitespace	未启用	yes	style

代码示例:

//建议写法let foo = 1 + 2let foo = 1 > 2let foo = !false//不推荐写法let foo = 1+2let foo = 1   + 2let foo = 1   +    2let foo = 1 +    2let foo=1+2复制代码

规则71: operator_whitespace

空格/空白操作符。当定义空格操作符的时候，被定义的名字或类型两边应该各有一个单行空格操作符

识别码	默认是否启用	是否支持自动更正	类型
operator_whitespace	启用	no	style

代码示例:

// 触发警告class Something: Equatable {    var text: String?    // "=="和“(lhs: Something, rhs: Something)”之间应该有一个空格    static func ==(lhs: Something, rhs: Something) -> Bool {        return lhs.text == rhs.text    }}复制代码

规则72: overridden_super_call

一些重写的方法应该调用super.(父类的)方法

识别码	默认是否启用	是否支持自动更正	类型
overridden_super_call	未启用	no	lint

代码示例:

/// 这样会触发警告 class VCd: UIViewController {     override func viewWillAppear(_ animated: Bool) {        //没有调用父类     } } /// 不会触发警告  class VCd: UIViewController {     override func viewWillAppear(_ animated: Bool) {        super.viewWillAppear(animated)     }  }复制代码

规则73: override_in_extension

在extension中,不能重写未声明的属性和未定义的方法

识别码	默认是否启用	是否支持自动更正	类型
override_in_extension	未启用	no	lint

代码示例:

//错误写法extension Person {  //该属性之前未定义, 不能重写  override var age: Int { return 42 }}extension Person {  //该方法之前也为定义不能重写  override func celebrateBirthday() {}}复制代码

规则74: pattern_matching_keywords

... 在switch-case语句中, 建议不要将case中的let和var等关键字放到元祖内

识别码	默认是否启用	是否支持自动更正	类型
pattern_matching_keywords	未启用	no	idiomatic

代码示例:

复制代码

规则75: aaa

...

识别码	默认是否启用	是否支持自动更正	类型
aaa	未启用	no	style

代码示例:

//正确写法switch foo {    case let .foo(x, y): break}switch foo {    case .foo(let x), .bar(let x): break}//错误写法switch foo {    case (↓let x,  ↓let y): break}switch foo {    case .foo(↓let x, ↓let y): break}switch foo {    case (.yamlParsing(↓let x), .yamlParsing(↓let y)): break}switch foo {    case (↓var x,  ↓var y): break}switch foo {    case .foo(↓var x, ↓var y): break}复制代码

规则76: prefixed_toplevel_constant

类似全局常量,建议前缀以k开头

识别码	默认是否启用	是否支持自动更正	类型
prefixed_toplevel_constant	未启用	no	style

代码示例:

//推荐写法private let kFoo = 20.0public let kFoo = falseinternal let kFoo = "Foo"let kFoo = true复制代码

规则77: private_action

IBActions修饰的方法,应该都是私有的

识别码	默认是否启用	是否支持自动更正	类型
private_action	未启用	no	lint

代码示例:

//推荐写法class Foo {	@IBAction private func barButtonTapped(_ sender: UIButton) {}}struct Foo {	@IBAction private func barButtonTapped(_ sender: UIButton) {}}class Foo {	@IBAction fileprivate func barButtonTapped(_ sender: UIButton) {}}struct Foo {	@IBAction fileprivate func barButtonTapped(_ sender: UIButton) {}}private extension Foo {	@IBAction func barButtonTapped(_ sender: UIButton) {}}fileprivate extension Foo {	@IBAction func barButtonTapped(_ sender: UIButton) {}}复制代码

规则78: private_outlet

IBOutlets修饰的属性应该都是私有的

识别码	默认是否启用	是否支持自动更正	类型
private_outlet	未启用	no	lint

代码示例:

//推荐写法class Foo {  @IBOutlet private var label: UILabel?}class Foo {  @IBOutlet private var label: UILabel!}//不推荐写法class Foo {  @IBOutlet var label: UILabel?}class Foo {  @IBOutlet var label: UILabel!}复制代码

规则79: private_over_fileprivate

private比fileprivate的私有程度更高

识别码	默认是否启用	是否支持自动更正	类型
private_over_fileprivate	启用	yes	idiomatic

规则80: private_unit_test

私有的单元测试。被标记为private的单元测试不会被测试工具XCTest运行， 也就是说，被标记为private的单元测试会被静态跳过

识别码	默认是否启用	是否支持自动更正	类型
private_unit_test	启用	no	lint

代码示例:

private ↓class FooTest: XCTestCase { ...............继承于测试用例类XCTestCase, 被标记为private，所以触发warning     func test1() {}     internal func test2() {}     public func test3() {}     private func test4() {}.......另外注意这里，上面既然不会通过，那显然这里也不会通过，根本不会走这个func }   internal class FooTest: XCTestCase { ......开始通过测试，因为没有被标记为private     func test1() {}     internal func test2() {}     public func test3() {}     private ↓func test4() {}................不通过，因为被标记为private } public class FooTest: XCTestCase { ..........通过     func test1() {}     internal func test2() {}     public func test3() {}     private ↓func test4() {}.................不通过，因为被标记成private } class FooTest: XCTestCase { ..........通过     func test1() {}     internal func test2() {}     public func test3() {}     private ↓func test4() {}.................不通过，因为被标记成private }复制代码

规则81: prohibited_super_call

一些方法不应该调用父类的方法

识别码	默认是否启用	是否支持自动更正	类型
prohibited_super_call	未启用	no	lint

代码示例:

//以下方法不建议调用父类的方法class VC: UIViewController {	override func loadView() {↓		super.loadView()	}}class VC: NSFileProviderExtension {	override func providePlaceholder(at url: URL,completionHandler: @escaping (Error?) -> Void) {↓		self.method1()		super.providePlaceholder(at:url, completionHandler: completionHandler)	}}class VC: NSView {	override func updateLayer() {↓		self.method1()		super.updateLayer()		self.method2()	}}class VC: NSView {	override func updateLayer() {↓		defer {			super.updateLayer()		}	}}复制代码

规则82: protocol_property_accessors_order

在协议中声明属性时，访问者的顺序应该是get set

识别码	默认是否启用	是否支持自动更正	类型
protocol_property_accessors_order	启用	yes	style

代码示例:

//建议protocol Foo {   var bar: String { get set }}  //不建议protocol Foo {   var bar: String { set get }}复制代码

规则83: quick_discouraged_call

在单元测试中,不建议在describe和content比保重直接调用方法和类

识别码	默认是否启用	是否支持自动更正	类型
quick_discouraged_call	未启用	no	lint

规则84: quick_discouraged_focused_test

在单元测试中,不建议集中测试,否则可能不能运行成功

识别码	默认是否启用	是否支持自动更正	类型
quick_discouraged_focused_test	未启用	no	lint

代码示例:

//官方示例, 不建议class TotoTests: QuickSpec {   override func spec() {       ↓fdescribe("foo") { }   }}复制代码

规则85: quick_discouraged_pending_test

单元测试中阻止未进行的测试单元

识别码	默认是否启用	是否支持自动更正	类型
quick_discouraged_pending_test	未启用	no	lint

规则86: redundant_discardable_let

不需要初始化方法返回结果时,建议使用: _ = Person(), 而不是:let _ = Person()

识别码	默认是否启用	是否支持自动更正	类型
redundant_discardable_let	启用	yes	style

代码示例:

//推荐_ = foo()if let _ = foo() { }guard let _ = foo() else { return }//不建议let _ = foo()if _ = foo() { let _ = bar() }复制代码

规则87: redundant_nil_coalescing

使用可能为为nil的可选值时,建议使用: str ?? "", ??左右两侧要有一个空格

识别码	默认是否启用	是否支持自动更正	类型
redundant_nil_coalescing	未启用	yes	idiomatic

代码示例:

//建议写法var myVar: Int?; myVar ?? 0//不建议写法var myVar: Int? = nil; myVar  ?? nilvar myVar: Int? = nil; myVar??nil复制代码

规则88: redundant_optional_initialization

初始化nil变量是,不建议赋值nil

识别码	默认是否启用	是否支持自动更正	类型
redundant_optional_initialization	启用	yes	idiomatic

代码示例:

//不会触发warningvar myVar: Int?let myVar: Int? = nilvar myVar: Optional
    
     let myVar: Optional
     
       = nil//会触发warningvar myVar: Int?↓ = nilvar myVar: Optional
      
       ↓ = nilvar myVar: Int?↓=nilvar myVar: Optional
       
        ↓=nil复制代码
       
      
     
    

规则89: redundant_string_enum_value

在定义字符串枚举的时候, 当字符串枚举值等于枚举名称时，可以不用赋值

识别码	默认是否启用	是否支持自动更正	类型
redundant_string_enum_value	启用	no	idiomatic

代码示例:

//不会触发warningenum Numbers: String { case one case two}enum Numbers: Int { case one = 1 case two = 2}//会触发warningenum Numbers: String { case one = ↓"one" case two = ↓"two"}enum Numbers: String { case one = ↓"one", two = ↓"two"}复制代码

规则90: redundant_void_return

当函数返回值为Void时,建议不谢返回值, 定义常量或者变量的时候可以

识别码	默认是否启用	是否支持自动更正	类型
redundant_void_return	启用	yes	idiomatic

代码示例:

//不会触发warningfunc foo() {}func foo() -> Int {}func foo() -> Int -> Void {}func foo() -> VoidResponselet foo: Int -> Void//会触发warningfunc foo()↓ -> Void {}protocol Foo { func foo()↓ -> Void}func foo()↓ -> () {}protocol Foo { func foo()↓ -> ()}复制代码

规则91: required_enum_case

定义的枚举,必须有与其对应的操作实现

识别码	默认是否启用	是否支持自动更正	类型
required_enum_case	未启用	no	lint

规则92: return_arrow_whitespace

swiftlint推荐返回箭头和返回类型应该被空格分开

识别码	默认是否启用	是否支持自动更正	类型
return_arrow_whitespace	启用	yes	style

代码示例:

//推荐写法func abc() -> Int {}func abc() -> [Int] {}//不建议写法func abc()↓->Int {}func abc()↓->[Int] {}func abc()↓->(Int, Int) {}func abc()↓-> Int {}func abc()↓ ->Int {}复制代码

规则93: shorthand_operator

在swiftlint中， 就是我们常用的简洁操作运算符，比如：+= ， -=， *=， /= 等等。在swiftlint中，在做一些赋值操作的时候，推荐使用简短操作符

识别码	默认是否启用	是否支持自动更正	类型
shorthand_operator	启用	no	style

代码示例:

/// 不推荐使用    var value = 4    value = value / 2    print(value)    /// 推荐使用    var value = 4    value /= 2    print(value)复制代码

规则94: single_test_class

单元测试中,测试文件应该包含一个QuickSpec或XCTestCase类

识别码	默认是否启用	是否支持自动更正	类型
single_test_class	未启用	no	style

规则95: sorted_first_last

在获取某数组中最大最小值时,建议使用min和max函数,而不是sorted().first和sorted().lase

识别码	默认是否启用	是否支持自动更正	类型
sorted_first_last	未启用	no	style

代码示例:

复制代码

规则96: aaa

...

识别码	默认是否启用	是否支持自动更正	类型
aaa	未启用	no	style

代码示例:

//建议let min = myList.min()let min = myList.min(by: { $0 < $1 })let min = myList.min(by: >)let min = myList.max()let min = myList.max(by: { $0 < $1 })//不建议myList.sorted().firstmyList.sorted(by: { $0.description < $1.description }).firstmyList.sorted(by: >).firstmyList.map { $0 + 1 }.sorted().firstmyList.sorted(by: someFunction).first复制代码

规则97: sorted_imports

分类/有序导入。 这个属性有些奇怪， 要求导入的时候导入的类要按顺序导入

识别码	默认是否启用	是否支持自动更正	类型
sorted_imports	未启用	yes	style

代码示例:

//建议写法import AAAimport BBBimport CCCimport DDDimport Alamofireimport API复制代码

规则98: statement_position

陈述句位置， 这里主要指的是 else 和 catch 前面要加一个空格， 也不能大于1个空格， 否则就会触发警告

识别码	默认是否启用	是否支持自动更正	类型
statement_position	启用	yes	style

代码示例:

/// 没有空格，触发warning    let number = "long"    if number.isEmpty {        print("为空")    }else {.............................注意这里        print("不为空")    }    /// 这里也会触发warning， 因为else if换行了    let number = "long"    if number.isEmpty {        print("为空")    }    else if number.contains("long") {............................注意这里        print("不为空")    } else {        print("s")    }    /// 正确的写法    let number = "long"    if number.isEmpty {        print("为空")    } else {        print("不为空")    }复制代码

规则99: strict_fileprivate

extension中不建议使用fileprivate 修饰方法和属性

识别码	默认是否启用	是否支持自动更正	类型
strict_fileprivate	未启用	no	idiomatic

规则100: superfluous_disable_command

被禁用的规则不会在禁用区域触发警告

识别码	默认是否启用	是否支持自动更正	类型
superfluous_disable_command	启用	no	lint

文中如有不足之处请多指教

持续更新中.....