Skip to content

Commit 12ca8d5

Browse files
iangmaiaiangmaia
authored
Set up SwiftLint (#693)
2 parents f335202 + ad2e835 commit 12ca8d5

20 files changed

+127
-29
lines changed

Diff for: ‎.buildkite/pipeline.yml

+11-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Nodes with values to reuse in the pipeline.
22
common_params:
33
plugins: &common_plugins
4-
- automattic/a8c-ci-toolkit#3.0.1
4+
- automattic/a8c-ci-toolkit#3.1.0
55
# Common environment values to use with the `env` key.
66
env: &common_env
77
IMAGE_ID: xcode-15.0.1
@@ -33,8 +33,17 @@ steps:
3333
plugins: *common_plugins
3434

3535
#################
36-
# Lint
36+
# Linters
3737
#################
38+
- label: ":swift: SwiftLint"
39+
command: run_swiftlint --strict
40+
plugins: *common_plugins
41+
notify:
42+
- github_commit_status:
43+
context: "SwiftLint"
44+
agents:
45+
queue: "default"
46+
3847
- label: "🧹 Lint"
3948
key: "lint"
4049
command: |

Diff for: ‎.gitignore

+3
Original file line numberDiff line numberDiff line change
@@ -96,3 +96,6 @@ vendor/
9696
# https://github.com/johnno1962/injectionforxcode
9797

9898
iOSInjectionProject/
99+
100+
# SwiftLint Remote Config Cache
101+
.swiftlint/RemoteConfigCache

Diff for: ‎.rubocop.yml

+7-3
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,15 @@
22
AllCops:
33
NewCops: enable
44

5+
# Override the maximum line length
6+
Layout/LineLength:
7+
Max: 160
8+
59
# Allow the Podspec filename to match the project
610
Naming/FileName:
711
Exclude:
812
- 'WordPressKit.podspec'
913

10-
# Override the maximum line length
11-
Layout/LineLength:
12-
Max: 160
14+
Metrics/BlockLength:
15+
Exclude:
16+
- 'fastlane/Fastfile'

Diff for: ‎.swiftlint.yml

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
swiftlint_version: 0.54.0
2+
3+
parent_config: https://raw.githubusercontent.com/Automattic/swiftlint-config/0f8ab6388bd8d15a04391825ab125f80cfb90704/.swiftlint.yml
4+
remote_timeout: 10.0
5+
6+
opt_in_rules:
7+
- overridden_super_call
8+
- discarded_notification_center_observer
9+
- weak_delegate
10+
- vertical_whitespace
11+
- duplicate_imports
12+
13+
overridden_super_call:
14+
severity: error
15+
16+
discarded_notification_center_observer:
17+
severity: error
18+
19+
weak_delegate:
20+
severity: error

Diff for: ‎Podfile

+15
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,12 @@ APP_IOS_DEPLOYMENT_TARGET = Gem::Version.new('13.0')
99

1010
platform :ios, APP_IOS_DEPLOYMENT_TARGET
1111

12+
def swiftlint_version
13+
require 'yaml'
14+
15+
YAML.load_file('.swiftlint.yml')['swiftlint_version']
16+
end
17+
1218
def wordpresskit_pods
1319
pod 'Alamofire', '~> 4.8.0'
1420
pod 'WordPressShared', '~> 2.0.0-beta.2'
@@ -34,6 +40,10 @@ target 'WordPressKitTests' do
3440
pod 'OCMock', '~> 3.4'
3541
end
3642

43+
abstract_target 'Tools' do
44+
pod 'SwiftLint', swiftlint_version
45+
end
46+
3747
# Let Pods targets inherit deployment target from the app
3848
post_install do |installer|
3949
installer.pods_project.targets.each do |target|
@@ -43,4 +53,9 @@ post_install do |installer|
4353
configuration.build_settings.delete(ios_deployment_key) if pod_ios_deployment_target <= APP_IOS_DEPLOYMENT_TARGET
4454
end
4555
end
56+
57+
yellow_marker = "\033[33m"
58+
reset_marker = "\033[0m"
59+
puts "#{yellow_marker}The abstract target warning below is expected. Feel free to ignore
60+
it.#{reset_marker}"
4661
end

Diff for: ‎Podfile.lock

+5-1
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ PODS:
1717
- OHHTTPStubs/OHPathHelpers (9.1.0)
1818
- OHHTTPStubs/Swift (9.1.0):
1919
- OHHTTPStubs/Default
20+
- SwiftLint (0.54.0)
2021
- UIDeviceIdentifier (2.3.0)
2122
- WordPressShared (2.0.1)
2223
- wpxmlrpc (0.10.0)
@@ -27,6 +28,7 @@ DEPENDENCIES:
2728
- OCMock (~> 3.4)
2829
- OHHTTPStubs (~> 9.0)
2930
- OHHTTPStubs/Swift (~> 9.0)
31+
- SwiftLint (= 0.54.0)
3032
- UIDeviceIdentifier (~> 2.0)
3133
- WordPressShared (~> 2.0.0-beta.2)
3234
- wpxmlrpc (~> 0.10.0)
@@ -37,6 +39,7 @@ SPEC REPOS:
3739
- NSObject-SafeExpectations
3840
- OCMock
3941
- OHHTTPStubs
42+
- SwiftLint
4043
- UIDeviceIdentifier
4144
- WordPressShared
4245
- wpxmlrpc
@@ -46,10 +49,11 @@ SPEC CHECKSUMS:
4649
NSObject-SafeExpectations: c01c8881cbd97efad6f668286b913cd0b7d62ab5
4750
OCMock: 300b1b1b9155cb6378660b981c2557448830bdc6
4851
OHHTTPStubs: 90eac6d8f2c18317baeca36698523dc67c513831
52+
SwiftLint: c1de071d9d08c8aba837545f6254315bc900e211
4953
UIDeviceIdentifier: 442b65b4ff1832d4ca9c2a157815cb29ad981b17
5054
WordPressShared: f93f99269258b46dad04f4e4dbf540ce2e5c1e66
5155
wpxmlrpc: 68db063041e85d186db21f674adf08d9c70627fd
5256

53-
PODFILE CHECKSUM: 7998039b722f0fe77c684f509f0478349cf5fb9b
57+
PODFILE CHECKSUM: a06b4d2f7183f40a91a0f219ca399141aee28c5f
5458

5559
COCOAPODS: 1.14.3

Diff for: ‎WordPressKit.xcodeproj/project.pbxproj

+20
Original file line numberDiff line numberDiff line change
@@ -2829,6 +2829,7 @@
28292829
9368C7761EC5EF1B0092CE8E /* Sources */,
28302830
9368C7771EC5EF1B0092CE8E /* Frameworks */,
28312831
9368C7791EC5EF1B0092CE8E /* Resources */,
2832+
3F391E242B577AD7007975C4 /* SwiftLint */,
28322833
);
28332834
buildRules = (
28342835
);
@@ -3247,6 +3248,25 @@
32473248
shellScript = "diff \"${PODS_PODFILE_DIR_PATH}/Podfile.lock\" \"${PODS_ROOT}/Manifest.lock\" > /dev/null\nif [ $? != 0 ] ; then\n # print error to STDERR\n echo \"error: The sandbox is not in sync with the Podfile.lock. Run 'pod install' or update your CocoaPods installation.\" >&2\n exit 1\nfi\n# This output is used by Xcode 'outputs' to avoid re-running this script phase.\necho \"SUCCESS\" > \"${SCRIPT_OUTPUT_FILE_0}\"\n";
32483249
showEnvVarsInLog = 0;
32493250
};
3251+
3F391E242B577AD7007975C4 /* SwiftLint */ = {
3252+
isa = PBXShellScriptBuildPhase;
3253+
alwaysOutOfDate = 1;
3254+
buildActionMask = 2147483647;
3255+
files = (
3256+
);
3257+
inputFileListPaths = (
3258+
);
3259+
inputPaths = (
3260+
);
3261+
name = SwiftLint;
3262+
outputFileListPaths = (
3263+
);
3264+
outputPaths = (
3265+
);
3266+
runOnlyForDeploymentPostprocessing = 0;
3267+
shellPath = /bin/sh;
3268+
shellScript = "./Pods/SwiftLint/swiftlint lint\n";
3269+
};
32503270
50C31E8D1B97D5FA0D543935 /* [CP] Check Pods Manifest.lock */ = {
32513271
isa = PBXShellScriptBuildPhase;
32523272
buildActionMask = 2147483647;

Diff for: ‎WordPressKit/AccountServiceRemoteREST+SocialService.swift

+3-3
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ extension AccountServiceRemoteREST {
2222
connectParameters: [String: AnyObject]? = nil,
2323
oAuthClientID: String,
2424
oAuthClientSecret: String,
25-
success:@escaping (() -> Void),
26-
failure:@escaping ((NSError) -> Void)) {
25+
success: @escaping (() -> Void),
26+
failure: @escaping ((NSError) -> Void)) {
2727
let path = self.path(forEndpoint: "me/social-login/connect", withVersion: ._1_1)
2828

2929
var params = [
@@ -65,7 +65,7 @@ extension AccountServiceRemoteREST {
6565
/// - oAuthClientSecret The WPCOM REST API client secret.
6666
/// - success The block that will be executed on success.
6767
/// - failure The block that will be executed on failure.
68-
public func disconnectFromSocialService(_ service: SocialServiceName, oAuthClientID: String, oAuthClientSecret: String, success:@escaping(() -> Void), failure:@escaping((NSError) -> Void)) {
68+
public func disconnectFromSocialService(_ service: SocialServiceName, oAuthClientID: String, oAuthClientSecret: String, success: @escaping(() -> Void), failure: @escaping((NSError) -> Void)) {
6969
let path = self.path(forEndpoint: "me/social-login/disconnect", withVersion: ._1_1)
7070
let params = [
7171
"client_id": oAuthClientID,

Diff for: ‎WordPressKit/ChecksumUtil.swift

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import Foundation
22

33
public class ChecksumUtil {
44

5-
/// Generates a checksum based on the encoded keys.
5+
/// Generates a checksum based on the encoded keys.
66
static func checksum<T>(from codable: T) -> String where T: Encodable {
77
let encoder = JSONEncoder()
88
encoder.outputFormatting = .sortedKeys

Diff for: ‎WordPressKit/GravatarServiceRemote.swift

+2-2
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ open class GravatarServiceRemote {
1515
/// - success: A success block.
1616
/// - failure: A failure block.
1717
///
18-
open func fetchProfile(_ email: String, success:@escaping ((_ profile: RemoteGravatarProfile) -> Void), failure:@escaping ((_ error: Error?) -> Void)) {
18+
open func fetchProfile(_ email: String, success: @escaping ((_ profile: RemoteGravatarProfile) -> Void), failure: @escaping ((_ error: Error?) -> Void)) {
1919
guard let hash = (email as NSString).md5() else {
2020
assertionFailure()
2121
return
@@ -31,7 +31,7 @@ open class GravatarServiceRemote {
3131
/// - success: A success block.
3232
/// - failure: A failure block.
3333
///
34-
open func fetchProfile(hash: String, success:@escaping ((_ profile: RemoteGravatarProfile) -> Void), failure:@escaping ((_ error: Error?) -> Void)) {
34+
open func fetchProfile(hash: String, success: @escaping ((_ profile: RemoteGravatarProfile) -> Void), failure: @escaping ((_ error: Error?) -> Void)) {
3535
let path = baseGravatarURL + hash + ".json"
3636
guard let targetURL = URL(string: path) else {
3737
assertionFailure()

Diff for: ‎WordPressKit/HTTPAuthenticationAlertController.swift

+5-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,11 @@ open class HTTPAuthenticationAlertController {
3636

3737
private static func controllerForServerTrustChallenge(_ challenge: URLAuthenticationChallenge) -> UIAlertController {
3838
let title = NSLocalizedString("Certificate error", comment: "Popup title for wrong SSL certificate.")
39-
let message = String(format: NSLocalizedString("The certificate for this server is invalid. You might be connecting to a server that is pretending to be “%@” which could put your confidential information at risk.\n\nWould you like to trust the certificate anyway?", comment: ""), challenge.protectionSpace.host)
39+
let localizedMessage = NSLocalizedString(
40+
"The certificate for this server is invalid. You might be connecting to a server that is pretending to be “%@” which could put your confidential information at risk.\n\nWould you like to trust the certificate anyway?",
41+
comment: "Message for when the certificate for the server is invalid. The %@ placeholder will be replaced the a host name, received from the API."
42+
)
43+
let message = String(format: localizedMessage, challenge.protectionSpace.host)
4044
let controller = UIAlertController(title: title, message: message, preferredStyle: .alert)
4145

4246
let cancelAction = UIAlertAction(title: NSLocalizedString("Cancel", comment: "Cancel button label"),

Diff for: ‎WordPressKit/JetpackRestoreTypes.swift

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ public struct JetpackRestoreTypes {
99
public var contents: Bool
1010

1111
public init(themes: Bool = true,
12-
plugins: Bool = true ,
12+
plugins: Bool = true,
1313
uploads: Bool = true,
1414
sqls: Bool = true,
1515
roots: Bool = true,

Diff for: ‎WordPressKit/QR Login/QRLoginValidationResponse.swift

-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@ public struct QRLoginValidationResponse: Decodable {
66
/// This may be null if the browser could not be determined
77
public var browser: String?
88

9-
109
/// The City, State the user has requested the login from
1110
/// IE: Columbus, Ohio
1211
public var location: String

Diff for: ‎WordPressKit/WordPressComOAuthClient.swift

+6-6
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,7 @@ public final class WordPressComOAuthClient: NSObject {
182182

183183
let builder = tokenRequestBuilder().body(form: form)
184184
return await oauth2Session
185-
.perform(request: builder)
185+
.perform(request: builder)
186186
.mapUnacceptableStatusCodeError(AuthenticationFailure.init(response:body:))
187187
.mapSuccess { response in
188188
let responseObject = try JSONSerialization.jsonObject(with: response.body)
@@ -260,7 +260,7 @@ public final class WordPressComOAuthClient: NSObject {
260260
"wpcom_resend_otp": "true"
261261
])
262262
return await oauth2Session
263-
.perform(request: builder)
263+
.perform(request: builder)
264264
.mapUnacceptableStatusCodeError(AuthenticationFailure.init(response:body:))
265265
.mapSuccess { _ in () }
266266
}
@@ -377,7 +377,7 @@ public final class WordPressComOAuthClient: NSObject {
377377
)
378378

379379
return await socialSession
380-
.perform(request: builder, errorType: AuthenticationFailure.self)
380+
.perform(request: builder, errorType: AuthenticationFailure.self)
381381
.mapUnacceptableStatusCodeError(AuthenticationFailure.init(response:body:))
382382
.mapSuccess { response in
383383
WPKitLogVerbose("Received Social Login Oauth response.")
@@ -467,7 +467,7 @@ public final class WordPressComOAuthClient: NSObject {
467467
"two_step_nonce": twoStepNonce,
468468
])
469469
return await webAuthnSession
470-
.perform(request: builder)
470+
.perform(request: builder)
471471
.mapUnacceptableStatusCodeError(AuthenticationFailure.init(response:body:))
472472
.mapSuccess { response in
473473
// Expect the parent data response object
@@ -567,7 +567,7 @@ public final class WordPressComOAuthClient: NSObject {
567567
])
568568

569569
return await webAuthnSession
570-
.perform(request: builder)
570+
.perform(request: builder)
571571
.mapUnacceptableStatusCodeError(AuthenticationFailure.init(response:body:))
572572
.mapSuccess { response in
573573
let responseObject = try? JSONSerialization.jsonObject(with: response.body)
@@ -623,7 +623,7 @@ public final class WordPressComOAuthClient: NSObject {
623623
}
624624
}
625625

626-
/// A helper method to get an instance of SocialLogin2FANonceInfo and populate
626+
/// A helper method to get an instance of SocialLogin2FANonceInfo and populate
627627
/// it with the supplied data.
628628
///
629629
/// - Parameters:

Diff for: ‎WordPressKit/WordPressComServiceRemote+SiteCreation.swift

+1-1
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@ public enum SiteCreationResult {
177177
public typealias SiteCreationResultHandler = ((SiteCreationResult) -> Void)
178178

179179
/// Site creation services, exclusive to WordPress.com.
180-
///
180+
///
181181
public extension WordPressComServiceRemote {
182182

183183
/// Initiates a request to create a new WPCOM site.

Diff for: ‎WordPressKit/WordPressOrgXMLRPCValidator.swift

+4-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,10 @@ import Foundation
2222
case .notWordPressError:
2323
return NSLocalizedString("That doesn't look like a WordPress site.", comment: "Message to show to user when he tries to add a self-hosted site that isn't a WordPress site.")
2424
case .mobilePluginRedirectedError:
25-
return NSLocalizedString("You seem to have installed a mobile plugin from DudaMobile which is preventing the app to connect to your blog", comment: "")
25+
return NSLocalizedString(
26+
"You seem to have installed a mobile plugin from DudaMobile which is preventing the app to connect to your blog",
27+
comment: "Error messaged show when a mobile plugin is redirecting traffict to their site, DudaMobile in particular"
28+
)
2629
case .invalid:
2730
return NSLocalizedString("Couldn't connect to the WordPress site. There is no valid WordPress site at this address. Check the site address (URL) you entered.", comment: "Error message shown a URL points to a valid site but not a WordPress site.")
2831
case .blocked:

Diff for: ‎WordPressKitTests/IPLocationRemoteTests.swift

-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
import XCTest
22
@testable import WordPressKit
33

4-
54
final class IPLocationRemoteTests: XCTestCase {
65
var remote: IPLocationRemote!
76
let apiURL = URL(string: "https://public-api.wordpress.com/geo/")!
@@ -59,7 +58,6 @@ final class MockURLProtocol: URLProtocol {
5958
return request
6059
}
6160

62-
6361
override func startLoading() {
6462
guard let handler = MockURLProtocol.requestHandler else {
6563
fatalError("Handler is unavailable.")
@@ -78,6 +76,5 @@ final class MockURLProtocol: URLProtocol {
7876
}
7977
}
8078

81-
8279
override func stopLoading() { }
8380
}

Diff for: ‎WordPressKitTests/MediaLibraryTestSupport.swift

+1-1
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ extension MediaLibraryTestSupport {
133133
var content: String?
134134
var paramName: String?
135135

136-
func parser(_ parser: XMLParser, didStartElement elementName: String, namespaceURI: String?, qualifiedName qName: String?, attributes attributeDict: [String : String] = [:]) {
136+
func parser(_ parser: XMLParser, didStartElement elementName: String, namespaceURI: String?, qualifiedName qName: String?, attributes attributeDict: [String: String] = [:]) {
137137
elementPath.append(elementName)
138138
}
139139

Diff for: ‎WordPressKitTests/RemoteTestCase.swift

+2-2
Original file line numberDiff line numberDiff line change
@@ -149,9 +149,9 @@ extension RemoteTestCase {
149149
/// Helper function that stubs ALL endpoints so that they return a CFNetworkErrors.cfurlErrorNotConnectedToInternet
150150
/// error. In the response, prior to returning the error, XCTFail will also be called logging the endpoint
151151
/// which was called.
152-
///
152+
///
153153
/// - Note: Remember that order is important when stubbing requests with HTTPStubs. Therefore, it is important
154-
/// this is called **before** stubbing out a specific endpoint you are testing. See:
154+
/// this is called **before** stubbing out a specific endpoint you are testing. See:
155155
/// https://github.com/AliSoftware/OHHTTPStubs/wiki/Usage-Examples#stack-multiple-stubs-and-remove-installed-stubs
156156
///
157157
func stubAllNetworkRequestsWithNotConnectedError() {

0 commit comments

Comments
 (0)