Improve types for builtin editor widget IDs #1462
Merged
+41
−4
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
widgetId
when changing editor interfaces. This PR introduces function overloading to theindex.d.ts
file to restrict this fromstring
to 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
widgetId
and would prefer a nicer developer experience. Copying these changes locally into our production application very clearly shows when there is an invalidwidgetId
for a builtin widget. Examples:This catches these errors before they happen (
number
is not a valid widgetId)Todos
Screenshots (if appropriate):