docs: Adds notes to Superset plugin generator about TypeScript errors #23501
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
When creating a new Superset plugin, the generator creates a
tsconfig.json
file. When trying to build Superset with this new plugin, the build fails due to TypeScript compilation errors.This PR extends the README documentation of a generated plugin to call out some of the changes a user may want to make to fix these TypeScript errors. These suggested changes already exist in the
echarts
plugins, and served as inspiration for how to fix the TypeScript errors I encountered in my own plugin.BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF
Screenshots of TypeScript errors after creating the plugin:
TESTING INSTRUCTIONS
superset-frontend/plugins/
directory alongside other pluginsMainPreset.js
andpackage.json
@superset-ui/core
)