iop
/
superset
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: Adds notes to Superset plugin generator about TypeScript errors (#23501)

This commit is contained in:
Alex Bain 2023-03-27 18:34:26 -07:00 committed by GitHub
parent 21578f74b7
commit a3ffc67238
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 25 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
superset-frontend/packages/generator-superset/generators/plugin-chart/templates/README.erb
View File

@ -22,6 +22,31 @@ To add the package to Superset, go to the `superset-frontend` subdirectory in yo
npm i -S ../../<%= packageName %>
```
If your Superset plugin exists in the `superset-frontend` directory and you wish to resolve TypeScript errors about `@superset-ui/core` not being resolved correctly, add the following to your `tsconfig.json` file:
```
"references": [
{
"path": "../../packages/superset-ui-chart-controls"
},
{
"path": "../../packages/superset-ui-core"
}
]
```
You may also wish to add the following to the `include` array in `tsconfig.json` to make Superset types available to your plugin:
```
"../../types/**/*"
```
Finally, if you wish to ensure your plugin `tsconfig.json` is aligned with the root Superset project, you may add the following to your `tsconfig.json` file:
```
"extends": "../../tsconfig.json",
```
After this edit the `superset-frontend/src/visualizations/presets/MainPreset.js` and make the following changes:
```js