Improve types for builtin editor widget IDs#1462
Merged
Lisa White (whitelisab) merged 1 commit intocontentful:mainfrom Jan 31, 2025
Merged
Improve types for builtin editor widget IDs#1462Lisa White (whitelisab) merged 1 commit intocontentful:mainfrom
Lisa White (whitelisab) merged 1 commit intocontentful:mainfrom
Conversation
Lisa White (whitelisab)
approved these changes
Jan 31, 2025
Contributor
Lisa White (whitelisab)
left a comment
Lisa White (whitelisab)
left a comment
There was a problem hiding this comment.
Thanks for the contribution Brad Turner (@nib-bturner)! This is a helpful DX improvement when working with the builtin widgetIds. Approving and merging! ⭐
|
🎉 This PR is included in version 4.28.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
David Daester (Swissbite)
added a commit
to Swissbite/contentful-migration
that referenced
this pull request
Feb 21, 2025
2 tasks
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
2 participants
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
Currently its pretty easy to mistype or put the wrong
widgetIdwhen changing editor interfaces. This PR introduces function overloading to theindex.d.tsfile to restrict this fromstringto the widget IDs listed in your website:https://www.contentful.com/developers/docs/extensibility/app-framework/editor-interfaces/.
Description
Motivation and Context
I'm sick of guessing the wrong
widgetIdand would prefer a nicer developer experience. Copying these changes locally into our production application very clearly shows when there is an invalidwidgetIdfor a builtin widget. Examples:This catches these errors before they happen (
numberis not a valid widgetId)Todos
Screenshots (if appropriate):