swift-style
Original:🇺🇸 English
Translated
Swift code style conventions for clean, readable code. Use when writing Swift code to ensure consistent formatting, naming, organization, and idiomatic patterns.
6installs
Added on
NPX Install
npx skill4agent add johnrogers/claude-swift-engineering swift-styleTags
Translated version includes tags in frontmatterSKILL.md Content
View Translation Comparison →Swift Style Guide
Code style conventions for clean, readable Swift code.
Core Principles
Clarity > Brevity > Consistency
Code should compile without warnings.
Naming
- — Types, protocols
UpperCamelCase - — Everything else
lowerCamelCase - Clarity at call site
- No abbreviations except universal (URL, ID)
swift
// Preferred
let maximumWidgetCount = 100
func fetchUser(byID id: String) -> UserGolden Path
Left-hand margin is the happy path. Don't nest statements.
ifswift
// Preferred
func process(value: Int?) throws -> Result {
guard let value = value else {
throw ProcessError.nilValue
}
guard value > 0 else {
throw ProcessError.invalidValue
}
return compute(value)
}Code Organization
Use extensions and MARK comments:
swift
class MyViewController: UIViewController {
// Core implementation
}
// MARK: - UITableViewDataSource
extension MyViewController: UITableViewDataSource { }Spacing
- Braces open on same line, close on new line
- One blank line between methods
- Colon: no space before, one space after
Self
Avoid unless required by compiler.
selfswift
// Preferred
func configure() {
backgroundColor = .systemBackground
}Computed Properties
Omit for read-only:
getswift
var diameter: Double {
radius * 2
}Closures
Trailing closure only for single closure parameter.
Type Inference
Let compiler infer when clear. For empty collections, use type annotation:
swift
var names: [String] = []Syntactic Sugar
swift
// Preferred
var items: [String]
var cache: [String: Int]
var name: String?Access Control
- over
privatefileprivate - Don't add (it's the default)
internal - Access control as leading specifier
Memory Management
swift
resource.request().onComplete { [weak self] response in
guard let self else { return }
self.updateModel(response)
}Comments
- Explain why, not what
- Use or
//, avoid////* */ - Keep up-to-date or delete
Constants
Use case-less enum for namespacing:
swift
enum Math {
static let pi = 3.14159
}Common Mistakes
-
Abbreviations beyond URL, ID, UUID — Abbreviations like,
cfg,mgr,ctxhurt readability. Spell them out:desc,configuration,manager,context. The three exceptions are URL, ID, UUID.description -
Nested guard/if statements — Deep nesting makes code hard to follow. Use early returns and guards to keep the happy path left-aligned.
-
Inconsistent self usage — Either always omit(preferred) or always use it. Mixing makes code scanning harder and confuses capture semantics.
self -
Overly generic type names —,
Manager,Handler,Helperare too vague. Names should explain responsibility:Coordinator,PaymentProcessor,EventDispatcher,ImageCache.NavigationCoordinator -
Implied access control — Don't skip access control. Explicit,
privatehelps future maintainers understand module boundaries.publicis default, so omit it.internal