michael-s-molina opened a new pull request, #38475:
URL: https://github.com/apache/superset/pull/38475
### SUMMARY
Cleans up the extensions API for consistency across all contribution types.
**1. Rename editors API functions to drop the "Provider" suffix**
The editors API mixed two naming conventions: `registerEditor` on the write
side, but `getEditorProvider` / `hasEditorProvider` / `getAllEditorProviders` /
`onDidRegisterEditorProvider` / `onDidUnregisterEditorProvider` on the read
side. This diverged from the commands and views APIs, which use the plain noun
consistently (`getCommand`, `getViews`, etc.).
All editor-related functions and event types are renamed to use "Editor":
| Before | After |
|---|---|
| `getEditorProvider(language)` | `getEditor(language)` |
| `hasEditorProvider(language)` | `hasEditor(language)` |
| `getAllEditorProviders()` | `getAllEditors()` |
| `onDidRegisterEditorProvider` | `onDidRegisterEditor` |
| `onDidUnregisterEditorProvider` | `onDidUnregisterEditor` |
| `EditorProviderRegisteredEvent` | `EditorRegisteredEvent` |
| `EditorProviderUnregisteredEvent` | `EditorUnregisteredEvent` |
`registerEditor` is unchanged — it was already consistent.
The `EditorRegisteredEvent` payload is also slimmed from `{ provider:
EditorProvider }` to `{ editor: Editor }`, matching the shape of
`EditorUnregisteredEvent`. The React component remains internal to
`EditorProviders` / `EditorHost` and is no longer exposed through the event.
**2. Add optional `description` to all contribution types**
`description` was present on `Command` (required) and `Editor` (optional)
but missing from `View` and `MenuItem`. This field is forward-looking for
manifest display. It is now optional and consistent across all four types:
- `Command.description?: string` (relaxed from required)
- `Editor.description?: string` (unchanged)
- `View.description?: string` (added)
- `MenuItem.description?: string` (added)
### TESTING INSTRUCTIONS
CI should be sufficient.
### ADDITIONAL INFORMATION
<!--- Check any relevant boxes with "x" -->
<!--- HINT: Include "Fixes #nnn" if you are fixing an existing issue -->
- [ ] Has associated issue:
- [ ] Required feature flags:
- [ ] Changes UI
- [ ] Includes DB Migration (follow approval process in
[SIP-59](https://github.com/apache/superset/issues/13351))
- [ ] Migration is atomic, supports rollback & is backwards-compatible
- [ ] Confirm DB migration upgrade and downgrade tested
- [ ] Runtime estimates and downtime expectations provided
- [ ] Introduces new feature or API
- [ ] Removes existing feature or API
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
