buildanything 1.8.0 → 2.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.claude-plugin/marketplace.json +3 -3
- package/.claude-plugin/plugin.json +17 -3
- package/CHANGELOG.md +57 -0
- package/README.md +57 -61
- package/agents/a11y-architect.md +168 -0
- package/agents/briefing-officer.md +172 -0
- package/agents/business-model.md +82 -29
- package/agents/code-architect.md +80 -0
- package/agents/code-reviewer.md +256 -0
- package/agents/code-simplifier.md +72 -0
- package/agents/design-brand-guardian.md +312 -53
- package/agents/design-critic.md +144 -0
- package/agents/design-inclusive-visuals-specialist.md +8 -19
- package/agents/design-ui-designer.md +352 -56
- package/agents/design-ux-architect.md +418 -55
- package/agents/design-ux-researcher.md +359 -49
- package/agents/engineering-ai-engineer.md +28 -36
- package/agents/engineering-backend-architect.md +187 -36
- package/agents/engineering-data-engineer.md +227 -43
- package/agents/engineering-devops-automator.md +229 -74
- package/agents/engineering-frontend-developer.md +223 -34
- package/agents/engineering-mobile-app-builder.md +8 -1
- package/agents/engineering-rapid-prototyper.md +45 -11
- package/agents/engineering-security-engineer.md +265 -61
- package/agents/engineering-senior-developer.md +141 -19
- package/agents/engineering-sre.md +86 -0
- package/agents/engineering-technical-writer.md +287 -41
- package/agents/feature-intel.md +111 -0
- package/agents/ios-app-review-guardian.md +21 -2
- package/agents/ios-foundation-models-specialist.md +22 -2
- package/agents/ios-product-reality-auditor.md +292 -0
- package/agents/ios-storekit-specialist.md +11 -2
- package/agents/ios-swift-architect.md +29 -1
- package/agents/ios-swift-search.md +9 -1
- package/agents/ios-swift-ui-design.md +40 -5
- package/agents/marketing-app-store-optimizer.md +248 -64
- package/agents/planner.md +221 -0
- package/agents/pr-test-analyzer.md +64 -0
- package/agents/product-feedback-synthesizer.md +70 -2
- package/agents/product-owner.md +163 -0
- package/agents/product-reality-auditor.md +216 -0
- package/agents/product-spec-writer.md +176 -0
- package/agents/refactor-cleaner.md +110 -0
- package/agents/security-reviewer.md +129 -0
- package/agents/silent-failure-hunter.md +55 -0
- package/agents/swift-build-resolver.md +121 -0
- package/agents/swift-reviewer.md +113 -0
- package/agents/tech-feasibility.md +26 -4
- package/agents/testing-api-tester.md +238 -59
- package/agents/testing-evidence-collector.md +50 -1
- package/agents/testing-performance-benchmarker.md +23 -1
- package/agents/testing-reality-checker.md +7 -1
- package/agents/visual-research.md +118 -0
- package/bin/adapters/cycle-counter-tool.ts +155 -0
- package/bin/adapters/scribe-tool.ts +73 -0
- package/bin/adapters/state-save-tool.ts +130 -0
- package/bin/adapters/write-lease-tool.ts +127 -0
- package/bin/buildanything-runtime.js +15 -0
- package/bin/buildanything-runtime.ts +241 -0
- package/bin/graph-index.js +24 -0
- package/bin/graph-index.ts +340 -0
- package/bin/mcp-servers/graph-mcp.js +26 -0
- package/bin/mcp-servers/graph-mcp.ts +481 -0
- package/bin/mcp-servers/orchestrator-mcp.js +26 -0
- package/bin/mcp-servers/orchestrator-mcp.ts +361 -0
- package/bin/setup.js +312 -76
- package/commands/add-feature.md +2 -0
- package/commands/build.md +994 -265
- package/commands/fix.md +1 -1
- package/commands/idea-sweep.md +2 -2
- package/commands/self-check.md +121 -0
- package/commands/setup.md +61 -9
- package/commands/ux-review.md +5 -5
- package/commands/verify.md +9 -9
- package/docs/migration/agents.yaml +729 -0
- package/docs/migration/phase-graph.yaml +1504 -0
- package/docs/migration/sdk-host-compat.md +18 -0
- package/hooks/compile-writer-owner-cache.ts +171 -0
- package/hooks/design-md-lint +4 -0
- package/hooks/design-md-lint.ts +295 -0
- package/hooks/hooks.json +36 -0
- package/hooks/pre-tool-use +19 -0
- package/hooks/pre-tool-use.ts +807 -0
- package/hooks/record-mode-transitions.ts +235 -0
- package/hooks/session-start +71 -1
- package/hooks/subagent-start +17 -0
- package/hooks/subagent-start.ts +472 -0
- package/hooks/subagent-stop +17 -0
- package/hooks/subagent-stop.ts +153 -0
- package/package.json +26 -4
- package/protocols/agent-prompt-authoring.md +165 -0
- package/protocols/architecture-schema.md +178 -0
- package/protocols/cleanup.md +4 -0
- package/protocols/decision-log.md +135 -0
- package/protocols/design-md-authoring.md +520 -0
- package/protocols/design-md-spec.md +362 -0
- package/protocols/fake-data-detector.md +1 -1
- package/protocols/ios-context.md +10 -11
- package/protocols/ios-fake-data-detector.md +65 -0
- package/protocols/ios-phase-branches.md +299 -39
- package/protocols/launch-readiness.md +262 -0
- package/protocols/metric-loop.md +62 -2
- package/protocols/page-spec-schema.md +234 -0
- package/protocols/product-spec-schema.md +354 -0
- package/protocols/smoke-test.md +9 -1
- package/protocols/sprint-tasks-schema.md +53 -0
- package/protocols/state-schema.json +423 -0
- package/protocols/state-schema.md +202 -0
- package/protocols/verify.md +91 -3
- package/protocols/web-phase-branches.md +395 -75
- package/skills/ios/_VENDORED.md +2 -0
- package/skills/ios/app-store-connect-metadata/SKILL.md +148 -0
- package/skills/ios/asc-privacy-manifest/SKILL.md +350 -0
- package/skills/ios/hig-components-content/SKILL.md +86 -0
- package/skills/ios/hig-components-content/references/activity-views.md +79 -0
- package/skills/ios/hig-components-content/references/charts.md +180 -0
- package/skills/ios/hig-components-content/references/collections.md +48 -0
- package/skills/ios/hig-components-content/references/color-wells.md +42 -0
- package/skills/ios/hig-components-content/references/image-views.md +82 -0
- package/skills/ios/hig-components-content/references/image-wells.md +34 -0
- package/skills/ios/hig-components-content/references/lockups.md +78 -0
- package/skills/ios/hig-components-content/references/web-views.md +36 -0
- package/skills/ios/hig-components-controls/SKILL.md +88 -0
- package/skills/ios/hig-components-controls/references/combo-boxes.md +40 -0
- package/skills/ios/hig-components-controls/references/controls.md +112 -0
- package/skills/ios/hig-components-controls/references/gauges.md +74 -0
- package/skills/ios/hig-components-controls/references/labels.md +92 -0
- package/skills/ios/hig-components-controls/references/pickers.md +128 -0
- package/skills/ios/hig-components-controls/references/rating-indicators.md +38 -0
- package/skills/ios/hig-components-controls/references/segmented-controls.md +94 -0
- package/skills/ios/hig-components-controls/references/sliders.md +92 -0
- package/skills/ios/hig-components-controls/references/steppers.md +40 -0
- package/skills/ios/hig-components-controls/references/text-fields.md +88 -0
- package/skills/ios/hig-components-controls/references/text-views.md +56 -0
- package/skills/ios/hig-components-controls/references/toggles.md +127 -0
- package/skills/ios/hig-components-controls/references/token-fields.md +48 -0
- package/skills/ios/hig-components-controls/references/virtual-keyboards.md +156 -0
- package/skills/ios/hig-components-dialogs/SKILL.md +76 -0
- package/skills/ios/hig-components-dialogs/references/action-sheets.md +74 -0
- package/skills/ios/hig-components-dialogs/references/alerts.md +158 -0
- package/skills/ios/hig-components-dialogs/references/digit-entry-views.md +32 -0
- package/skills/ios/hig-components-dialogs/references/popovers.md +81 -0
- package/skills/ios/hig-components-dialogs/references/sheets.md +157 -0
- package/skills/ios/hig-components-layout/SKILL.md +99 -0
- package/skills/ios/hig-components-layout/references/boxes.md +48 -0
- package/skills/ios/hig-components-layout/references/column-views.md +44 -0
- package/skills/ios/hig-components-layout/references/lists-and-tables.md +99 -0
- package/skills/ios/hig-components-layout/references/ornaments.md +56 -0
- package/skills/ios/hig-components-layout/references/outline-views.md +64 -0
- package/skills/ios/hig-components-layout/references/panels.md +75 -0
- package/skills/ios/hig-components-layout/references/scroll-views.md +123 -0
- package/skills/ios/hig-components-layout/references/sidebars.md +109 -0
- package/skills/ios/hig-components-layout/references/split-views.md +110 -0
- package/skills/ios/hig-components-layout/references/tab-bars.md +173 -0
- package/skills/ios/hig-components-layout/references/tab-views.md +68 -0
- package/skills/ios/hig-components-layout/references/windows.md +188 -0
- package/skills/ios/hig-components-menus/SKILL.md +81 -0
- package/skills/ios/hig-components-menus/references/action-button.md +61 -0
- package/skills/ios/hig-components-menus/references/buttons.md +261 -0
- package/skills/ios/hig-components-menus/references/context-menus.md +105 -0
- package/skills/ios/hig-components-menus/references/disclosure-controls.md +84 -0
- package/skills/ios/hig-components-menus/references/dock-menus.md +40 -0
- package/skills/ios/hig-components-menus/references/edit-menus.md +88 -0
- package/skills/ios/hig-components-menus/references/menus.md +171 -0
- package/skills/ios/hig-components-menus/references/pop-up-buttons.md +70 -0
- package/skills/ios/hig-components-menus/references/pull-down-buttons.md +77 -0
- package/skills/ios/hig-components-menus/references/the-menu-bar.md +303 -0
- package/skills/ios/hig-components-menus/references/toolbars.md +256 -0
- package/skills/ios/hig-components-search/SKILL.md +68 -0
- package/skills/ios/hig-components-search/references/page-controls.md +120 -0
- package/skills/ios/hig-components-search/references/path-controls.md +40 -0
- package/skills/ios/hig-components-search/references/search-fields.md +189 -0
- package/skills/ios/hig-components-status/SKILL.md +80 -0
- package/skills/ios/hig-components-status/references/activity-rings.md +105 -0
- package/skills/ios/hig-components-status/references/progress-indicators.md +116 -0
- package/skills/ios/hig-components-status/references/status-bars.md +38 -0
- package/skills/ios/hig-components-system/SKILL.md +88 -0
- package/skills/ios/hig-components-system/references/app-clips.md +387 -0
- package/skills/ios/hig-components-system/references/app-shortcuts.md +114 -0
- package/skills/ios/hig-components-system/references/complications.md +425 -0
- package/skills/ios/hig-components-system/references/home-screen-quick-actions.md +42 -0
- package/skills/ios/hig-components-system/references/live-activities.md +442 -0
- package/skills/ios/hig-components-system/references/notifications.md +153 -0
- package/skills/ios/hig-components-system/references/top-shelf.md +135 -0
- package/skills/ios/hig-components-system/references/watch-faces.md +40 -0
- package/skills/ios/hig-components-system/references/widgets.md +517 -0
- package/skills/ios/hig-foundations/SKILL.md +98 -0
- package/skills/ios/hig-foundations/references/accessibility.md +291 -0
- package/skills/ios/hig-foundations/references/app-icons.md +210 -0
- package/skills/ios/hig-foundations/references/branding.md +44 -0
- package/skills/ios/hig-foundations/references/color.md +274 -0
- package/skills/ios/hig-foundations/references/dark-mode.md +116 -0
- package/skills/ios/hig-foundations/references/icons.md +263 -0
- package/skills/ios/hig-foundations/references/images.md +176 -0
- package/skills/ios/hig-foundations/references/immersive-experiences.md +174 -0
- package/skills/ios/hig-foundations/references/inclusion.md +189 -0
- package/skills/ios/hig-foundations/references/layout.md +425 -0
- package/skills/ios/hig-foundations/references/materials.md +238 -0
- package/skills/ios/hig-foundations/references/motion.md +103 -0
- package/skills/ios/hig-foundations/references/privacy.md +231 -0
- package/skills/ios/hig-foundations/references/right-to-left.md +206 -0
- package/skills/ios/hig-foundations/references/sf-symbols.md +310 -0
- package/skills/ios/hig-foundations/references/spatial-layout.md +142 -0
- package/skills/ios/hig-foundations/references/typography.md +1146 -0
- package/skills/ios/hig-foundations/references/writing.md +91 -0
- package/skills/ios/hig-inputs/SKILL.md +94 -0
- package/skills/ios/hig-inputs/references/apple-pencil-and-scribble.md +148 -0
- package/skills/ios/hig-inputs/references/camera-control.md +107 -0
- package/skills/ios/hig-inputs/references/digital-crown.md +83 -0
- package/skills/ios/hig-inputs/references/eyes.md +120 -0
- package/skills/ios/hig-inputs/references/focus-and-selection.md +120 -0
- package/skills/ios/hig-inputs/references/game-controls.md +156 -0
- package/skills/ios/hig-inputs/references/gestures.md +208 -0
- package/skills/ios/hig-inputs/references/gyro-and-accelerometer.md +40 -0
- package/skills/ios/hig-inputs/references/keyboards.md +234 -0
- package/skills/ios/hig-inputs/references/nearby-interactions.md +70 -0
- package/skills/ios/hig-inputs/references/pointing-devices.md +237 -0
- package/skills/ios/hig-inputs/references/remotes.md +67 -0
- package/skills/ios/hig-inputs/references/spatial-interactions.md +70 -0
- package/skills/ios/hig-patterns/SKILL.md +104 -0
- package/skills/ios/hig-patterns/references/charting-data.md +81 -0
- package/skills/ios/hig-patterns/references/collaboration-and-sharing.md +86 -0
- package/skills/ios/hig-patterns/references/drag-and-drop.md +134 -0
- package/skills/ios/hig-patterns/references/entering-data.md +69 -0
- package/skills/ios/hig-patterns/references/feedback.md +67 -0
- package/skills/ios/hig-patterns/references/file-management.md +135 -0
- package/skills/ios/hig-patterns/references/going-full-screen.md +79 -0
- package/skills/ios/hig-patterns/references/launching.md +81 -0
- package/skills/ios/hig-patterns/references/live-viewing-apps.md +79 -0
- package/skills/ios/hig-patterns/references/loading.md +59 -0
- package/skills/ios/hig-patterns/references/managing-accounts.md +107 -0
- package/skills/ios/hig-patterns/references/managing-notifications.md +99 -0
- package/skills/ios/hig-patterns/references/modality.md +82 -0
- package/skills/ios/hig-patterns/references/multitasking.md +131 -0
- package/skills/ios/hig-patterns/references/offering-help.md +117 -0
- package/skills/ios/hig-patterns/references/onboarding.md +69 -0
- package/skills/ios/hig-patterns/references/playing-audio.md +124 -0
- package/skills/ios/hig-patterns/references/playing-haptics.md +280 -0
- package/skills/ios/hig-patterns/references/playing-video.md +180 -0
- package/skills/ios/hig-patterns/references/printing.md +50 -0
- package/skills/ios/hig-patterns/references/ratings-and-reviews.md +48 -0
- package/skills/ios/hig-patterns/references/searching.md +70 -0
- package/skills/ios/hig-patterns/references/settings.md +84 -0
- package/skills/ios/hig-patterns/references/undo-and-redo.md +58 -0
- package/skills/ios/hig-patterns/references/workouts.md +76 -0
- package/skills/ios/hig-platforms/SKILL.md +84 -0
- package/skills/ios/hig-platforms/references/designing-for-games.md +159 -0
- package/skills/ios/hig-platforms/references/designing-for-ios.md +66 -0
- package/skills/ios/hig-platforms/references/designing-for-ipados.md +64 -0
- package/skills/ios/hig-platforms/references/designing-for-macos.md +70 -0
- package/skills/ios/hig-platforms/references/designing-for-tvos.md +68 -0
- package/skills/ios/hig-platforms/references/designing-for-visionos.md +85 -0
- package/skills/ios/hig-platforms/references/designing-for-watchos.md +74 -0
- package/skills/ios/hig-project-context/SKILL.md +133 -0
- package/skills/ios/hig-technologies/SKILL.md +107 -0
- package/skills/ios/hig-technologies/references/airplay.md +125 -0
- package/skills/ios/hig-technologies/references/always-on.md +62 -0
- package/skills/ios/hig-technologies/references/apple-pay.md +441 -0
- package/skills/ios/hig-technologies/references/augmented-reality.md +247 -0
- package/skills/ios/hig-technologies/references/carekit.md +224 -0
- package/skills/ios/hig-technologies/references/carplay.md +119 -0
- package/skills/ios/hig-technologies/references/game-center.md +343 -0
- package/skills/ios/hig-technologies/references/generative-ai.md +110 -0
- package/skills/ios/hig-technologies/references/healthkit.md +120 -0
- package/skills/ios/hig-technologies/references/homekit.md +343 -0
- package/skills/ios/hig-technologies/references/icloud.md +52 -0
- package/skills/ios/hig-technologies/references/id-verifier.md +73 -0
- package/skills/ios/hig-technologies/references/imessage-apps-and-stickers.md +105 -0
- package/skills/ios/hig-technologies/references/in-app-purchase.md +263 -0
- package/skills/ios/hig-technologies/references/live-photos.md +54 -0
- package/skills/ios/hig-technologies/references/mac-catalyst.md +216 -0
- package/skills/ios/hig-technologies/references/machine-learning.md +394 -0
- package/skills/ios/hig-technologies/references/maps.md +221 -0
- package/skills/ios/hig-technologies/references/nfc.md +51 -0
- package/skills/ios/hig-technologies/references/photo-editing.md +40 -0
- package/skills/ios/hig-technologies/references/researchkit.md +134 -0
- package/skills/ios/hig-technologies/references/shareplay.md +142 -0
- package/skills/ios/hig-technologies/references/shazamkit.md +47 -0
- package/skills/ios/hig-technologies/references/sign-in-with-apple.md +288 -0
- package/skills/ios/hig-technologies/references/siri.md +523 -0
- package/skills/ios/hig-technologies/references/tap-to-pay-on-iphone.md +208 -0
- package/skills/ios/hig-technologies/references/voiceover.md +90 -0
- package/skills/ios/hig-technologies/references/wallet.md +420 -0
- package/skills/ios/ios-bootstrap/SKILL.md +17 -8
- package/skills/ios/swift-actor-persistence/SKILL.md +143 -0
- package/skills/ios/swift-concurrency-6-2/SKILL.md +216 -0
- package/skills/ios/swift-protocol-di-testing/SKILL.md +190 -0
- package/skills/ios/swiftui-design-tokens/SKILL.md +475 -0
- package/skills/ios/writing-for-interfaces/SKILL.md +75 -0
- package/skills/web/accessibility/SKILL.md +146 -0
- package/skills/web/aceternity-ui/SKILL.md +719 -0
- package/skills/web/aceternity-ui/metadata.json +10 -0
- package/skills/web/api-design/SKILL.md +523 -0
- package/skills/web/chart-accessibility/SKILL.md +332 -0
- package/skills/web/composition-patterns/AGENTS.md +946 -0
- package/skills/web/composition-patterns/README.md +60 -0
- package/skills/web/composition-patterns/SKILL.md +89 -0
- package/skills/web/composition-patterns/metadata.json +11 -0
- package/skills/web/composition-patterns/rules/_sections.md +29 -0
- package/skills/web/composition-patterns/rules/_template.md +24 -0
- package/skills/web/composition-patterns/rules/architecture-avoid-boolean-props.md +100 -0
- package/skills/web/composition-patterns/rules/architecture-compound-components.md +112 -0
- package/skills/web/composition-patterns/rules/patterns-children-over-render-props.md +87 -0
- package/skills/web/composition-patterns/rules/patterns-explicit-variants.md +100 -0
- package/skills/web/composition-patterns/rules/react19-no-forwardref.md +42 -0
- package/skills/web/composition-patterns/rules/state-context-interface.md +191 -0
- package/skills/web/composition-patterns/rules/state-decouple-implementation.md +113 -0
- package/skills/web/composition-patterns/rules/state-lift-state.md +125 -0
- package/skills/web/cost-aware-llm-pipeline/SKILL.md +183 -0
- package/skills/web/database-migrations/SKILL.md +429 -0
- package/skills/web/deployment-patterns/SKILL.md +427 -0
- package/skills/web/docker-patterns/SKILL.md +364 -0
- package/skills/web/e2e-testing/SKILL.md +326 -0
- package/skills/web/lighthouse-ci/SKILL.md +361 -0
- package/skills/web/mcp-server-patterns/SKILL.md +69 -0
- package/skills/web/next-best-practices/SKILL.md +153 -0
- package/skills/web/next-best-practices/async-patterns.md +87 -0
- package/skills/web/next-best-practices/bundling.md +180 -0
- package/skills/web/next-best-practices/data-patterns.md +297 -0
- package/skills/web/next-best-practices/debug-tricks.md +105 -0
- package/skills/web/next-best-practices/directives.md +73 -0
- package/skills/web/next-best-practices/error-handling.md +227 -0
- package/skills/web/next-best-practices/file-conventions.md +140 -0
- package/skills/web/next-best-practices/font.md +245 -0
- package/skills/web/next-best-practices/functions.md +108 -0
- package/skills/web/next-best-practices/hydration-error.md +91 -0
- package/skills/web/next-best-practices/image.md +173 -0
- package/skills/web/next-best-practices/metadata.md +301 -0
- package/skills/web/next-best-practices/parallel-routes.md +287 -0
- package/skills/web/next-best-practices/route-handlers.md +146 -0
- package/skills/web/next-best-practices/rsc-boundaries.md +159 -0
- package/skills/web/next-best-practices/runtime-selection.md +39 -0
- package/skills/web/next-best-practices/scripts.md +141 -0
- package/skills/web/next-best-practices/self-hosting.md +371 -0
- package/skills/web/next-best-practices/suspense-boundaries.md +67 -0
- package/skills/web/next-cache-components/SKILL.md +411 -0
- package/skills/web/postgres-best-practices/SKILL.md +14 -0
- package/skills/web/postgres-best-practices/references/schema-design.md +9 -0
- package/skills/web/react-best-practices/AGENTS.md +3810 -0
- package/skills/web/react-best-practices/README.md +123 -0
- package/skills/web/react-best-practices/SKILL.md +149 -0
- package/skills/web/react-best-practices/metadata.json +15 -0
- package/skills/web/react-best-practices/rules/_sections.md +46 -0
- package/skills/web/react-best-practices/rules/_template.md +28 -0
- package/skills/web/react-best-practices/rules/advanced-effect-event-deps.md +56 -0
- package/skills/web/react-best-practices/rules/advanced-event-handler-refs.md +55 -0
- package/skills/web/react-best-practices/rules/advanced-init-once.md +42 -0
- package/skills/web/react-best-practices/rules/advanced-use-latest.md +39 -0
- package/skills/web/react-best-practices/rules/async-api-routes.md +38 -0
- package/skills/web/react-best-practices/rules/async-cheap-condition-before-await.md +37 -0
- package/skills/web/react-best-practices/rules/async-defer-await.md +82 -0
- package/skills/web/react-best-practices/rules/async-dependencies.md +51 -0
- package/skills/web/react-best-practices/rules/async-parallel.md +28 -0
- package/skills/web/react-best-practices/rules/async-suspense-boundaries.md +99 -0
- package/skills/web/react-best-practices/rules/bundle-analyzable-paths.md +63 -0
- package/skills/web/react-best-practices/rules/bundle-barrel-imports.md +60 -0
- package/skills/web/react-best-practices/rules/bundle-conditional.md +31 -0
- package/skills/web/react-best-practices/rules/bundle-defer-third-party.md +49 -0
- package/skills/web/react-best-practices/rules/bundle-dynamic-imports.md +35 -0
- package/skills/web/react-best-practices/rules/bundle-preload.md +50 -0
- package/skills/web/react-best-practices/rules/client-event-listeners.md +74 -0
- package/skills/web/react-best-practices/rules/client-localstorage-schema.md +71 -0
- package/skills/web/react-best-practices/rules/client-passive-event-listeners.md +48 -0
- package/skills/web/react-best-practices/rules/client-swr-dedup.md +56 -0
- package/skills/web/react-best-practices/rules/js-batch-dom-css.md +107 -0
- package/skills/web/react-best-practices/rules/js-cache-function-results.md +80 -0
- package/skills/web/react-best-practices/rules/js-cache-property-access.md +28 -0
- package/skills/web/react-best-practices/rules/js-cache-storage.md +70 -0
- package/skills/web/react-best-practices/rules/js-combine-iterations.md +32 -0
- package/skills/web/react-best-practices/rules/js-early-exit.md +50 -0
- package/skills/web/react-best-practices/rules/js-flatmap-filter.md +60 -0
- package/skills/web/react-best-practices/rules/js-hoist-regexp.md +45 -0
- package/skills/web/react-best-practices/rules/js-index-maps.md +37 -0
- package/skills/web/react-best-practices/rules/js-length-check-first.md +49 -0
- package/skills/web/react-best-practices/rules/js-min-max-loop.md +82 -0
- package/skills/web/react-best-practices/rules/js-request-idle-callback.md +105 -0
- package/skills/web/react-best-practices/rules/js-set-map-lookups.md +24 -0
- package/skills/web/react-best-practices/rules/js-tosorted-immutable.md +57 -0
- package/skills/web/react-best-practices/rules/rendering-activity.md +26 -0
- package/skills/web/react-best-practices/rules/rendering-animate-svg-wrapper.md +47 -0
- package/skills/web/react-best-practices/rules/rendering-conditional-render.md +40 -0
- package/skills/web/react-best-practices/rules/rendering-content-visibility.md +38 -0
- package/skills/web/react-best-practices/rules/rendering-hoist-jsx.md +46 -0
- package/skills/web/react-best-practices/rules/rendering-hydration-no-flicker.md +82 -0
- package/skills/web/react-best-practices/rules/rendering-hydration-suppress-warning.md +30 -0
- package/skills/web/react-best-practices/rules/rendering-resource-hints.md +85 -0
- package/skills/web/react-best-practices/rules/rendering-script-defer-async.md +68 -0
- package/skills/web/react-best-practices/rules/rendering-svg-precision.md +28 -0
- package/skills/web/react-best-practices/rules/rendering-usetransition-loading.md +75 -0
- package/skills/web/react-best-practices/rules/rerender-defer-reads.md +39 -0
- package/skills/web/react-best-practices/rules/rerender-dependencies.md +45 -0
- package/skills/web/react-best-practices/rules/rerender-derived-state-no-effect.md +40 -0
- package/skills/web/react-best-practices/rules/rerender-derived-state.md +29 -0
- package/skills/web/react-best-practices/rules/rerender-functional-setstate.md +74 -0
- package/skills/web/react-best-practices/rules/rerender-lazy-state-init.md +58 -0
- package/skills/web/react-best-practices/rules/rerender-memo-with-default-value.md +38 -0
- package/skills/web/react-best-practices/rules/rerender-memo.md +44 -0
- package/skills/web/react-best-practices/rules/rerender-move-effect-to-event.md +45 -0
- package/skills/web/react-best-practices/rules/rerender-no-inline-components.md +82 -0
- package/skills/web/react-best-practices/rules/rerender-simple-expression-in-memo.md +35 -0
- package/skills/web/react-best-practices/rules/rerender-split-combined-hooks.md +64 -0
- package/skills/web/react-best-practices/rules/rerender-transitions.md +40 -0
- package/skills/web/react-best-practices/rules/rerender-use-deferred-value.md +59 -0
- package/skills/web/react-best-practices/rules/rerender-use-ref-transient-values.md +73 -0
- package/skills/web/react-best-practices/rules/server-after-nonblocking.md +73 -0
- package/skills/web/react-best-practices/rules/server-auth-actions.md +96 -0
- package/skills/web/react-best-practices/rules/server-cache-lru.md +41 -0
- package/skills/web/react-best-practices/rules/server-cache-react.md +76 -0
- package/skills/web/react-best-practices/rules/server-dedup-props.md +65 -0
- package/skills/web/react-best-practices/rules/server-hoist-static-io.md +149 -0
- package/skills/web/react-best-practices/rules/server-no-shared-module-state.md +50 -0
- package/skills/web/react-best-practices/rules/server-parallel-fetching.md +83 -0
- package/skills/web/react-best-practices/rules/server-parallel-nested-fetching.md +34 -0
- package/skills/web/react-best-practices/rules/server-serialization.md +38 -0
- package/skills/web/seo/SKILL.md +154 -0
- package/skills/web/web-design-guidelines/SKILL.md +39 -0
- package/skills/web/zap-scan-config/SKILL.md +444 -0
- package/skills/web/zap-scan-config/assets/.gitkeep +9 -0
- package/skills/web/zap-scan-config/assets/github_action.yml +207 -0
- package/skills/web/zap-scan-config/assets/gitlab_ci.yml +226 -0
- package/skills/web/zap-scan-config/assets/zap_automation.yaml +196 -0
- package/skills/web/zap-scan-config/assets/zap_context.xml +192 -0
- package/skills/web/zap-scan-config/references/EXAMPLE.md +40 -0
- package/skills/web/zap-scan-config/references/api_testing_guide.md +475 -0
- package/skills/web/zap-scan-config/references/authentication_guide.md +431 -0
- package/skills/web/zap-scan-config/references/false_positive_handling.md +427 -0
- package/skills/web/zap-scan-config/references/owasp_mapping.md +255 -0
- package/src/graph/ids.ts +86 -0
- package/src/graph/index.ts +32 -0
- package/src/graph/parser/architecture.ts +603 -0
- package/src/graph/parser/component-manifest.ts +268 -0
- package/src/graph/parser/decisions-jsonl.ts +407 -0
- package/src/graph/parser/design-md-pass2.ts +253 -0
- package/src/graph/parser/design-md.ts +477 -0
- package/src/graph/parser/page-spec.ts +496 -0
- package/src/graph/parser/product-spec.ts +930 -0
- package/src/graph/parser/screenshot.ts +342 -0
- package/src/graph/parser/sprint-tasks.ts +317 -0
- package/src/graph/storage/index.ts +1154 -0
- package/src/graph/types.ts +432 -0
- package/src/graph/util/dhash.ts +84 -0
- package/src/lrr/aggregator.ts +175 -0
- package/src/orchestrator/hooks/context-header.ts +119 -0
- package/src/orchestrator/hooks/token-accounting-emitter.ts +77 -0
- package/src/orchestrator/hooks/token-accounting.ts +112 -0
- package/src/orchestrator/mcp/cycle-counter.ts +130 -0
- package/src/orchestrator/mcp/scribe.ts +294 -0
- package/src/orchestrator/mcp/state-save.ts +149 -0
- package/src/orchestrator/mcp/write-lease.ts +184 -0
- package/src/orchestrator/phase4-shared-context.ts +57 -0
- package/src/orchestrator/schemas/backward-edge.ts +46 -0
- package/agents/agentic-identity-trust.md +0 -121
- package/agents/data-consolidation-agent.md +0 -39
- package/agents/design-image-prompt-engineer.md +0 -105
- package/agents/design-visual-storyteller.md +0 -147
- package/agents/design-whimsy-injector.md +0 -89
- package/agents/engineering-autonomous-optimization-architect.md +0 -105
- package/agents/market-intel.md +0 -35
- package/agents/marketing-instagram-curator.md +0 -111
- package/agents/marketing-reddit-community-builder.md +0 -121
- package/agents/marketing-social-media-strategist.md +0 -74
- package/agents/marketing-tiktok-strategist.md +0 -123
- package/agents/marketing-twitter-engager.md +0 -124
- package/agents/marketing-wechat-official-account.md +0 -143
- package/agents/marketing-xiaohongshu-specialist.md +0 -136
- package/agents/marketing-zhihu-strategist.md +0 -160
- package/agents/product-behavioral-nudge-engine.md +0 -78
- package/agents/project-management-experiment-tracker.md +0 -102
- package/agents/report-distribution-agent.md +0 -43
- package/agents/risk-analysis.md +0 -45
- package/agents/sales-data-extraction-agent.md +0 -46
- package/agents/specialized-cultural-intelligence-strategist.md +0 -65
- package/agents/specialized-developer-advocate.md +0 -146
- package/agents/support-analytics-reporter.md +0 -133
- package/agents/support-executive-summary-generator.md +0 -64
- package/agents/support-finance-tracker.md +0 -145
- package/agents/support-legal-compliance-checker.md +0 -129
- package/agents/support-support-responder.md +0 -91
- package/agents/testing-accessibility-auditor.md +0 -110
- package/agents/testing-test-results-analyzer.md +0 -97
- package/agents/testing-tool-evaluator.md +0 -76
- package/agents/testing-workflow-optimizer.md +0 -99
- package/agents/user-research.md +0 -40
- package/protocols/brainstorm.md +0 -99
- package/protocols/design.md +0 -269
- package/protocols/planning.md +0 -87
- package/skills/ios/ios-hig/SKILL.md +0 -41
- package/skills/ios/ios-hig/references/accessibility.md +0 -81
- package/skills/ios/ios-hig/references/content.md +0 -142
- package/skills/ios/ios-hig/references/feedback.md +0 -123
- package/skills/ios/ios-hig/references/interaction.md +0 -199
- package/skills/ios/ios-hig/references/performance-platform.md +0 -129
- package/skills/ios/ios-hig/references/privacy-permissions.md +0 -181
- package/skills/ios/ios-hig/references/visual-design.md +0 -84
|
@@ -0,0 +1,143 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: swift-actor-persistence
|
|
3
|
+
description: Thread-safe data persistence in Swift using actors — in-memory cache with file-backed storage, eliminating data races by design.
|
|
4
|
+
origin: ECC
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Swift Actors for Thread-Safe Persistence
|
|
8
|
+
|
|
9
|
+
Patterns for building thread-safe data persistence layers using Swift actors. Combines in-memory caching with file-backed storage, leveraging the actor model to eliminate data races at compile time.
|
|
10
|
+
|
|
11
|
+
## When to Activate
|
|
12
|
+
|
|
13
|
+
- Building a data persistence layer in Swift 5.5+
|
|
14
|
+
- Need thread-safe access to shared mutable state
|
|
15
|
+
- Want to eliminate manual synchronization (locks, DispatchQueues)
|
|
16
|
+
- Building offline-first apps with local storage
|
|
17
|
+
|
|
18
|
+
## Core Pattern
|
|
19
|
+
|
|
20
|
+
### Actor-Based Repository
|
|
21
|
+
|
|
22
|
+
The actor model guarantees serialized access — no data races, enforced by the compiler.
|
|
23
|
+
|
|
24
|
+
```swift
|
|
25
|
+
public actor LocalRepository<T: Codable & Identifiable> where T.ID == String {
|
|
26
|
+
private var cache: [String: T] = [:]
|
|
27
|
+
private let fileURL: URL
|
|
28
|
+
|
|
29
|
+
public init(directory: URL = .documentsDirectory, filename: String = "data.json") {
|
|
30
|
+
self.fileURL = directory.appendingPathComponent(filename)
|
|
31
|
+
// Synchronous load during init (actor isolation not yet active)
|
|
32
|
+
self.cache = Self.loadSynchronously(from: fileURL)
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
// MARK: - Public API
|
|
36
|
+
|
|
37
|
+
public func save(_ item: T) throws {
|
|
38
|
+
cache[item.id] = item
|
|
39
|
+
try persistToFile()
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
public func delete(_ id: String) throws {
|
|
43
|
+
cache[id] = nil
|
|
44
|
+
try persistToFile()
|
|
45
|
+
}
|
|
46
|
+
|
|
47
|
+
public func find(by id: String) -> T? {
|
|
48
|
+
cache[id]
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
public func loadAll() -> [T] {
|
|
52
|
+
Array(cache.values)
|
|
53
|
+
}
|
|
54
|
+
|
|
55
|
+
// MARK: - Private
|
|
56
|
+
|
|
57
|
+
private func persistToFile() throws {
|
|
58
|
+
let data = try JSONEncoder().encode(Array(cache.values))
|
|
59
|
+
try data.write(to: fileURL, options: .atomic)
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
private static func loadSynchronously(from url: URL) -> [String: T] {
|
|
63
|
+
guard let data = try? Data(contentsOf: url),
|
|
64
|
+
let items = try? JSONDecoder().decode([T].self, from: data) else {
|
|
65
|
+
return [:]
|
|
66
|
+
}
|
|
67
|
+
return Dictionary(uniqueKeysWithValues: items.map { ($0.id, $0) })
|
|
68
|
+
}
|
|
69
|
+
}
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
### Usage
|
|
73
|
+
|
|
74
|
+
All calls are automatically async due to actor isolation:
|
|
75
|
+
|
|
76
|
+
```swift
|
|
77
|
+
let repository = LocalRepository<Question>()
|
|
78
|
+
|
|
79
|
+
// Read — fast O(1) lookup from in-memory cache
|
|
80
|
+
let question = await repository.find(by: "q-001")
|
|
81
|
+
let allQuestions = await repository.loadAll()
|
|
82
|
+
|
|
83
|
+
// Write — updates cache and persists to file atomically
|
|
84
|
+
try await repository.save(newQuestion)
|
|
85
|
+
try await repository.delete("q-001")
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
### Combining with @Observable ViewModel
|
|
89
|
+
|
|
90
|
+
```swift
|
|
91
|
+
@Observable
|
|
92
|
+
final class QuestionListViewModel {
|
|
93
|
+
private(set) var questions: [Question] = []
|
|
94
|
+
private let repository: LocalRepository<Question>
|
|
95
|
+
|
|
96
|
+
init(repository: LocalRepository<Question> = LocalRepository()) {
|
|
97
|
+
self.repository = repository
|
|
98
|
+
}
|
|
99
|
+
|
|
100
|
+
func load() async {
|
|
101
|
+
questions = await repository.loadAll()
|
|
102
|
+
}
|
|
103
|
+
|
|
104
|
+
func add(_ question: Question) async throws {
|
|
105
|
+
try await repository.save(question)
|
|
106
|
+
questions = await repository.loadAll()
|
|
107
|
+
}
|
|
108
|
+
}
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
## Key Design Decisions
|
|
112
|
+
|
|
113
|
+
| Decision | Rationale |
|
|
114
|
+
|----------|-----------|
|
|
115
|
+
| Actor (not class + lock) | Compiler-enforced thread safety, no manual synchronization |
|
|
116
|
+
| In-memory cache + file persistence | Fast reads from cache, durable writes to disk |
|
|
117
|
+
| Synchronous init loading | Avoids async initialization complexity |
|
|
118
|
+
| Dictionary keyed by ID | O(1) lookups by identifier |
|
|
119
|
+
| Generic over `Codable & Identifiable` | Reusable across any model type |
|
|
120
|
+
| Atomic file writes (`.atomic`) | Prevents partial writes on crash |
|
|
121
|
+
|
|
122
|
+
## Best Practices
|
|
123
|
+
|
|
124
|
+
- **Use `Sendable` types** for all data crossing actor boundaries
|
|
125
|
+
- **Keep the actor's public API minimal** — only expose domain operations, not persistence details
|
|
126
|
+
- **Use `.atomic` writes** to prevent data corruption if the app crashes mid-write
|
|
127
|
+
- **Load synchronously in `init`** — async initializers add complexity with minimal benefit for local files
|
|
128
|
+
- **Combine with `@Observable`** ViewModels for reactive UI updates
|
|
129
|
+
|
|
130
|
+
## Anti-Patterns to Avoid
|
|
131
|
+
|
|
132
|
+
- Using `DispatchQueue` or `NSLock` instead of actors for new Swift concurrency code
|
|
133
|
+
- Exposing the internal cache dictionary to external callers
|
|
134
|
+
- Making the file URL configurable without validation
|
|
135
|
+
- Forgetting that all actor method calls are `await` — callers must handle async context
|
|
136
|
+
- Using `nonisolated` to bypass actor isolation (defeats the purpose)
|
|
137
|
+
|
|
138
|
+
## When to Use
|
|
139
|
+
|
|
140
|
+
- Local data storage in iOS/macOS apps (user data, settings, cached content)
|
|
141
|
+
- Offline-first architectures that sync to a server later
|
|
142
|
+
- Any shared mutable state that multiple parts of the app access concurrently
|
|
143
|
+
- Replacing legacy `DispatchQueue`-based thread safety with modern Swift concurrency
|
|
@@ -0,0 +1,216 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: swift-concurrency-6-2
|
|
3
|
+
description: Swift 6.2 Approachable Concurrency — single-threaded by default, @concurrent for explicit background offloading, isolated conformances for main actor types.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Swift 6.2 Approachable Concurrency
|
|
7
|
+
|
|
8
|
+
Patterns for adopting Swift 6.2's concurrency model where code runs single-threaded by default and concurrency is introduced explicitly. Eliminates common data-race errors without sacrificing performance.
|
|
9
|
+
|
|
10
|
+
## When to Activate
|
|
11
|
+
|
|
12
|
+
- Migrating Swift 5.x or 6.0/6.1 projects to Swift 6.2
|
|
13
|
+
- Resolving data-race safety compiler errors
|
|
14
|
+
- Designing MainActor-based app architecture
|
|
15
|
+
- Offloading CPU-intensive work to background threads
|
|
16
|
+
- Implementing protocol conformances on MainActor-isolated types
|
|
17
|
+
- Enabling Approachable Concurrency build settings in Xcode 26
|
|
18
|
+
|
|
19
|
+
## Core Problem: Implicit Background Offloading
|
|
20
|
+
|
|
21
|
+
In Swift 6.1 and earlier, async functions could be implicitly offloaded to background threads, causing data-race errors even in seemingly safe code:
|
|
22
|
+
|
|
23
|
+
```swift
|
|
24
|
+
// Swift 6.1: ERROR
|
|
25
|
+
@MainActor
|
|
26
|
+
final class StickerModel {
|
|
27
|
+
let photoProcessor = PhotoProcessor()
|
|
28
|
+
|
|
29
|
+
func extractSticker(_ item: PhotosPickerItem) async throws -> Sticker? {
|
|
30
|
+
guard let data = try await item.loadTransferable(type: Data.self) else { return nil }
|
|
31
|
+
|
|
32
|
+
// Error: Sending 'self.photoProcessor' risks causing data races
|
|
33
|
+
return await photoProcessor.extractSticker(data: data, with: item.itemIdentifier)
|
|
34
|
+
}
|
|
35
|
+
}
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
Swift 6.2 fixes this: async functions stay on the calling actor by default.
|
|
39
|
+
|
|
40
|
+
```swift
|
|
41
|
+
// Swift 6.2: OK — async stays on MainActor, no data race
|
|
42
|
+
@MainActor
|
|
43
|
+
final class StickerModel {
|
|
44
|
+
let photoProcessor = PhotoProcessor()
|
|
45
|
+
|
|
46
|
+
func extractSticker(_ item: PhotosPickerItem) async throws -> Sticker? {
|
|
47
|
+
guard let data = try await item.loadTransferable(type: Data.self) else { return nil }
|
|
48
|
+
return await photoProcessor.extractSticker(data: data, with: item.itemIdentifier)
|
|
49
|
+
}
|
|
50
|
+
}
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
## Core Pattern — Isolated Conformances
|
|
54
|
+
|
|
55
|
+
MainActor types can now conform to non-isolated protocols safely:
|
|
56
|
+
|
|
57
|
+
```swift
|
|
58
|
+
protocol Exportable {
|
|
59
|
+
func export()
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
// Swift 6.1: ERROR — crosses into main actor-isolated code
|
|
63
|
+
// Swift 6.2: OK with isolated conformance
|
|
64
|
+
extension StickerModel: @MainActor Exportable {
|
|
65
|
+
func export() {
|
|
66
|
+
photoProcessor.exportAsPNG()
|
|
67
|
+
}
|
|
68
|
+
}
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
The compiler ensures the conformance is only used on the main actor:
|
|
72
|
+
|
|
73
|
+
```swift
|
|
74
|
+
// OK — ImageExporter is also @MainActor
|
|
75
|
+
@MainActor
|
|
76
|
+
struct ImageExporter {
|
|
77
|
+
var items: [any Exportable]
|
|
78
|
+
|
|
79
|
+
mutating func add(_ item: StickerModel) {
|
|
80
|
+
items.append(item) // Safe: same actor isolation
|
|
81
|
+
}
|
|
82
|
+
}
|
|
83
|
+
|
|
84
|
+
// ERROR — nonisolated context can't use MainActor conformance
|
|
85
|
+
nonisolated struct ImageExporter {
|
|
86
|
+
var items: [any Exportable]
|
|
87
|
+
|
|
88
|
+
mutating func add(_ item: StickerModel) {
|
|
89
|
+
items.append(item) // Error: Main actor-isolated conformance cannot be used here
|
|
90
|
+
}
|
|
91
|
+
}
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
## Core Pattern — Global and Static Variables
|
|
95
|
+
|
|
96
|
+
Protect global/static state with MainActor:
|
|
97
|
+
|
|
98
|
+
```swift
|
|
99
|
+
// Swift 6.1: ERROR — non-Sendable type may have shared mutable state
|
|
100
|
+
final class StickerLibrary {
|
|
101
|
+
static let shared: StickerLibrary = .init() // Error
|
|
102
|
+
}
|
|
103
|
+
|
|
104
|
+
// Fix: Annotate with @MainActor
|
|
105
|
+
@MainActor
|
|
106
|
+
final class StickerLibrary {
|
|
107
|
+
static let shared: StickerLibrary = .init() // OK
|
|
108
|
+
}
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
### MainActor Default Inference Mode
|
|
112
|
+
|
|
113
|
+
Swift 6.2 introduces a mode where MainActor is inferred by default — no manual annotations needed:
|
|
114
|
+
|
|
115
|
+
```swift
|
|
116
|
+
// With MainActor default inference enabled:
|
|
117
|
+
final class StickerLibrary {
|
|
118
|
+
static let shared: StickerLibrary = .init() // Implicitly @MainActor
|
|
119
|
+
}
|
|
120
|
+
|
|
121
|
+
final class StickerModel {
|
|
122
|
+
let photoProcessor: PhotoProcessor
|
|
123
|
+
var selection: [PhotosPickerItem] // Implicitly @MainActor
|
|
124
|
+
}
|
|
125
|
+
|
|
126
|
+
extension StickerModel: Exportable { // Implicitly @MainActor conformance
|
|
127
|
+
func export() {
|
|
128
|
+
photoProcessor.exportAsPNG()
|
|
129
|
+
}
|
|
130
|
+
}
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
This mode is opt-in and recommended for apps, scripts, and other executable targets.
|
|
134
|
+
|
|
135
|
+
## Core Pattern — @concurrent for Background Work
|
|
136
|
+
|
|
137
|
+
When you need actual parallelism, explicitly offload with `@concurrent`:
|
|
138
|
+
|
|
139
|
+
> **Important:** This example requires Approachable Concurrency build settings — SE-0466 (MainActor default isolation) and SE-0461 (NonisolatedNonsendingByDefault). With these enabled, `extractSticker` stays on the caller's actor, making mutable state access safe. **Without these settings, this code has a data race** — the compiler will flag it.
|
|
140
|
+
|
|
141
|
+
```swift
|
|
142
|
+
nonisolated final class PhotoProcessor {
|
|
143
|
+
private var cachedStickers: [String: Sticker] = [:]
|
|
144
|
+
|
|
145
|
+
func extractSticker(data: Data, with id: String) async -> Sticker {
|
|
146
|
+
if let sticker = cachedStickers[id] {
|
|
147
|
+
return sticker
|
|
148
|
+
}
|
|
149
|
+
|
|
150
|
+
let sticker = await Self.extractSubject(from: data)
|
|
151
|
+
cachedStickers[id] = sticker
|
|
152
|
+
return sticker
|
|
153
|
+
}
|
|
154
|
+
|
|
155
|
+
// Offload expensive work to concurrent thread pool
|
|
156
|
+
@concurrent
|
|
157
|
+
static func extractSubject(from data: Data) async -> Sticker { /* ... */ }
|
|
158
|
+
}
|
|
159
|
+
|
|
160
|
+
// Callers must await
|
|
161
|
+
let processor = PhotoProcessor()
|
|
162
|
+
processedPhotos[item.id] = await processor.extractSticker(data: data, with: item.id)
|
|
163
|
+
```
|
|
164
|
+
|
|
165
|
+
To use `@concurrent`:
|
|
166
|
+
1. Mark the containing type as `nonisolated`
|
|
167
|
+
2. Add `@concurrent` to the function
|
|
168
|
+
3. Add `async` if not already asynchronous
|
|
169
|
+
4. Add `await` at call sites
|
|
170
|
+
|
|
171
|
+
## Key Design Decisions
|
|
172
|
+
|
|
173
|
+
| Decision | Rationale |
|
|
174
|
+
|----------|-----------|
|
|
175
|
+
| Single-threaded by default | Most natural code is data-race free; concurrency is opt-in |
|
|
176
|
+
| Async stays on calling actor | Eliminates implicit offloading that caused data-race errors |
|
|
177
|
+
| Isolated conformances | MainActor types can conform to protocols without unsafe workarounds |
|
|
178
|
+
| `@concurrent` explicit opt-in | Background execution is a deliberate performance choice, not accidental |
|
|
179
|
+
| MainActor default inference | Reduces boilerplate `@MainActor` annotations for app targets |
|
|
180
|
+
| Opt-in adoption | Non-breaking migration path — enable features incrementally |
|
|
181
|
+
|
|
182
|
+
## Migration Steps
|
|
183
|
+
|
|
184
|
+
1. **Enable in Xcode**: Swift Compiler > Concurrency section in Build Settings
|
|
185
|
+
2. **Enable in SPM**: Use `SwiftSettings` API in package manifest
|
|
186
|
+
3. **Use migration tooling**: Automatic code changes via swift.org/migration
|
|
187
|
+
4. **Start with MainActor defaults**: Enable inference mode for app targets
|
|
188
|
+
5. **Add `@concurrent` where needed**: Profile first, then offload hot paths
|
|
189
|
+
6. **Test thoroughly**: Data-race issues become compile-time errors
|
|
190
|
+
|
|
191
|
+
## Best Practices
|
|
192
|
+
|
|
193
|
+
- **Start on MainActor** — write single-threaded code first, optimize later
|
|
194
|
+
- **Use `@concurrent` only for CPU-intensive work** — image processing, compression, complex computation
|
|
195
|
+
- **Enable MainActor inference mode** for app targets that are mostly single-threaded
|
|
196
|
+
- **Profile before offloading** — use Instruments to find actual bottlenecks
|
|
197
|
+
- **Protect globals with MainActor** — global/static mutable state needs actor isolation
|
|
198
|
+
- **Use isolated conformances** instead of `nonisolated` workarounds or `@Sendable` wrappers
|
|
199
|
+
- **Migrate incrementally** — enable features one at a time in build settings
|
|
200
|
+
|
|
201
|
+
## Anti-Patterns to Avoid
|
|
202
|
+
|
|
203
|
+
- Applying `@concurrent` to every async function (most don't need background execution)
|
|
204
|
+
- Using `nonisolated` to suppress compiler errors without understanding isolation
|
|
205
|
+
- Keeping legacy `DispatchQueue` patterns when actors provide the same safety
|
|
206
|
+
- Skipping `model.availability` checks in concurrency-related Foundation Models code
|
|
207
|
+
- Fighting the compiler — if it reports a data race, the code has a real concurrency issue
|
|
208
|
+
- Assuming all async code runs in the background (Swift 6.2 default: stays on calling actor)
|
|
209
|
+
|
|
210
|
+
## When to Use
|
|
211
|
+
|
|
212
|
+
- All new Swift 6.2+ projects (Approachable Concurrency is the recommended default)
|
|
213
|
+
- Migrating existing apps from Swift 5.x or 6.0/6.1 concurrency
|
|
214
|
+
- Resolving data-race safety compiler errors during Xcode 26 adoption
|
|
215
|
+
- Building MainActor-centric app architectures (most UI apps)
|
|
216
|
+
- Performance optimization — offloading specific heavy computations to background
|
|
@@ -0,0 +1,190 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: swift-protocol-di-testing
|
|
3
|
+
description: Protocol-based dependency injection for testable Swift code — mock file system, network, and external APIs using focused protocols and Swift Testing.
|
|
4
|
+
origin: ECC
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Swift Protocol-Based Dependency Injection for Testing
|
|
8
|
+
|
|
9
|
+
Patterns for making Swift code testable by abstracting external dependencies (file system, network, iCloud) behind small, focused protocols. Enables deterministic tests without I/O.
|
|
10
|
+
|
|
11
|
+
## When to Activate
|
|
12
|
+
|
|
13
|
+
- Writing Swift code that accesses file system, network, or external APIs
|
|
14
|
+
- Need to test error handling paths without triggering real failures
|
|
15
|
+
- Building modules that work across environments (app, test, SwiftUI preview)
|
|
16
|
+
- Designing testable architecture with Swift concurrency (actors, Sendable)
|
|
17
|
+
|
|
18
|
+
## Core Pattern
|
|
19
|
+
|
|
20
|
+
### 1. Define Small, Focused Protocols
|
|
21
|
+
|
|
22
|
+
Each protocol handles exactly one external concern.
|
|
23
|
+
|
|
24
|
+
```swift
|
|
25
|
+
// File system access
|
|
26
|
+
public protocol FileSystemProviding: Sendable {
|
|
27
|
+
func containerURL(for purpose: Purpose) -> URL?
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
// File read/write operations
|
|
31
|
+
public protocol FileAccessorProviding: Sendable {
|
|
32
|
+
func read(from url: URL) throws -> Data
|
|
33
|
+
func write(_ data: Data, to url: URL) throws
|
|
34
|
+
func fileExists(at url: URL) -> Bool
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
// Bookmark storage (e.g., for sandboxed apps)
|
|
38
|
+
public protocol BookmarkStorageProviding: Sendable {
|
|
39
|
+
func saveBookmark(_ data: Data, for key: String) throws
|
|
40
|
+
func loadBookmark(for key: String) throws -> Data?
|
|
41
|
+
}
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
### 2. Create Default (Production) Implementations
|
|
45
|
+
|
|
46
|
+
```swift
|
|
47
|
+
public struct DefaultFileSystemProvider: FileSystemProviding {
|
|
48
|
+
public init() {}
|
|
49
|
+
|
|
50
|
+
public func containerURL(for purpose: Purpose) -> URL? {
|
|
51
|
+
FileManager.default.url(forUbiquityContainerIdentifier: nil)
|
|
52
|
+
}
|
|
53
|
+
}
|
|
54
|
+
|
|
55
|
+
public struct DefaultFileAccessor: FileAccessorProviding {
|
|
56
|
+
public init() {}
|
|
57
|
+
|
|
58
|
+
public func read(from url: URL) throws -> Data {
|
|
59
|
+
try Data(contentsOf: url)
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
public func write(_ data: Data, to url: URL) throws {
|
|
63
|
+
try data.write(to: url, options: .atomic)
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
public func fileExists(at url: URL) -> Bool {
|
|
67
|
+
FileManager.default.fileExists(atPath: url.path)
|
|
68
|
+
}
|
|
69
|
+
}
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
### 3. Create Mock Implementations for Testing
|
|
73
|
+
|
|
74
|
+
```swift
|
|
75
|
+
public final class MockFileAccessor: FileAccessorProviding, @unchecked Sendable {
|
|
76
|
+
public var files: [URL: Data] = [:]
|
|
77
|
+
public var readError: Error?
|
|
78
|
+
public var writeError: Error?
|
|
79
|
+
|
|
80
|
+
public init() {}
|
|
81
|
+
|
|
82
|
+
public func read(from url: URL) throws -> Data {
|
|
83
|
+
if let error = readError { throw error }
|
|
84
|
+
guard let data = files[url] else {
|
|
85
|
+
throw CocoaError(.fileReadNoSuchFile)
|
|
86
|
+
}
|
|
87
|
+
return data
|
|
88
|
+
}
|
|
89
|
+
|
|
90
|
+
public func write(_ data: Data, to url: URL) throws {
|
|
91
|
+
if let error = writeError { throw error }
|
|
92
|
+
files[url] = data
|
|
93
|
+
}
|
|
94
|
+
|
|
95
|
+
public func fileExists(at url: URL) -> Bool {
|
|
96
|
+
files[url] != nil
|
|
97
|
+
}
|
|
98
|
+
}
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
### 4. Inject Dependencies with Default Parameters
|
|
102
|
+
|
|
103
|
+
Production code uses defaults; tests inject mocks.
|
|
104
|
+
|
|
105
|
+
```swift
|
|
106
|
+
public actor SyncManager {
|
|
107
|
+
private let fileSystem: FileSystemProviding
|
|
108
|
+
private let fileAccessor: FileAccessorProviding
|
|
109
|
+
|
|
110
|
+
public init(
|
|
111
|
+
fileSystem: FileSystemProviding = DefaultFileSystemProvider(),
|
|
112
|
+
fileAccessor: FileAccessorProviding = DefaultFileAccessor()
|
|
113
|
+
) {
|
|
114
|
+
self.fileSystem = fileSystem
|
|
115
|
+
self.fileAccessor = fileAccessor
|
|
116
|
+
}
|
|
117
|
+
|
|
118
|
+
public func sync() async throws {
|
|
119
|
+
guard let containerURL = fileSystem.containerURL(for: .sync) else {
|
|
120
|
+
throw SyncError.containerNotAvailable
|
|
121
|
+
}
|
|
122
|
+
let data = try fileAccessor.read(
|
|
123
|
+
from: containerURL.appendingPathComponent("data.json")
|
|
124
|
+
)
|
|
125
|
+
// Process data...
|
|
126
|
+
}
|
|
127
|
+
}
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
### 5. Write Tests with Swift Testing
|
|
131
|
+
|
|
132
|
+
```swift
|
|
133
|
+
import Testing
|
|
134
|
+
|
|
135
|
+
@Test("Sync manager handles missing container")
|
|
136
|
+
func testMissingContainer() async {
|
|
137
|
+
let mockFileSystem = MockFileSystemProvider(containerURL: nil)
|
|
138
|
+
let manager = SyncManager(fileSystem: mockFileSystem)
|
|
139
|
+
|
|
140
|
+
await #expect(throws: SyncError.containerNotAvailable) {
|
|
141
|
+
try await manager.sync()
|
|
142
|
+
}
|
|
143
|
+
}
|
|
144
|
+
|
|
145
|
+
@Test("Sync manager reads data correctly")
|
|
146
|
+
func testReadData() async throws {
|
|
147
|
+
let mockFileAccessor = MockFileAccessor()
|
|
148
|
+
mockFileAccessor.files[testURL] = testData
|
|
149
|
+
|
|
150
|
+
let manager = SyncManager(fileAccessor: mockFileAccessor)
|
|
151
|
+
let result = try await manager.loadData()
|
|
152
|
+
|
|
153
|
+
#expect(result == expectedData)
|
|
154
|
+
}
|
|
155
|
+
|
|
156
|
+
@Test("Sync manager handles read errors gracefully")
|
|
157
|
+
func testReadError() async {
|
|
158
|
+
let mockFileAccessor = MockFileAccessor()
|
|
159
|
+
mockFileAccessor.readError = CocoaError(.fileReadCorruptFile)
|
|
160
|
+
|
|
161
|
+
let manager = SyncManager(fileAccessor: mockFileAccessor)
|
|
162
|
+
|
|
163
|
+
await #expect(throws: SyncError.self) {
|
|
164
|
+
try await manager.sync()
|
|
165
|
+
}
|
|
166
|
+
}
|
|
167
|
+
```
|
|
168
|
+
|
|
169
|
+
## Best Practices
|
|
170
|
+
|
|
171
|
+
- **Single Responsibility**: Each protocol should handle one concern — don't create "god protocols" with many methods
|
|
172
|
+
- **Sendable conformance**: Required when protocols are used across actor boundaries
|
|
173
|
+
- **Default parameters**: Let production code use real implementations by default; only tests need to specify mocks
|
|
174
|
+
- **Error simulation**: Design mocks with configurable error properties for testing failure paths
|
|
175
|
+
- **Only mock boundaries**: Mock external dependencies (file system, network, APIs), not internal types
|
|
176
|
+
|
|
177
|
+
## Anti-Patterns to Avoid
|
|
178
|
+
|
|
179
|
+
- Creating a single large protocol that covers all external access
|
|
180
|
+
- Mocking internal types that have no external dependencies
|
|
181
|
+
- Using `#if DEBUG` conditionals instead of proper dependency injection
|
|
182
|
+
- Forgetting `Sendable` conformance when used with actors
|
|
183
|
+
- Over-engineering: if a type has no external dependencies, it doesn't need a protocol
|
|
184
|
+
|
|
185
|
+
## When to Use
|
|
186
|
+
|
|
187
|
+
- Any Swift code that touches file system, network, or external APIs
|
|
188
|
+
- Testing error handling paths that are hard to trigger in real environments
|
|
189
|
+
- Building modules that need to work in app, test, and SwiftUI preview contexts
|
|
190
|
+
- Apps using Swift concurrency (actors, structured concurrency) that need testable architecture
|