Requirements
- Target platform
- OpenClaw
- Install method
- Manual import
- Extraction
- Extract archive
- Prerequisites
- OpenClaw
- Primary doc
- SKILL.md
Generate FOSMVVM-compliant SwiftUI ViewModels with client- or server-hosted factories, localization bindings, and stub factories for screens and components.
Generate FOSMVVM-compliant SwiftUI ViewModels with client- or server-hosted factories, localization bindings, and stub factories for screens and components.
Hand the extracted package to your coding agent with a concrete install brief instead of figuring it out manually.
I downloaded a skill package from Yavira. Read SKILL.md from the extracted folder and install it by following the included instructions. Tell me what you changed and call out any manual steps you could not complete.
I downloaded an updated skill package from Yavira. Read SKILL.md from the extracted folder, compare it with my current installation, and upgrade it while preserving any custom configuration unless the package docs explicitly say otherwise. Summarize what changed and any follow-up checks I should run.
Generate ViewModels following FOSMVVM architecture patterns.
For full architecture context, see FOSMVVMArchitecture.md | OpenClaw reference A ViewModel is the bridge in the Model-View-ViewModel architecture: βββββββββββββββ βββββββββββββββββββ βββββββββββββββ β Model β ββββΊ β ViewModel β ββββΊ β View β β (Data) β β (The Bridge) β β (SwiftUI) β βββββββββββββββ βββββββββββββββββββ βββββββββββββββ Key insight: In FOSMVVM, ViewModels are: Created by a Factory (either server-side or client-side) Localized during encoding (resolves all @LocalizedString references) Consumed by Views which just render the localized data
This is a per-ViewModel decision. An app can mix both modes - for example, a standalone iPhone app with server-based sign-in. The key question: Where does THIS ViewModel's data come from? Data SourceHosting ModeFactoryServer/DatabaseServer-HostedHand-writtenLocal state/preferencesClient-HostedMacro-generatedResponseError (caught error)Client-HostedMacro-generated
When data comes from a server: Factory is hand-written on server (ViewModelFactory protocol) Factory queries database, builds ViewModel Server localizes during JSON encoding Client receives fully localized ViewModel Examples: Sign-in screen, user profile from API, dashboard with server data
When data is local to the device: Use @ViewModel(options: [.clientHostedFactory]) Macro auto-generates factory from init parameters Client bundles YAML resources Client localizes during encoding Examples: Settings screen, onboarding, offline-first features, error display
Error display is a classic client-hosted scenario. You already have the data from ResponseError - just wrap it in a specific ViewModel for that error: // Specific ViewModel for MoveIdeaRequest errors @ViewModel(options: [.clientHostedFactory]) struct MoveIdeaErrorViewModel { let message: LocalizableString let errorCode: String public var vmId = ViewModelId() // Takes the specific ResponseError init(responseError: MoveIdeaRequest.ResponseError) { self.message = responseError.message self.errorCode = responseError.code.rawValue } } Usage: catch let error as MoveIdeaRequest.ResponseError { let vm = MoveIdeaErrorViewModel(responseError: error) return try await req.view.render("Shared/ToastView", vm) } Each error scenario gets its own ViewModel: MoveIdeaErrorViewModel for MoveIdeaRequest.ResponseError CreateIdeaErrorViewModel for CreateIdeaRequest.ResponseError SettingsValidationErrorViewModel for settings form errors Don't create a generic "ToastViewModel" or "ErrorViewModel" - that's unified error architecture, which we avoid. Key insights: No server request needed - you already caught the error The LocalizableString properties in ResponseError are already localized (server did it) Standard ViewModel β View encoding chain handles this correctly; already-localized strings pass through unchanged Client-hosted ViewModel wraps existing data; the macro generates the factory
Many apps use both: βββββββββββββββββββββββββββββββββββββββββββββββββ β iPhone App β βββββββββββββββββββββββββββββββββββββββββββββββββ€ β SettingsViewModel β Client-Hosted β β OnboardingViewModel β Client-Hosted β β MoveIdeaErrorViewModel β Client-Hosted β β Error display β SignInViewModel β Server-Hosted β β UserProfileViewModel β Server-Hosted β βββββββββββββββββββββββββββββββββββββββββββββββββ Same ViewModel patterns work in both modes - only the factory creation differs.
A ViewModel's job is shaping data for presentation. This happens in two places: Factory - what data is needed, how to transform it Localization - how to present it in context (including locale-aware ordering) The View just renders - it should never compose, format, or reorder ViewModel properties.
A ViewModel answers: "What does the View need to display?" Content TypeHow It's RepresentedExampleStatic UI text@LocalizedStringPage titles, button labels (fixed text)Dynamic enum valuesLocalizableString (stored)Status/state display (see Enum Localization Pattern)Dynamic data in text@LocalizedSubs"Welcome, %{name}!" with substitutionsComposed text@LocalizedCompoundStringFull name from pieces (locale-aware order)Formatted datesLocalizableDatecreatedAt: LocalizableDateFormatted numbersLocalizableInttotalCount: LocalizableIntDynamic dataPlain propertiescontent: String, count: IntNested componentsChild ViewModelscards: [CardViewModel]
Database relationships (@Parent, @Siblings) Business logic or validation (that's in Fields protocols) Raw database IDs exposed to templates (use typed properties) Unlocalized strings that Views must look up
// β WRONG - View is composing Text(viewModel.firstName) + Text(" ") + Text(viewModel.lastName) // β RIGHT - ViewModel provides shaped result Text(viewModel.fullName) // via @LocalizedCompoundString If you see + or string interpolation in a View, the shaping belongs in the ViewModel.
public protocol ViewModel: ServerRequestBody, RetrievablePropertyNames, Identifiable, Stubbable { var vmId: ViewModelId { get } } public protocol RequestableViewModel: ViewModel { associatedtype Request: ViewModelRequest } ViewModel provides: ServerRequestBody - Can be sent over HTTP as JSON RetrievablePropertyNames - Enables @LocalizedString binding (via @ViewModel macro) Identifiable - Has vmId for SwiftUI identity Stubbable - Has stub() for testing/previews RequestableViewModel adds: Associated Request type for fetching from server
Represents a full page or screen. Has: An associated ViewModelRequest type A ViewModelFactory that builds it from database Child ViewModels embedded within it @ViewModel public struct DashboardViewModel: RequestableViewModel { public typealias Request = DashboardRequest @LocalizedString public var pageTitle public let cards: [CardViewModel] // Children public var vmId: ViewModelId = .init() }
Nested components built by their parent's factory. No Request type. @ViewModel public struct CardViewModel: Codable, Sendable { public let id: ModelIdType public let title: String public let createdAt: LocalizableDate public var vmId: ViewModelId = .init() }
ViewModels serve two distinct purposes: PurposeViewModel TypeAdopts Fields?Display data (read-only)Display ViewModelNoCollect user input (editable)Form ViewModelYes
For showing data - cards, rows, lists, detail views: @ViewModel public struct UserCardViewModel { public let id: ModelIdType public let name: String @LocalizedString public var roleDisplayName public let createdAt: LocalizableDate public var vmId: ViewModelId = .init() } Characteristics: Properties are let (read-only) No validation needed No FormField definitions Just projects Model data for display
For collecting input - create forms, edit forms, settings: @ViewModel public struct UserFormViewModel: UserFields { // β Adopts Fields! public var id: ModelIdType? public var email: String public var firstName: String public var lastName: String public let userValidationMessages: UserFieldsMessages public var vmId: ViewModelId = .init() } Characteristics: Properties are var (editable) Adopts a Fields protocol for validation Gets FormField definitions from Fields Gets validation logic from Fields Gets localized error messages from Fields
βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ β UserFields Protocol β β (defines editable properties + validation) β β β β Adopted by: β β βββββββββββββββββββ βββββββββββββββββββ βββββββββββββββββββ β β β CreateUserReq β β UserFormVM β β User (Model) β β β β .RequestBody β β (UI form) β β (persistence) β β β βββββββββββββββββββ βββββββββββββββββββ βββββββββββββββββββ β β β β Same validation logic everywhere! β βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
The key question: "Is the user editing data in this ViewModel?" No β Display ViewModel (no Fields) Yes β Form ViewModel (adopt Fields) ViewModelUser Edits?Adopt Fields?UserCardViewModelNoNoUserRowViewModelNoNoUserDetailViewModelNoNoUserFormViewModelYesUserFieldsCreateUserViewModelYesUserFieldsEditUserViewModelYesUserFieldsSettingsViewModelYesSettingsFields
Creating a new page or screen Adding a new UI component (card, row, modal, etc.) Displaying data from the database in a View Following an implementation plan that requires new ViewModels
FileLocationPurpose{Name}ViewModel.swift{ViewModelsTarget}/The ViewModel struct{Name}Request.swift{ViewModelsTarget}/The ViewModelRequest type{Name}ViewModel.yml{ResourcesPath}/Localization strings{Name}ViewModel+Factory.swift{WebServerTarget}/Factory that builds from DB
FileLocationPurpose{Name}ViewModel.swift{ViewModelsTarget}/ViewModel with clientHostedFactory option{Name}ViewModel.yml{ResourcesPath}/Localization strings (bundled in app) No Request or Factory files needed - macro generates them!
FileLocationPurpose{Name}ViewModel.swift{ViewModelsTarget}/The ViewModel struct{Name}ViewModel.yml{ResourcesPath}/Localization (if has @LocalizedString) Note: If child is only used by one parent and represents a summary/reference (not a full ViewModel), nest it inside the parent file instead. See Nested Child Types Pattern under Key Patterns.
PlaceholderDescriptionExample{ViewModelsTarget}Shared ViewModels SPM targetViewModels{ResourcesPath}Localization resourcesSources/Resources{WebServerTarget}Server-side targetWebServer, AppServer
Invocation: /fosmvvm-viewmodel-generator Prerequisites: View requirements understood from conversation context Data source determined (server/database vs local state) Display vs Form decision made (if user input involved, Fields protocol exists) Workflow integration: This skill is typically used after discussing View requirements or reading specification files. The skill references conversation context automaticallyβno file paths or Q&A needed. For Form ViewModels, run fosmvvm-fields-generator first to create the Fields protocol.
This skill references conversation context to determine ViewModel structure:
From conversation context, the skill identifies: Data source (server/database vs local state/preferences) Server-hosted β Hand-written factory, server-side localization Client-hosted β Macro-generated factory, client-side localization
From requirements already in context: View purpose (page, modal, card, row component) Data needs (from database query, from AppState, from caught error) Static UI text (titles, labels, buttons requiring @LocalizedString) Child ViewModels (nested components) Hierarchy level (top-level RequestableViewModel vs child ViewModel)
Based on View requirements: Display properties (data to render) Localization requirements (which properties use @LocalizedString) Identity strategy (singleton vmId vs instance-based vmId) Form adoption (whether ViewModel adopts Fields protocol)
Server-Hosted Top-Level: ViewModel struct (with RequestableViewModel) Request type YAML localization Factory implementation Client-Hosted Top-Level: ViewModel struct (with clientHostedFactory option) YAML localization Child (either mode): ViewModel struct YAML localization (if needed)
Skill references information from: Prior conversation: View requirements, data sources discussed with user Specification files: If Claude has read UI specs or feature docs into context Fields protocols: From codebase or previous fosmvvm-fields-generator invocation
Always use the @ViewModel macro - it generates the propertyNames() method required for localization binding. Server-Hosted (basic macro): @ViewModel public struct MyViewModel: RequestableViewModel { public typealias Request = MyRequest @LocalizedString public var title public var vmId: ViewModelId = .init() public init() {} } Client-Hosted (with factory generation): @ViewModel(options: [.clientHostedFactory]) public struct SettingsViewModel { @LocalizedString public var pageTitle public var vmId: ViewModelId = .init() public init(theme: Theme, notifications: NotificationSettings) { // Init parameters become AppState properties } } // Macro auto-generates: // - typealias Request = ClientHostedRequest // - struct AppState { let theme: Theme; let notifications: NotificationSettings } // - class ClientHostedRequest: ViewModelRequest { ... } // - static func model(context:) async throws -> Self { ... }
All ViewModels must support stub() for testing and SwiftUI previews: public extension MyViewModel { static func stub() -> Self { .init(/* default values */) } }
Every ViewModel needs a vmId for SwiftUI's identity system: Singleton (one per page): vmId = .init(type: Self.self) Instance (multiple per page): vmId = .init(id: id) where id: ModelIdType
Static UI text uses @LocalizedString: @LocalizedString public var pageTitle With corresponding YAML: en: MyViewModel: pageTitle: "Welcome"
Never send pre-formatted strings. Use localizable types: public let createdAt: LocalizableDate // NOT String public let itemCount: LocalizableInt // NOT String The client formats these according to user's locale and timezone.
For dynamic enum values (status, state, category), use a stored LocalizableString - NOT @LocalizedString. @LocalizedString always looks up the same key (the property name). A stored LocalizableString carries the dynamic key from the enum case. // Enum provides localizableString public enum SessionState: String, CaseIterable, Codable, Sendable { case pending, running, completed, failed public var localizableString: LocalizableString { .localized(for: Self.self, propertyName: rawValue) } } // ViewModel stores it (NOT @LocalizedString) @ViewModel public struct SessionCardViewModel { public let state: SessionState // Raw enum for data attributes public let stateDisplay: LocalizableString // Localized display text public init(session: Session) { self.state = session.state self.stateDisplay = session.state.localizableString } } # YAML keys match enum type and case names en: SessionState: pending: "Pending" running: "Running" completed: "Completed" failed: "Failed" Constraint: LocalizableString only works in ViewModels encoded with localizingEncoder(). Do not use in Fluent JSONB fields or other persisted types.
Top-level ViewModels contain their children: @ViewModel public struct BoardViewModel: RequestableViewModel { public let columns: [ColumnViewModel] public let cards: [CardViewModel] } The Factory builds all children when building the parent. Nested Child Types Pattern When a child type is only used by one parent and represents a summary or reference (not a full ViewModel), nest it inside the parent: @ViewModel public struct GovernancePrincipleCardViewModel: Codable, Sendable, Identifiable { // Properties come first public let versionHistory: [GovernancePrincipleVersionSummary]? public let referencingDecisions: [GovernanceDecisionReference]? // MARK: - Nested Types /// Summary of a principle version for display in version history. public struct GovernancePrincipleVersionSummary: Codable, Sendable, Identifiable, Stubbable { public let id: ModelIdType public let version: Int public let createdAt: Date public init(id: ModelIdType, version: Int, createdAt: Date) { self.id = id self.version = version self.createdAt = createdAt } } /// Reference to a decision that cites this principle. public struct GovernanceDecisionReference: Codable, Sendable, Identifiable, Stubbable { public let id: ModelIdType public let title: String public let decisionNumber: String public let createdAt: Date public init(id: ModelIdType, title: String, decisionNumber: String, createdAt: Date) { self.id = id self.title = title self.decisionNumber = decisionNumber self.createdAt = createdAt } } // vmId and parent init follow public let vmId: ViewModelId // ... } Reference: Sources/KairosModels/Governance/GovernancePrincipleCardViewModel.swift Placement rules: Nested types go AFTER the properties that reference them Before vmId and the parent's init Use // MARK: - Nested Types section marker Each nested type gets its own doc comment Conformances for nested types: Codable - for ViewModel encoding Sendable - for Swift 6 concurrency Identifiable - for SwiftUI ForEach if used in arrays Stubbable - for testing/previews Two-Tier Stubbable Pattern: Nested types use fully qualified names in their extensions: public extension GovernancePrincipleCardViewModel.GovernancePrincipleVersionSummary { // Tier 1: Zero-arg convenience (ALWAYS delegates to tier 2) static func stub() -> Self { .stub(id: .init()) } // Tier 2: Full parameterized with defaults static func stub( id: ModelIdType = .init(), version: Int = 1, createdAt: Date = .now ) -> Self { .init(id: id, version: version, createdAt: createdAt) } } public extension GovernancePrincipleCardViewModel.GovernanceDecisionReference { static func stub() -> Self { .stub(id: .init()) } static func stub( id: ModelIdType = .init(), title: String = "A Title", decisionNumber: String = "DEC-12345", createdAt: Date = .now ) -> Self { .init(id: id, title: title, decisionNumber: decisionNumber, createdAt: createdAt) } } Why two tiers: Tests often just need [.stub()] without caring about values Other tests need specific values: .stub(name: "Specific Name") Zero-arg ALWAYS calls parameterized version (single source of truth) When to nest vs keep top-level: Nest Inside ParentKeep Top-LevelChild is ONLY used by this parentChild is shared across multiple parentsChild represents subset/summaryChild is a full ViewModelChild has no @ViewModel macroChild has @ViewModel macroChild is not RequestableViewModelChild is RequestableViewModelExample: VersionSummary, ReferenceExample: CardViewModel, ListViewModel Examples: Card with nested summaries: @ViewModel public struct TaskCardViewModel { public let assignees: [AssigneeSummary]? public struct AssigneeSummary: Codable, Sendable, Identifiable, Stubbable { public let id: ModelIdType public let name: String public let avatarUrl: String? // ... } } List with nested references: @ViewModel public struct ProjectListViewModel { public let relatedProjects: [ProjectReference]? public struct ProjectReference: Codable, Sendable, Identifiable, Stubbable { public let id: ModelIdType public let title: String public let status: String // ... } }
Swift's synthesized Codable only encodes stored properties. Since ViewModels are serialized (for JSON transport, Leaf rendering, etc.), computed properties won't be available. // Computed - NOT encoded, invisible after serialization public var hasCards: Bool { !cards.isEmpty } // Stored - encoded, available after serialization public let hasCards: Bool When to pre-compute: For Leaf templates, you can often use Leaf's built-in functions directly: #if(count(cards) > 0) - no need for hasCards property #count(cards) - no need for cardCount property Pre-compute only when: Direct array subscripts needed (firstCard - array indexing not documented in Leaf) Complex logic that's cleaner in Swift than in template Performance-sensitive repeated calculations See fosmvvm-leaf-view-generator for Leaf template patterns.
See reference.md for complete file templates.
ConceptConventionExampleViewModel struct{Name}ViewModelDashboardViewModelRequest class{Name}RequestDashboardRequestFactory extension{Name}ViewModel+Factory.swiftDashboardViewModel+Factory.swiftYAML file{Name}ViewModel.ymlDashboardViewModel.yml
Architecture Patterns - Mental models (errors are data, type safety, etc.) FOSMVVMArchitecture.md - Full FOSMVVM architecture fosmvvm-fields-generator - For form validation fosmvvm-fluent-datamodel-generator - For Fluent persistence layer fosmvvm-leaf-view-generator - For Leaf templates that render ViewModels reference.md - Complete file templates
VersionDateChanges1.02024-12-24Initial skill2.02024-12-26Complete rewrite from architecture; generalized from Kairos-specific2.12024-12-26Added Client-Hosted mode support; per-ViewModel hosting decision2.22024-12-26Added shaping responsibility, @LocalizedSubs/@LocalizedCompoundString, anti-pattern2.32025-12-27Added Display vs Form ViewModels section; clarified Fields adoption2.42026-01-08Added Codable/computed properties section. Clarified when to pre-compute vs use Leaf built-ins.2.52026-01-19Added Enum Localization Pattern section. Clarified @LocalizedString is for static text only; stored LocalizableString for dynamic enum values.2.62026-01-24Update to context-aware approach (remove file-parsing/Q&A). Skill references conversation context instead of asking questions or accepting file paths.2.72026-01-25Added Nested Child Types Pattern section with two-tier Stubbable pattern, placement rules, conformances, and decision criteria for when to nest vs keep top-level.
Code helpers, APIs, CLIs, browser automation, testing, and developer operations.
Largest current source with strong distribution and engagement signals.