Skip to content

AGENTS.md

Latest commit

 

History

History
40 lines (34 loc) · 2.67 KB

AGENTS.md

File metadata and controls

40 lines (34 loc) · 2.67 KB

openHAB iOS Development Guide

Build/Test Commands

  • Build: xcodebuild -workspace openHAB.xcworkspace -scheme openHAB
  • Test all: fastlane unittests or xcodebuild test -workspace openHAB.xcworkspace -scheme openHABTestsSwift -destination 'platform=iOS Simulator,name=iPhone 17 Pro'
  • Single test: xcodebuild test -workspace openHAB.xcworkspace -scheme openHABTestsSwift -destination 'platform=iOS Simulator,name=iPhone 17 Pro' -only-testing:openHABTestsSwift/TestClassName/testMethodName
  • If the exact simulator is unavailable, switch to an available iPhone simulator
  • Beta build: fastlane beta
  • UI tests: xcodebuild test -workspace openHAB.xcworkspace -scheme openHABUITests

Architecture

  • Main app: openHAB/ - UIKit + SwiftUI hybrid iOS app targeting iOS 16+
  • Core library: OpenHABCore/ - Swift Package with shared business logic, models, API clients
  • Watch app: openHABWatch/ - watchOS companion app (watchOS 10+)
  • Extensions: openHABIntents/ (Siri shortcuts), NotificationService/ (rich notifications)
  • Tests: openHABTestsSwift/ (Swift Testing), openHABUITests/ (UI automation). For targeted bug fixes, run only focused tests by default.
  • Dependencies: Kingfisher (image loading), SwiftUI, Firebase, OpenAPI runtime, SFSafeSymbols

Code Style

  • Swift 6
  • SwiftUI for new views
  • Naming: PascalCase classes, camelCase properties/methods, OpenHAB prefix for core types
  • Use SFSafeSymbols for SF Symbols
  • Avoid force unwrapping, prefer optionals
  • Error handling: Result types in OpenHABCore, UIKit error alerts in main app but transition to SwiftUI wherever possible
  • Avoid trailing closure syntax when passing multiple closures (use parentheses for all closures to prevent multiple_closures_with_trailing_closure warnings)
  • Respect "BuildTools/.swiftformat" and "BuildTools/.swiftlint.yml"
  • Always use Swift Regex with Swift 6 syntax
  • Prefer guard for early exits over if/else if chains — when a branch returns, use guard/early return to flatten nesting
  • Move logic to the type that owns the data — methods that operate on a type's internals belong on that type, not in the caller
  • Drop argument labels for parameters already implied by the function name — use _ for positional parameters whose meaning is obvious from the function name, keep labels only for semantically distinct parameters
  • Prefer direct calls to shared helpers over thin wrapper closures that just forward arguments

Rules for writing tests

  • Always write tests with Swift Testing
  • Add a parameter with a default value (e.g. networkTracker: NetworkTracker = .shared) to make functions testable without coupling them to singletons

git

  • Always use git commit with -s -S