Feat: Adding a script to run SwiftLint locally by AntAmazonian · Pull Request #2095 · awslabs/aws-sdk-swift

AntAmazonian · 2026-01-26T17:48:46Z

Issue #

N/A

Description of changes

The Swiftlint analyzer is configured to run on aws-sdk-swift CI. The analyzer provides better feedback than the main linter, but it also requires setup, including building the project prior to analysis.

A script is provided that developers can run on desktop to perform the same Swiftlint analysis that CI performs.

New/existing dependencies impact assessment, if applicable

N/A

Conventional Commits

"Add SwiftLint config and local execution script"

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

sichanyoo

Script in this PR only runs lint, not analyzer.

sichanyoo · 2026-01-27T20:25:11Z

scripts/lint.sh

+SCRIPT_DIR="$(dirname "$0")"
+CONFIG_PATH="$SCRIPT_DIR/../.swiftlint.yml"
+
+swiftlint lint --config "$CONFIG_PATH" --strict


This just runs lint, not analyzer.

Script now builds logger, runs analyzer, and lint

…ld log, run SwiftLint Analylzer, than stand lint.

sichanyoo

Is there a particular reason SPM build log was used instead of Xcode build log like in CI? I think the main point of having a script for this is so that we can easily run the analyzer lint the same way it is done in CI, but this technically diverges from it.

Have you run this lint yourself? Not sure if it would take forever to run because it tries to build every service in the project. See

aws-sdk-swift/.github/workflows/lint.yml

