swift-api-design-macos

What problem does it solve?

This Skill solves the challenge of designing Swift APIs that work seamlessly with macOS-specific AppKit conventions, Objective-C interoperability, and system frameworks, eliminating common pitfalls like incorrect delegate naming, ObjC incompatibility, and improper error handling that lead to fragile, hard-to-maintain code.

Core Features & Use Cases

• AppKit Delegate Naming: Follows strict AppKit delegate and data source naming conventions for clarity and consistency with system frameworks.
• @objc Protocol Design: Guides proper @objc protocol setup, optional method handling, and ObjC representability for cross-language interoperability.
• Error Type Design: Covers POSIXError, CocoaError, and custom LocalizedError implementation for reliable error handling across Swift and ObjC boundaries.
• Swift Package Structure: Provides best practices for modular macOS library packaging with separated core, platform-specific, and umbrella targets.
• Use Case: Ideal for developers building macOS frameworks, libraries, or large apps that need to expose clean, idiomatic Swift APIs that work with both Swift and Objective-C code, or distribute via Swift Package Manager.

Quick Start

Use the swift-api-design-macos skill to audit your macOS framework's public API surface for compliance with Swift API Design Guidelines and AppKit interoperability best practices.