feat: update core integration documentation and remove unnecessary Ty… - #6
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the Announcements module’s core integration guidance by removing the need for a separate TypeScript patch and instead providing automatic Inertia PageProps typing via module augmentation.
Changes:
- Added
resources/js/types/page-props.d.tsto augment@inertiajs/vue3PagePropswithannouncement. - Removed the no-longer-needed
patches/types.patch. - Updated
CLAUDE.mdintegration documentation to reflect the single required core patch (app-vue.patch) and automatic TS typing.
Reviewed changes
Copilot reviewed 2 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| resources/js/types/page-props.d.ts | Adds Inertia PageProps module augmentation for the announcement prop. |
| patches/types.patch | Deletes the old patch that required manual core TS type edits. |
| CLAUDE.md | Updates integration instructions and gotchas to reflect the new approach. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
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.
This pull request updates the integration process for the Announcements module by simplifying the required core changes and improving the TypeScript type handling. Now, only one patch is needed, and TypeScript types are automatically managed, reducing manual steps and potential errors.
Core Integration Simplification:
app-vue.patchpatch is now required for integration; the previous need for a manual TypeScript types patch (types.patch) has been removed. Theannouncementtype is now handled automatically viapage-props.d.ts, which augments@inertiajs/vue3'sPageProps. [1] [2]Patch Removal:
patches/types.patchfile is deleted, as it is no longer necessary for type augmentation.