skills/desquared/agents-rules-skills/ios-swift-api-design-reviewer

ios-swift-api-design-reviewer

SKILL.md

Swift API Design Review

Naming Rules

  • Clear at point of use, not declaration
  • Omit needless words
  • lowerCamelCase: properties, methods
  • UpperCamelCase: types, protocols
  • Booleans: is, has, can, should
  • Mutating: verb (sort()), Non-mutating: noun (sorted())

Common Issues

Issue Fix
var visible var isVisible
func get() func getUserName()
var nameString var name
add(item: x, to: y) add(_ item: x, to: y)

Parameter Design

  • Closure parameters: last
  • Default parameters: at end
  • First label: omit when forming phrase with function
  • Labels clarify purpose

Return Types

  • Optional when nil is meaningful
  • Result for failable operations
  • Tuples max 3 elements (else use struct)

Severity

  • 🔴 Critical: Violates guidelines
  • 🟡 Improvement: Could be clearer
  • 🟢 Enhancement: Optional polish
Weekly Installs
5
GitHub Stars
2
First Seen
5 days ago
Installed on
amp5
gemini-cli5
github-copilot5
codex5
kimi-cli5
opencode5