-
Notifications
You must be signed in to change notification settings - Fork 4
/
Copy pathSwiftLintFramework.swift
3755 lines (2495 loc) · 154 KB
/
SwiftLintFramework.swift
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import CommonCrypto
import Darwin
import Dispatch
import Foundation
import SourceKittenFramework
import SwiftOnoneSupport
import Yams
public protocol ASTRule: SwiftLintFramework.Rule {
associatedtype KindType: RawRepresentable
func validate(file: SourceKittenFramework.File, kind: Self.KindType, dictionary: [String: SourceKittenFramework.SourceKitRepresentable]) -> [SwiftLintFramework.StyleViolation]
}
extension ASTRule where Self.KindType.RawValue == String {
public func validate(file: SourceKittenFramework.File) -> [SwiftLintFramework.StyleViolation]
public func validate(file: SourceKittenFramework.File, dictionary: [String: SourceKittenFramework.SourceKitRepresentable]) -> [SwiftLintFramework.StyleViolation]
}
public enum AccessControlLevel: String, CustomStringConvertible {
case `private`
case `fileprivate`
case `internal`
case `public`
case open
/// A textual representation of this instance.
///
/// Calling this property directly is discouraged. Instead, convert an
/// instance of any type to a string by using the `String(describing:)`
/// initializer. This initializer works with any type, and uses the custom
/// `description` property for types that conform to
/// `CustomStringConvertible`:
///
/// struct Point: CustomStringConvertible {
/// let x: Int, y: Int
///
/// var description: String {
/// return "(\(x), \(y))"
/// }
/// }
///
/// let p = Point(x: 21, y: 30)
/// let s = String(describing: p)
/// print(s)
/// // Prints "(21, 30)"
///
/// The conversion of `p` to a string in the assignment to `s` uses the
/// `Point` type's `description` property.
public var description: String { get }
}
extension AccessControlLevel: Comparable {
/// Returns a Boolean value indicating whether the value of the first
/// argument is less than that of the second argument.
///
/// This function is the only requirement of the `Comparable` protocol. The
/// remainder of the relational operator functions are implemented by the
/// standard library for any type that conforms to `Comparable`.
///
/// - Parameters:
/// - lhs: A value to compare.
/// - rhs: Another value to compare.
public static func < (lhs: SwiftLintFramework.AccessControlLevel, rhs: SwiftLintFramework.AccessControlLevel) -> Bool
}
public protocol AnalyzerRule: SwiftLintFramework.OptInRule {}
extension AnalyzerRule {
public func validate(file: SourceKittenFramework.File) -> [SwiftLintFramework.StyleViolation]
}
extension AnalyzerRule where Self: SwiftLintFramework.CorrectableRule {
public func correct(file: SourceKittenFramework.File) -> [SwiftLintFramework.Correction]
}
/// Type-erased protocol used to check whether a rule is collectable.
public protocol AnyCollectingRule: SwiftLintFramework.Rule {}
public struct AnyObjectProtocolRule: SwiftLintFramework.SubstitutionCorrectableASTRule, SwiftLintFramework.OptInRule, SwiftLintFramework.ConfigurationProviderRule, SwiftLintFramework.AutomaticTestableRule {
public var configuration: SwiftLintFramework.SeverityConfiguration
public init()
public static let description: SwiftLintFramework.RuleDescription
public func validate(file: SourceKittenFramework.File, kind: SourceKittenFramework.SwiftDeclarationKind, dictionary: [String: SourceKittenFramework.SourceKitRepresentable]) -> [SwiftLintFramework.StyleViolation]
public func substitution(for violationRange: NSRange, in file: SourceKittenFramework.File) -> (NSRange, String)
public func violationRanges(in file: SourceKittenFramework.File, kind: SourceKittenFramework.SwiftDeclarationKind, dictionary: [String: SourceKittenFramework.SourceKitRepresentable]) -> [NSRange]
}
public struct ArrayInitRule: SwiftLintFramework.ASTRule, SwiftLintFramework.ConfigurationProviderRule, SwiftLintFramework.OptInRule, SwiftLintFramework.AutomaticTestableRule {
public var configuration: SwiftLintFramework.SeverityConfiguration
public init()
public static let description: SwiftLintFramework.RuleDescription
public func validate(file: SourceKittenFramework.File, kind: SwiftLintFramework.SwiftExpressionKind, dictionary: [String: SourceKittenFramework.SourceKitRepresentable]) -> [SwiftLintFramework.StyleViolation]
}
public struct AttributesConfiguration: SwiftLintFramework.RuleConfiguration, Equatable {
public var consoleDescription: String { get }
public init(alwaysOnSameLine: [String] = ["@IBAction", "@NSManaged"], alwaysInNewLine: [String] = [])
public mutating func apply(configuration: Any) throws
}
public struct AttributesRule: SwiftLintFramework.ASTRule, SwiftLintFramework.OptInRule, SwiftLintFramework.ConfigurationProviderRule {
public var configuration: SwiftLintFramework.AttributesConfiguration
public init()
public static let description: SwiftLintFramework.RuleDescription
public func validate(file: SourceKittenFramework.File) -> [SwiftLintFramework.StyleViolation]
public func validate(file: SourceKittenFramework.File, kind: SourceKittenFramework.SwiftDeclarationKind, dictionary: [String: SourceKittenFramework.SourceKitRepresentable]) -> [SwiftLintFramework.StyleViolation]
}
public protocol AutomaticTestableRule: SwiftLintFramework.Rule {}
public struct BlockBasedKVORule: SwiftLintFramework.ASTRule, SwiftLintFramework.ConfigurationProviderRule, SwiftLintFramework.AutomaticTestableRule {
public var configuration: SwiftLintFramework.SeverityConfiguration
public init()
public static let description: SwiftLintFramework.RuleDescription
public func validate(file: SourceKittenFramework.File, kind: SourceKittenFramework.SwiftDeclarationKind, dictionary: [String: SourceKittenFramework.SourceKitRepresentable]) -> [SwiftLintFramework.StyleViolation]
}
public struct CSVReporter: SwiftLintFramework.Reporter {
public static let identifier: String
public static let isRealtime: Bool
/// A textual representation of this instance.
///
/// Calling this property directly is discouraged. Instead, convert an
/// instance of any type to a string by using the `String(describing:)`
/// initializer. This initializer works with any type, and uses the custom
/// `description` property for types that conform to
/// `CustomStringConvertible`:
///
/// struct Point: CustomStringConvertible {
/// let x: Int, y: Int
///
/// var description: String {
/// return "(\(x), \(y))"
/// }
/// }
///
/// let p = Point(x: 21, y: 30)
/// let s = String(describing: p)
/// print(s)
/// // Prints "(21, 30)"
///
/// The conversion of `p` to a string in the assignment to `s` uses the
/// `Point` type's `description` property.
public var description: String { get }
public static func generateReport(_ violations: [SwiftLintFramework.StyleViolation]) -> String
}
public struct CheckstyleReporter: SwiftLintFramework.Reporter {
public static let identifier: String
public static let isRealtime: Bool
/// A textual representation of this instance.
///
/// Calling this property directly is discouraged. Instead, convert an
/// instance of any type to a string by using the `String(describing:)`
/// initializer. This initializer works with any type, and uses the custom
/// `description` property for types that conform to
/// `CustomStringConvertible`:
///
/// struct Point: CustomStringConvertible {
/// let x: Int, y: Int
///
/// var description: String {
/// return "(\(x), \(y))"
/// }
/// }
///
/// let p = Point(x: 21, y: 30)
/// let s = String(describing: p)
/// print(s)
/// // Prints "(21, 30)"
///
/// The conversion of `p` to a string in the assignment to `s` uses the
/// `Point` type's `description` property.
public var description: String { get }
public static func generateReport(_ violations: [SwiftLintFramework.StyleViolation]) -> String
}
public struct ClassDelegateProtocolRule: SwiftLintFramework.ASTRule, SwiftLintFramework.ConfigurationProviderRule, SwiftLintFramework.AutomaticTestableRule {
public var configuration: SwiftLintFramework.SeverityConfiguration
public init()
public static let description: SwiftLintFramework.RuleDescription
public func validate(file: SourceKittenFramework.File, kind: SourceKittenFramework.SwiftDeclarationKind, dictionary: [String: SourceKittenFramework.SourceKitRepresentable]) -> [SwiftLintFramework.StyleViolation]
}
public struct ClosingBraceRule: SwiftLintFramework.SubstitutionCorrectableRule, SwiftLintFramework.ConfigurationProviderRule, SwiftLintFramework.AutomaticTestableRule {
public var configuration: SwiftLintFramework.SeverityConfiguration
public init()
public static let description: SwiftLintFramework.RuleDescription
public func validate(file: SourceKittenFramework.File) -> [SwiftLintFramework.StyleViolation]
public func violationRanges(in file: SourceKittenFramework.File) -> [NSRange]
public func substitution(for violationRange: NSRange, in file: SourceKittenFramework.File) -> (NSRange, String)
}
public struct ClosureBodyLengthRule: SwiftLintFramework.OptInRule, SwiftLintFramework.ASTRule, SwiftLintFramework.ConfigurationProviderRule, SwiftLintFramework.AutomaticTestableRule {
public var configuration: SwiftLintFramework.SeverityLevelsConfiguration
public init()
public static let description: SwiftLintFramework.RuleDescription
public func validate(file: SourceKittenFramework.File, kind: SwiftLintFramework.SwiftExpressionKind, dictionary: [String: SourceKittenFramework.SourceKitRepresentable]) -> [SwiftLintFramework.StyleViolation]
}
public struct ClosureEndIndentationRule: SwiftLintFramework.Rule, SwiftLintFramework.OptInRule, SwiftLintFramework.ConfigurationProviderRule, SwiftLintFramework.AutomaticTestableRule {
public var configuration: SwiftLintFramework.SeverityConfiguration
public init()
public static let description: SwiftLintFramework.RuleDescription
public func validate(file: SourceKittenFramework.File) -> [SwiftLintFramework.StyleViolation]
}
extension ClosureEndIndentationRule: SwiftLintFramework.CorrectableRule {
public func correct(file: SourceKittenFramework.File) -> [SwiftLintFramework.Correction]
}
public struct ClosureParameterPositionRule: SwiftLintFramework.ASTRule, SwiftLintFramework.ConfigurationProviderRule, SwiftLintFramework.AutomaticTestableRule {
public var configuration: SwiftLintFramework.SeverityConfiguration
public init()
public static let description: SwiftLintFramework.RuleDescription
public func validate(file: SourceKittenFramework.File, kind: SwiftLintFramework.SwiftExpressionKind, dictionary: [String: SourceKittenFramework.SourceKitRepresentable]) -> [SwiftLintFramework.StyleViolation]
}
public struct ClosureSpacingRule: SwiftLintFramework.CorrectableRule, SwiftLintFramework.ConfigurationProviderRule, SwiftLintFramework.OptInRule, SwiftLintFramework.AutomaticTestableRule {
public var configuration: SwiftLintFramework.SeverityConfiguration
public init()
public static let description: SwiftLintFramework.RuleDescription
public func validate(file: SourceKittenFramework.File) -> [SwiftLintFramework.StyleViolation]
public func correct(file: SourceKittenFramework.File) -> [SwiftLintFramework.Correction]
}
/// Represents a file that can compute style violations and corrections for a list of rules.
///
/// A `CollectedLinter` is only created after a `Linter` has run its collection steps in `Linter.collect(into:)`.
public struct CollectedLinter {
public let file: SourceKittenFramework.File
public func styleViolations(using storage: SwiftLintFramework.RuleStorage) -> [SwiftLintFramework.StyleViolation]
public func styleViolationsAndRuleTimes(using storage: SwiftLintFramework.RuleStorage) -> ([SwiftLintFramework.StyleViolation], [(id: String, time: Double)])
public func correct(using storage: SwiftLintFramework.RuleStorage) -> [SwiftLintFramework.Correction]
public func format(useTabs: Bool, indentWidth: Int)
}
public protocol CollectingCorrectableRule: SwiftLintFramework.CollectingRule, SwiftLintFramework.CorrectableRule {
func correct(file: SourceKittenFramework.File, collectedInfo: [SourceKittenFramework.File: Self.FileInfo], compilerArguments: [String]) -> [SwiftLintFramework.Correction]
func correct(file: SourceKittenFramework.File, collectedInfo: [SourceKittenFramework.File: Self.FileInfo]) -> [SwiftLintFramework.Correction]
}
extension CollectingCorrectableRule {
public func correct(file: SourceKittenFramework.File, collectedInfo: [SourceKittenFramework.File: Self.FileInfo], compilerArguments: [String]) -> [SwiftLintFramework.Correction]
public func correct(file: SourceKittenFramework.File, using storage: SwiftLintFramework.RuleStorage, compilerArguments: [String]) -> [SwiftLintFramework.Correction]
public func correct(file: SourceKittenFramework.File) -> [SwiftLintFramework.Correction]
public func correct(file: SourceKittenFramework.File, compilerArguments: [String]) -> [SwiftLintFramework.Correction]
}
extension CollectingCorrectableRule where Self: SwiftLintFramework.AnalyzerRule {
public func correct(file: SourceKittenFramework.File) -> [SwiftLintFramework.Correction]
public func correct(file: SourceKittenFramework.File, compilerArguments: [String]) -> [SwiftLintFramework.Correction]
public func correct(file: SourceKittenFramework.File, collectedInfo: [SourceKittenFramework.File: Self.FileInfo]) -> [SwiftLintFramework.Correction]
}
public protocol CollectingRule: SwiftLintFramework.AnyCollectingRule {
associatedtype FileInfo
func collectInfo(for file: SourceKittenFramework.File, compilerArguments: [String]) -> Self.FileInfo
func collectInfo(for file: SourceKittenFramework.File) -> Self.FileInfo
func validate(file: SourceKittenFramework.File, collectedInfo: [SourceKittenFramework.File: Self.FileInfo], compilerArguments: [String]) -> [SwiftLintFramework.StyleViolation]
func validate(file: SourceKittenFramework.File, collectedInfo: [SourceKittenFramework.File: Self.FileInfo]) -> [SwiftLintFramework.StyleViolation]
}
extension CollectingRule {
public func collectInfo(for file: SourceKittenFramework.File, into storage: SwiftLintFramework.RuleStorage, compilerArguments: [String])
public func validate(file: SourceKittenFramework.File, using storage: SwiftLintFramework.RuleStorage, compilerArguments: [String]) -> [SwiftLintFramework.StyleViolation]
public func collectInfo(for file: SourceKittenFramework.File, compilerArguments: [String]) -> Self.FileInfo
public func validate(file: SourceKittenFramework.File, collectedInfo: [SourceKittenFramework.File: Self.FileInfo], compilerArguments: [String]) -> [SwiftLintFramework.StyleViolation]
public func validate(file: SourceKittenFramework.File) -> [SwiftLintFramework.StyleViolation]
public func validate(file: SourceKittenFramework.File, compilerArguments: [String]) -> [SwiftLintFramework.StyleViolation]
}
extension CollectingRule where Self: SwiftLintFramework.AnalyzerRule {
public func collectInfo(for file: SourceKittenFramework.File) -> Self.FileInfo
public func validate(file: SourceKittenFramework.File) -> [SwiftLintFramework.StyleViolation]
public func validate(file: SourceKittenFramework.File, collectedInfo: [SourceKittenFramework.File: Self.FileInfo]) -> [SwiftLintFramework.StyleViolation]
}
public struct CollectionAlignmentConfiguration: SwiftLintFramework.RuleConfiguration, Equatable {
public var consoleDescription: String { get }
public mutating func apply(configuration: Any) throws
}
public struct CollectionAlignmentRule: SwiftLintFramework.ASTRule, SwiftLintFramework.ConfigurationProviderRule, SwiftLintFramework.OptInRule {
public var configuration: SwiftLintFramework.CollectionAlignmentConfiguration
public init()
public static var description: SwiftLintFramework.RuleDescription
public func validate(file: SourceKittenFramework.File, kind: SwiftLintFramework.SwiftExpressionKind, dictionary: [String: SourceKittenFramework.SourceKitRepresentable]) -> [SwiftLintFramework.StyleViolation]
}
public struct ColonConfiguration: SwiftLintFramework.RuleConfiguration, Equatable {
public var consoleDescription: String { get }
public mutating func apply(configuration: Any) throws
}
public struct ColonRule: SwiftLintFramework.CorrectableRule, SwiftLintFramework.ConfigurationProviderRule {
public var configuration: SwiftLintFramework.ColonConfiguration
public init()
public static let description: SwiftLintFramework.RuleDescription
public func validate(file: SourceKittenFramework.File) -> [SwiftLintFramework.StyleViolation]
public func correct(file: SourceKittenFramework.File) -> [SwiftLintFramework.Correction]
}
extension ColonRule: SwiftLintFramework.ASTRule {
/// Only returns dictionary and function calls colon violations
public func validate(file: SourceKittenFramework.File, kind: SwiftLintFramework.SwiftExpressionKind, dictionary: [String: SourceKittenFramework.SourceKitRepresentable]) -> [SwiftLintFramework.StyleViolation]
}
public struct CommaRule: SwiftLintFramework.SubstitutionCorrectableRule, SwiftLintFramework.ConfigurationProviderRule, SwiftLintFramework.AutomaticTestableRule {
public var configuration: SwiftLintFramework.SeverityConfiguration
public init()
public static let description: SwiftLintFramework.RuleDescription
public func validate(file: SourceKittenFramework.File) -> [SwiftLintFramework.StyleViolation]
public func substitution(for violationRange: NSRange, in file: SourceKittenFramework.File) -> (NSRange, String)
public func violationRanges(in file: SourceKittenFramework.File) -> [NSRange]
}
public struct Command: Equatable {
public enum Action: String {
case enable
case disable
}
public enum Modifier: String {
case previous
case this
case next
}
public init(action: SwiftLintFramework.Command.Action, ruleIdentifiers: Set<SwiftLintFramework.RuleIdentifier>, line: Int = 0, character: Int? = nil, modifier: SwiftLintFramework.Command.Modifier? = nil, trailingComment: String? = nil)
public init?(string: NSString, range: NSRange)
}
public struct CompilerProtocolInitRule: SwiftLintFramework.ASTRule, SwiftLintFramework.ConfigurationProviderRule {
public var configuration: SwiftLintFramework.SeverityConfiguration
public init()
public static let description: SwiftLintFramework.RuleDescription
public func validate(file: SourceKittenFramework.File, kind: SwiftLintFramework.SwiftExpressionKind, dictionary: [String: SourceKittenFramework.SourceKitRepresentable]) -> [SwiftLintFramework.StyleViolation]
}
public struct ConditionalReturnsOnNewlineConfiguration: SwiftLintFramework.RuleConfiguration, Equatable {
public var consoleDescription: String { get }
public mutating func apply(configuration: Any) throws
}
public struct ConditionalReturnsOnNewlineRule: SwiftLintFramework.ConfigurationProviderRule, SwiftLintFramework.Rule, SwiftLintFramework.OptInRule {
public var configuration: SwiftLintFramework.ConditionalReturnsOnNewlineConfiguration
public init()
public static let description: SwiftLintFramework.RuleDescription
public func validate(file: SourceKittenFramework.File) -> [SwiftLintFramework.StyleViolation]
}
public struct Configuration: Hashable {
public enum RulesMode {
case `default`(disabled: [String], optIn: [String])
case whitelisted([String])
case allEnabled
}
public static let fileName: String
public let indentation: SwiftLintFramework.Configuration.IndentationStyle
public let included: [String]
public let excluded: [String]
public let reporter: String
public let warningThreshold: Int?
public private(set) var rootPath: String? {
get
}
public private(set) var configurationPath: String? {
get
}
public let cachePath: String?
/// Hashes the essential components of this value by feeding them into the
/// given hasher.
///
/// Implement this method to conform to the `Hashable` protocol. The
/// components used for hashing must be the same as the components compared
/// in your type's `==` operator implementation. Call `hasher.combine(_:)`
/// with each of these components.
///
/// - Important: Never call `finalize()` on `hasher`. Doing so may become a
/// compile-time error in the future.
///
/// - Parameter hasher: The hasher to use when combining the components
/// of this instance.
public func hash(into hasher: inout Hasher)
public let rules: [SwiftLintFramework.Rule]
public init?(rulesMode: SwiftLintFramework.Configuration.RulesMode = .default(disabled: [], optIn: []), included: [String] = [], excluded: [String] = [], warningThreshold: Int? = nil, reporter: String = XcodeReporter.identifier, ruleList: SwiftLintFramework.RuleList = masterRuleList, configuredRules: [SwiftLintFramework.Rule]? = nil, swiftlintVersion: String? = nil, cachePath: String? = nil, indentation: SwiftLintFramework.Configuration.IndentationStyle = .default, customRulesIdentifiers: [String] = [])
public init(path: String = Configuration.fileName, rootPath: String? = nil, optional: Bool = true, quiet: Bool = false, enableAllRules: Bool = false, cachePath: String? = nil, customRulesIdentifiers: [String] = [])
/// Returns a Boolean value indicating whether two values are equal.
///
/// Equality is the inverse of inequality. For any values `a` and `b`,
/// `a == b` implies that `a != b` is `false`.
///
/// - Parameters:
/// - lhs: A value to compare.
/// - rhs: Another value to compare.
public static func == (lhs: SwiftLintFramework.Configuration, rhs: SwiftLintFramework.Configuration) -> Bool
}
extension Configuration {
public func withPrecomputedCacheDescription() -> SwiftLintFramework.Configuration
}
extension Configuration {
public enum IndentationStyle: Equatable {
case tabs
case spaces(count: Int)
public static var `default`: SwiftLintFramework.Configuration.IndentationStyle
}
}
extension Configuration {
public func lintableFiles(inPath path: String, forceExclude: Bool) -> [SourceKittenFramework.File]
}
extension Configuration {
public func filterExcludedPaths(fileManager: SwiftLintFramework.LintableFileManager = FileManager.default, in paths: [String]...) -> [String]
}
extension Configuration {
public func configuration(for file: SourceKittenFramework.File) -> SwiftLintFramework.Configuration
}
extension Configuration {
public init?(dict: [String: Any], ruleList: SwiftLintFramework.RuleList = masterRuleList, enableAllRules: Bool = false, cachePath: String? = nil, customRulesIdentifiers: [String] = [])
}
public enum ConfigurationError: Error {
case unknownConfiguration
}
public protocol ConfigurationProviderRule: SwiftLintFramework.Rule {
associatedtype ConfigurationType: SwiftLintFramework.RuleConfiguration
var configuration: Self.ConfigurationType { get set }
}
extension ConfigurationProviderRule {
public init(configuration: Any) throws
public func isEqualTo(_ rule: SwiftLintFramework.Rule) -> Bool
public var configurationDescription: String { get }
}
extension ConfigurationProviderRule where Self.ConfigurationType == SwiftLintFramework.NameConfiguration {
public func severity(forLength length: Int) -> SwiftLintFramework.ViolationSeverity?
}
public struct ContainsOverFilterCountRule: SwiftLintFramework.OptInRule, SwiftLintFramework.ConfigurationProviderRule, SwiftLintFramework.AutomaticTestableRule {
public var configuration: SwiftLintFramework.SeverityConfiguration
public init()
public static let description: SwiftLintFramework.RuleDescription
public func validate(file: SourceKittenFramework.File) -> [SwiftLintFramework.StyleViolation]
}
public struct ContainsOverFilterIsEmptyRule: SwiftLintFramework.OptInRule, SwiftLintFramework.ConfigurationProviderRule, SwiftLintFramework.AutomaticTestableRule {
public var configuration: SwiftLintFramework.SeverityConfiguration
public init()
public static let description: SwiftLintFramework.RuleDescription
public func validate(file: SourceKittenFramework.File) -> [SwiftLintFramework.StyleViolation]
}
public struct ContainsOverFirstNotNilRule: SwiftLintFramework.OptInRule, SwiftLintFramework.ConfigurationProviderRule {
public var configuration: SwiftLintFramework.SeverityConfiguration
public init()
public static let description: SwiftLintFramework.RuleDescription
public func validate(file: SourceKittenFramework.File) -> [SwiftLintFramework.StyleViolation]
}
public struct ContainsOverRangeNilComparisonRule: SwiftLintFramework.OptInRule, SwiftLintFramework.ConfigurationProviderRule, SwiftLintFramework.AutomaticTestableRule {
public var configuration: SwiftLintFramework.SeverityConfiguration
public init()
public static let description: SwiftLintFramework.RuleDescription
public func validate(file: SourceKittenFramework.File) -> [SwiftLintFramework.StyleViolation]
}
public struct ControlStatementRule: SwiftLintFramework.ConfigurationProviderRule, SwiftLintFramework.AutomaticTestableRule {
public var configuration: SwiftLintFramework.SeverityConfiguration
public init()
public static let description: SwiftLintFramework.RuleDescription
public func validate(file: SourceKittenFramework.File) -> [SwiftLintFramework.StyleViolation]
}
public struct ConvenienceTypeRule: SwiftLintFramework.ASTRule, SwiftLintFramework.OptInRule, SwiftLintFramework.ConfigurationProviderRule, SwiftLintFramework.AutomaticTestableRule {
public var configuration: SwiftLintFramework.SeverityConfiguration
public init()
public static let description: SwiftLintFramework.RuleDescription
public func validate(file: SourceKittenFramework.File, kind: SourceKittenFramework.SwiftDeclarationKind, dictionary: [String: SourceKittenFramework.SourceKitRepresentable]) -> [SwiftLintFramework.StyleViolation]
}
public protocol CorrectableRule: SwiftLintFramework.Rule {
func correct(file: SourceKittenFramework.File, compilerArguments: [String]) -> [SwiftLintFramework.Correction]
func correct(file: SourceKittenFramework.File) -> [SwiftLintFramework.Correction]
func correct(file: SourceKittenFramework.File, using storage: SwiftLintFramework.RuleStorage, compilerArguments: [String]) -> [SwiftLintFramework.Correction]
}
extension CorrectableRule {
public func correct(file: SourceKittenFramework.File, compilerArguments: [String]) -> [SwiftLintFramework.Correction]
public func correct(file: SourceKittenFramework.File, using storage: SwiftLintFramework.RuleStorage, compilerArguments: [String]) -> [SwiftLintFramework.Correction]
}
public struct Correction: Equatable {
public let ruleDescription: SwiftLintFramework.RuleDescription
public let location: SwiftLintFramework.Location
public var consoleDescription: String { get }
}
public struct CustomRules: SwiftLintFramework.Rule, SwiftLintFramework.ConfigurationProviderRule {
public static let description: SwiftLintFramework.RuleDescription
public var configuration: SwiftLintFramework.CustomRulesConfiguration
public init()
public func validate(file: SourceKittenFramework.File) -> [SwiftLintFramework.StyleViolation]
}
public struct CustomRulesConfiguration: SwiftLintFramework.RuleConfiguration, Equatable {
public var consoleDescription: String { get }
public var customRuleConfigurations: [SwiftLintFramework.RegexConfiguration]
public init()
public mutating func apply(configuration: Any) throws
}
public struct CyclomaticComplexityConfiguration: SwiftLintFramework.RuleConfiguration, Equatable {
public var consoleDescription: String { get }
public static let defaultComplexityStatements: Set<SourceKittenFramework.StatementKind>
public private(set) var length: SwiftLintFramework.SeverityLevelsConfiguration {
get
}
public private(set) var complexityStatements: Set<SourceKittenFramework.StatementKind> {
get
}
public private(set) var ignoresCaseStatements: Bool
public init(warning: Int, error: Int?, ignoresCaseStatements: Bool = false)
public mutating func apply(configuration: Any) throws
}
public struct CyclomaticComplexityRule: SwiftLintFramework.ASTRule, SwiftLintFramework.ConfigurationProviderRule {
public var configuration: SwiftLintFramework.CyclomaticComplexityConfiguration
public init()
public static let description: SwiftLintFramework.RuleDescription
public func validate(file: SourceKittenFramework.File, kind: SourceKittenFramework.SwiftDeclarationKind, dictionary: [String: SourceKittenFramework.SourceKitRepresentable]) -> [SwiftLintFramework.StyleViolation]
}
public struct DeploymentTargetConfiguration: SwiftLintFramework.RuleConfiguration, Equatable {
public struct Version: Equatable, Comparable {
public let major: Int
public let minor: Int
public let patch: Int
public var stringValue: String { get }
public init(major: Int, minor: Int = 0, patch: Int = 0)
public init(rawValue: String) throws
/// Returns a Boolean value indicating whether the value of the first
/// argument is less than that of the second argument.
///
/// This function is the only requirement of the `Comparable` protocol. The
/// remainder of the relational operator functions are implemented by the
/// standard library for any type that conforms to `Comparable`.
///
/// - Parameters:
/// - lhs: A value to compare.
/// - rhs: Another value to compare.
public static func < (lhs: SwiftLintFramework.DeploymentTargetConfiguration.Version, rhs: SwiftLintFramework.DeploymentTargetConfiguration.Version) -> Bool
}
public var consoleDescription: String { get }
public init()
public mutating func apply(configuration: Any) throws
}
public struct DeploymentTargetRule: SwiftLintFramework.ConfigurationProviderRule {
public var configuration: SwiftLintFramework.DeploymentTargetConfiguration
public init()
public static let description: SwiftLintFramework.RuleDescription
public func validate(file: SourceKittenFramework.File) -> [SwiftLintFramework.StyleViolation]
}
public struct DiscardedNotificationCenterObserverRule: SwiftLintFramework.ASTRule, SwiftLintFramework.ConfigurationProviderRule, SwiftLintFramework.AutomaticTestableRule {
public var configuration: SwiftLintFramework.SeverityConfiguration
public init()
public static let description: SwiftLintFramework.RuleDescription
public func validate(file: SourceKittenFramework.File, kind: SwiftLintFramework.SwiftExpressionKind, dictionary: [String: SourceKittenFramework.SourceKitRepresentable]) -> [SwiftLintFramework.StyleViolation]
}
public struct DiscouragedDirectInitConfiguration: SwiftLintFramework.RuleConfiguration, Equatable {
public var severityConfiguration: SwiftLintFramework.SeverityConfiguration
public var consoleDescription: String { get }
public var severity: SwiftLintFramework.ViolationSeverity { get }
public private(set) var discouragedInits: Set<String> {
get
}
public mutating func apply(configuration: Any) throws
}
public struct DiscouragedDirectInitRule: SwiftLintFramework.ASTRule, SwiftLintFramework.ConfigurationProviderRule {
public var configuration: SwiftLintFramework.DiscouragedDirectInitConfiguration
public init()
public static let description: SwiftLintFramework.RuleDescription
public func validate(file: SourceKittenFramework.File, kind: SwiftLintFramework.SwiftExpressionKind, dictionary: [String: SourceKittenFramework.SourceKitRepresentable]) -> [SwiftLintFramework.StyleViolation]
}
public struct DiscouragedObjectLiteralRule: SwiftLintFramework.ASTRule, SwiftLintFramework.OptInRule, SwiftLintFramework.ConfigurationProviderRule {
public var configuration: SwiftLintFramework.ObjectLiteralConfiguration
public init()
public static let description: SwiftLintFramework.RuleDescription
public func validate(file: SourceKittenFramework.File, kind: SwiftLintFramework.SwiftExpressionKind, dictionary: [String: SourceKittenFramework.SourceKitRepresentable]) -> [SwiftLintFramework.StyleViolation]
}
public struct DiscouragedOptionalBooleanRule: SwiftLintFramework.OptInRule, SwiftLintFramework.ConfigurationProviderRule, SwiftLintFramework.AutomaticTestableRule {
public var configuration: SwiftLintFramework.SeverityConfiguration
public init()
public static let description: SwiftLintFramework.RuleDescription
public func validate(file: SourceKittenFramework.File) -> [SwiftLintFramework.StyleViolation]
}
public struct DiscouragedOptionalCollectionRule: SwiftLintFramework.ASTRule, SwiftLintFramework.OptInRule, SwiftLintFramework.ConfigurationProviderRule, SwiftLintFramework.AutomaticTestableRule {
public var configuration: SwiftLintFramework.SeverityConfiguration
public init()
public static let description: SwiftLintFramework.RuleDescription
public func validate(file: SourceKittenFramework.File, kind: SourceKittenFramework.SwiftDeclarationKind, dictionary: [String: SourceKittenFramework.SourceKitRepresentable]) -> [SwiftLintFramework.StyleViolation]
}
public struct DuplicateEnumCasesRule: SwiftLintFramework.ConfigurationProviderRule, SwiftLintFramework.ASTRule, SwiftLintFramework.AutomaticTestableRule {
public var configuration: SwiftLintFramework.SeverityConfiguration
public init()
public static let description: SwiftLintFramework.RuleDescription
public func validate(file: SourceKittenFramework.File, kind: SourceKittenFramework.SwiftDeclarationKind, dictionary: [String: SourceKittenFramework.SourceKitRepresentable]) -> [SwiftLintFramework.StyleViolation]
}
public struct DuplicateImportsRule: SwiftLintFramework.ConfigurationProviderRule, SwiftLintFramework.AutomaticTestableRule {
public var configuration: SwiftLintFramework.SeverityConfiguration
public init()
public static let description: SwiftLintFramework.RuleDescription
public func validate(file: SourceKittenFramework.File) -> [SwiftLintFramework.StyleViolation]
}
public struct DynamicInlineRule: SwiftLintFramework.ASTRule, SwiftLintFramework.ConfigurationProviderRule, SwiftLintFramework.AutomaticTestableRule {
public var configuration: SwiftLintFramework.SeverityConfiguration
public init()
public static let description: SwiftLintFramework.RuleDescription
public func validate(file: SourceKittenFramework.File, kind: SourceKittenFramework.SwiftDeclarationKind, dictionary: [String: SourceKittenFramework.SourceKitRepresentable]) -> [SwiftLintFramework.StyleViolation]
}
public struct EmojiReporter: SwiftLintFramework.Reporter {
public static let identifier: String
public static let isRealtime: Bool
/// A textual representation of this instance.
///
/// Calling this property directly is discouraged. Instead, convert an
/// instance of any type to a string by using the `String(describing:)`
/// initializer. This initializer works with any type, and uses the custom
/// `description` property for types that conform to
/// `CustomStringConvertible`:
///
/// struct Point: CustomStringConvertible {
/// let x: Int, y: Int
///
/// var description: String {
/// return "(\(x), \(y))"
/// }
/// }
///
/// let p = Point(x: 21, y: 30)
/// let s = String(describing: p)
/// print(s)
/// // Prints "(21, 30)"
///
/// The conversion of `p` to a string in the assignment to `s` uses the
/// `Point` type's `description` property.
public var description: String { get }
public static func generateReport(_ violations: [SwiftLintFramework.StyleViolation]) -> String
}
public struct EmptyCollectionLiteralRule: SwiftLintFramework.ConfigurationProviderRule, SwiftLintFramework.OptInRule, SwiftLintFramework.AutomaticTestableRule {
public var configuration: SwiftLintFramework.SeverityConfiguration
public init()
public static let description: SwiftLintFramework.RuleDescription
public func validate(file: SourceKittenFramework.File) -> [SwiftLintFramework.StyleViolation]
}
public struct EmptyCountRule: SwiftLintFramework.ConfigurationProviderRule, SwiftLintFramework.OptInRule, SwiftLintFramework.AutomaticTestableRule {
public var configuration: SwiftLintFramework.SeverityConfiguration
public init()
public static let description: SwiftLintFramework.RuleDescription
public func validate(file: SourceKittenFramework.File) -> [SwiftLintFramework.StyleViolation]
}
public struct EmptyEnumArgumentsRule: SwiftLintFramework.SubstitutionCorrectableASTRule, SwiftLintFramework.ConfigurationProviderRule, SwiftLintFramework.AutomaticTestableRule {
public var configuration: SwiftLintFramework.SeverityConfiguration
public init()
public static let description: SwiftLintFramework.RuleDescription
public func validate(file: SourceKittenFramework.File, kind: SourceKittenFramework.StatementKind, dictionary: [String: SourceKittenFramework.SourceKitRepresentable]) -> [SwiftLintFramework.StyleViolation]
public func substitution(for violationRange: NSRange, in file: SourceKittenFramework.File) -> (NSRange, String)
public func violationRanges(in file: SourceKittenFramework.File, kind: SourceKittenFramework.StatementKind, dictionary: [String: SourceKittenFramework.SourceKitRepresentable]) -> [NSRange]
}
public struct EmptyParametersRule: SwiftLintFramework.ConfigurationProviderRule, SwiftLintFramework.SubstitutionCorrectableRule, SwiftLintFramework.AutomaticTestableRule {
public var configuration: SwiftLintFramework.SeverityConfiguration
public init()
public static let description: SwiftLintFramework.RuleDescription
public func validate(file: SourceKittenFramework.File) -> [SwiftLintFramework.StyleViolation]
public func violationRanges(in file: SourceKittenFramework.File) -> [NSRange]
public func substitution(for violationRange: NSRange, in file: SourceKittenFramework.File) -> (NSRange, String)
}
public struct EmptyParenthesesWithTrailingClosureRule: SwiftLintFramework.SubstitutionCorrectableASTRule, SwiftLintFramework.ConfigurationProviderRule, SwiftLintFramework.AutomaticTestableRule {
public var configuration: SwiftLintFramework.SeverityConfiguration
public init()
public static let description: SwiftLintFramework.RuleDescription
public func validate(file: SourceKittenFramework.File, kind: SwiftLintFramework.SwiftExpressionKind, dictionary: [String: SourceKittenFramework.SourceKitRepresentable]) -> [SwiftLintFramework.StyleViolation]
public func substitution(for violationRange: NSRange, in file: SourceKittenFramework.File) -> (NSRange, String)
public func violationRanges(in file: SourceKittenFramework.File, kind: SwiftLintFramework.SwiftExpressionKind, dictionary: [String: SourceKittenFramework.SourceKitRepresentable]) -> [NSRange]
}
public struct EmptyStringRule: SwiftLintFramework.ConfigurationProviderRule, SwiftLintFramework.OptInRule, SwiftLintFramework.AutomaticTestableRule {
public var configuration: SwiftLintFramework.SeverityConfiguration
public init()
public static let description: SwiftLintFramework.RuleDescription
public func validate(file: SourceKittenFramework.File) -> [SwiftLintFramework.StyleViolation]
}
public struct EmptyXCTestMethodRule: SwiftLintFramework.Rule, SwiftLintFramework.OptInRule, SwiftLintFramework.ConfigurationProviderRule, SwiftLintFramework.AutomaticTestableRule {
public var configuration: SwiftLintFramework.SeverityConfiguration
public init()
public static let description: SwiftLintFramework.RuleDescription
public func validate(file: SourceKittenFramework.File) -> [SwiftLintFramework.StyleViolation]
}
public struct ExplicitACLRule: SwiftLintFramework.OptInRule, SwiftLintFramework.ConfigurationProviderRule, SwiftLintFramework.AutomaticTestableRule {
public var configuration: SwiftLintFramework.SeverityConfiguration
public init()
public static let description: SwiftLintFramework.RuleDescription
public func validate(file: SourceKittenFramework.File) -> [SwiftLintFramework.StyleViolation]
}
public struct ExplicitEnumRawValueRule: SwiftLintFramework.ASTRule, SwiftLintFramework.OptInRule, SwiftLintFramework.ConfigurationProviderRule, SwiftLintFramework.AutomaticTestableRule {
public var configuration: SwiftLintFramework.SeverityConfiguration
public init()
public static let description: SwiftLintFramework.RuleDescription
public func validate(file: SourceKittenFramework.File, kind: SourceKittenFramework.SwiftDeclarationKind, dictionary: [String: SourceKittenFramework.SourceKitRepresentable]) -> [SwiftLintFramework.StyleViolation]
}
public struct ExplicitInitRule: SwiftLintFramework.SubstitutionCorrectableASTRule, SwiftLintFramework.ConfigurationProviderRule, SwiftLintFramework.OptInRule, SwiftLintFramework.AutomaticTestableRule {
public var configuration: SwiftLintFramework.SeverityConfiguration
public init()
public static let description: SwiftLintFramework.RuleDescription
public func validate(file: SourceKittenFramework.File, kind: SwiftLintFramework.SwiftExpressionKind, dictionary: [String: SourceKittenFramework.SourceKitRepresentable]) -> [SwiftLintFramework.StyleViolation]
public func violationRanges(in file: SourceKittenFramework.File, kind: SwiftLintFramework.SwiftExpressionKind, dictionary: [String: SourceKittenFramework.SourceKitRepresentable]) -> [NSRange]
public func substitution(for violationRange: NSRange, in file: SourceKittenFramework.File) -> (NSRange, String)
}
public struct ExplicitSelfRule: SwiftLintFramework.CorrectableRule, SwiftLintFramework.ConfigurationProviderRule, SwiftLintFramework.AnalyzerRule, SwiftLintFramework.AutomaticTestableRule {
public var configuration: SwiftLintFramework.SeverityConfiguration
public init()
public static let description: SwiftLintFramework.RuleDescription
public func validate(file: SourceKittenFramework.File, compilerArguments: [String]) -> [SwiftLintFramework.StyleViolation]
public func correct(file: SourceKittenFramework.File, compilerArguments: [String]) -> [SwiftLintFramework.Correction]
}
public struct ExplicitTopLevelACLRule: SwiftLintFramework.OptInRule, SwiftLintFramework.ConfigurationProviderRule, SwiftLintFramework.AutomaticTestableRule {
public var configuration: SwiftLintFramework.SeverityConfiguration
public init()
public static let description: SwiftLintFramework.RuleDescription