docs: require file-local SwiftUI previews#113
Merged
Conversation
gaelic-ghost
added
the
documentation
ChatGPT Codex Connector
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: ⛔ Files ignored due to path filters (8)
📒 Files selected for processing (65)
📝 WalkthroughWalkthroughThis PR bumps the version from 8.5.3 to 8.5.4 across all plugin manifest JSON files and pyproject.toml files in the repository. Additionally, it adds SwiftUI file-structure guidance (one View component per file, colocated preview, no grouping) across many apple-dev-skills documentation snippets and workflows, with corresponding test updates. ChangesVersion Bump
SwiftUI One-View-Per-File Guidance
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related PRs
Suggested labels: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 2c856b0b9f
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
|
||
| ## SwiftUI View File Rule | ||
|
|
||
| Each SwiftUI `View` component must live in its own Swift file named for that view, and that file must carry the view's own Xcode SwiftUI preview. Do not group multiple `View` component types in one file, even when the views are small, related, nested, or currently used only by one parent. Split them into separate files so Xcode previews remain discoverable, isolated, and reliable. |
There was a problem hiding this comment.
This adds a shipped SwiftUI workflow rule, but the patch does not update ROADMAP.md; AGENTS.md:61 requires shipped behavior changes to update the relevant docs and ROADMAP.md in the same pass. Without that roadmap note, maintainers following the release/roadmap history will miss that 8.5.4 changed SwiftUI file-layout guidance, leaving the shipped skill contract and tracked roadmap out of sync.
Useful? React with 👍 / 👎.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Viewcomponent to live in its own file with its own Xcode SwiftUI preview.8.5.4for the patch release.Verification
uv run pytest plugins/apple-dev-skills/tests/test_swiftui_app_architecture_workflow.py plugins/apple-dev-skills/tests/test_structure_swift_sources_workflow.py plugins/apple-dev-skills/tests/test_xcode_guidance_sync_workflow.pyplugins/apple-dev-skills/.github/scripts/sync_shared_snippets.sh --checkuv run scripts/validate_socket_metadata.pyRelease
subtreesplugins/apple-dev-skills: no subtree action; Socket is the canonical payload and the standalone repo is only the compatibility pointer.Summary by CodeRabbit
Documentation
Tests
Chores