Lines 44 to 60 in 4c3e4ae

    
                 - name: Eliminate AWS service clients 
        
                   run: | 
        
                     cd aws-sdk-swift 
        
                     rm -rf Sources/Services/* 
        
                     cd AWSSDKSwiftCLI 
        
                     swift run AWSSDKSwiftCLI generate-package-manifest .. 
        
                     cd .. 
        
                     echo 
        
                     cat Package.swift 
        
                 - name: Compile project with Xcode 
        
                   run: | 
        
                     cd aws-sdk-swift 
        
                     xcodebuild -scheme aws-sdk-swift-Package -destination platform=macOS > xcodebuild.log 
        
                 - name: Run swiftlint analyzer 
        
                   run: | 
        
                     cd aws-sdk-swift 
        
                     swiftlint analyze --strict --reporter github-actions-logging --compiler-log-path xcodebuild.log

for how generated SDK is removed before running analyzer.

AntAmazonian · 2026-02-03T15:34:41Z

Is there a particular reason SPM build log was used instead of Xcode build log like in CI? I think the main point of having a script for this is so that we can easily run the analyzer lint the same way it is done in CI, but this technically diverges from it.

Have you run this lint yourself? Not sure if it would take forever to run because it tries to build every service in the project. See

aws-sdk-swift/.github/workflows/lint.yml

Lines 44 to 60 in 4c3e4ae

- name: Eliminate AWS service clients

run: |

cd aws-sdk-swift

rm -rf Sources/Services/*

cd AWSSDKSwiftCLI

swift run AWSSDKSwiftCLI generate-package-manifest ..

cd ..

echo

cat Package.swift

- name: Compile project with Xcode

run: |

cd aws-sdk-swift

xcodebuild -scheme aws-sdk-swift-Package -destination platform=macOS > xcodebuild.log

- name: Run swiftlint analyzer

run: |

cd aws-sdk-swift

swiftlint analyze --strict --reporter github-actions-logging --compiler-log-path xcodebuild.log

for how generated SDK is removed before running analyzer.

My intention is to allow this to be run even without xcode, I have ran in locally from the terminal.

…o use remote instead of local, removes service clients for efficeincy, backs up and restores services

jbelkins · 2026-03-25T19:23:50Z

scripts/lint.sh

+#  aws-sdk-swift
+#
+#  Created by Felix, Anthony on 1/23/26.
+#


nit: Replace the header with the standard Amazon header. Example:
https://github.com/awslabs/aws-sdk-swift/blob/main/Sources/Core/AWSClientRuntime/Sources/AWSClientRuntime/AWSClientConfigDefaultsProvider.swift#L1-L6

Alternatively, you can simply delete the header entirely.

jbelkins

See individual comments

jbelkins · 2026-03-25T19:31:11Z

scripts/lint.sh

+    echo "✅ Build completed successfully"
+
+    echo "Step 4: Running SwiftLint Analyze (this may take a few minutes)..."
+    timeout 300 swiftlint analyze --compiler-log-path "$LOG_FILE" || echo "⚠️  SwiftLint Analyze timed out after 5 minutes"


What is the reason for the 5 minute timeout? I generally disfavor setting timeouts unless they're there to address an operational problem, which I don't think we have here.

The timeout I added as a just in case for local runs by the developer, but thinking twice about it now I think this should be more on the developer to set if they want to.

jbelkins · 2026-03-25T19:33:23Z

scripts/lint.sh

+export PATH="$PATH:/opt/homebrew/bin:/usr/local/bin"
+
+# Unset AWS_SWIFT_SDK_USE_LOCAL_DEPS to use remote dependencies instead of local ones
+unset AWS_SWIFT_SDK_USE_LOCAL_DEPS


I don't think we want to do this for a locally-run development script, since SDK developers are typically using a local copy of smithy-swift with local SDK. If you've made local SDK changes that have corresponding smithy-swift changes, the xcodebuild initiated below will fail.

Okay, I didn't think about developers making their own changes if they used a copy of the SDK locally, I'll change it so leaves the deps alone if they were set by the developer. That way it's a choice on their end.

jbelkins · 2026-03-25T19:35:30Z

.swiftlint.yml

  - multiple_closures_with_trailing_closure
  - cyclomatic_complexity
  - file_length
  - syntactic_sugar


Why the specific changes to linter rules in this file?

Also, for simplicity, we typically keep the same linter rules in SDK and in smithy-swift. So if we do change rules here, there should be a 2nd PR to change them there as well.

AntAmazonian added 2 commits January 23, 2026 12:34

created lint script file

5636c66

Add local linting script

dddcd71

AntAmazonian requested review from dayaffe, jbelkins and sichanyoo January 27, 2026 14:14

sichanyoo requested changes Jan 27, 2026

View reviewed changes

AntAmazonian added 3 commits January 28, 2026 12:35

Added logger, and analyzer

907bee4

Removed --clean option, focused as a simple three step process to bui…

75e7b2a

…ld log, run SwiftLint Analylzer, than stand lint.

Merge branch 'main' into af/add-lint-script

8044f79

sichanyoo requested changes Feb 2, 2026

View reviewed changes

AntAmazonian added 3 commits February 4, 2026 13:58

Changed the script to use xcodebuild log, unsets local dependencies t…

54fc76c

…o use remote instead of local, removes service clients for efficeincy, backs up and restores services

Ran script a second time to correct file renaming issues.

1b80736

Merge branch 'main' into af/add-lint-script

a3f9ad5

AntAmazonian requested a review from sichanyoo February 5, 2026 18:37

AntAmazonian added 5 commits February 13, 2026 12:00

Merge branch 'main' into af/add-lint-script

40ce56b

Add build log files to .gitignore

40c0635

Stashed changes and removed log files to merge from main

c81ff68

Merged changes from main.

646801b

Merge branch 'main' into af/add-lint-script

4c8512c

jbelkins reviewed Mar 25, 2026

View reviewed changes

jbelkins requested changes Mar 25, 2026

View reviewed changes

Merge branch 'main' into af/add-lint-script

6962ab9

AntAmazonian requested a review from a team as a code owner April 1, 2026 16:12

AntAmazonian added 2 commits April 3, 2026 13:57

Changed the rules in swiftlint.yml back to original state

98f2f91

Removed header that wasn't needed

56858cb

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feat: Adding a script to run SwiftLint locally#2095

Feat: Adding a script to run SwiftLint locally#2095
AntAmazonian wants to merge 16 commits intomainfrom
af/add-lint-script

AntAmazonian commented Jan 26, 2026

Uh oh!

sichanyoo left a comment

Uh oh!

sichanyoo Jan 27, 2026

Uh oh!

AntAmazonian Feb 2, 2026

Uh oh!

sichanyoo left a comment

Uh oh!

AntAmazonian commented Feb 3, 2026

Uh oh!

jbelkins Mar 25, 2026

Uh oh!

jbelkins left a comment

Uh oh!

jbelkins Mar 25, 2026

Uh oh!

AntAmazonian Apr 1, 2026

Uh oh!

jbelkins Mar 25, 2026

Uh oh!

AntAmazonian Apr 1, 2026

Uh oh!

jbelkins Mar 25, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	- name: Eliminate AWS service clients
	run: \|
	cd aws-sdk-swift
	rm -rf Sources/Services/*
	cd AWSSDKSwiftCLI
	swift run AWSSDKSwiftCLI generate-package-manifest ..
	cd ..
	echo
	cat Package.swift
	- name: Compile project with Xcode
	run: \|
	cd aws-sdk-swift
	xcodebuild -scheme aws-sdk-swift-Package -destination platform=macOS > xcodebuild.log
	- name: Run swiftlint analyzer
	run: \|
	cd aws-sdk-swift
	swiftlint analyze --strict --reporter github-actions-logging --compiler-log-path xcodebuild.log

Conversation

AntAmazonian commented Jan 26, 2026

Issue #

Description of changes

New/existing dependencies impact assessment, if applicable

Conventional Commits

Uh oh!

sichanyoo left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sichanyoo left a comment

Choose a reason for hiding this comment

Uh oh!

AntAmazonian commented Feb 3, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jbelkins left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants