[superset] branch master updated: docs: Adds notes to Superset plugin generator about TypeScript errors (#23501)

[ta...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

tai pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/superset.git


The following commit(s) were added to refs/heads/master by this push:
     new a3ffc67238 docs: Adds notes to Superset plugin generator about TypeScript errors (#23501)
a3ffc67238 is described below

commit a3ffc67238c3216340071b98201511afea13bc96
Author: Alex Bain <12...@users.noreply.github.com>
AuthorDate: Mon Mar 27 18:34:26 2023 -0700

    docs: Adds notes to Superset plugin generator about TypeScript errors (#23501)
---
 .../generators/plugin-chart/templates/README.erb   | 25 ++++++++++++++++++++++
 1 file changed, 25 insertions(+)

diff --git a/superset-frontend/packages/generator-superset/generators/plugin-chart/templates/README.erb b/superset-frontend/packages/generator-superset/generators/plugin-chart/templates/README.erb
index 6a72fb3efe..adb55c9deb 100644
--- a/superset-frontend/packages/generator-superset/generators/plugin-chart/templates/README.erb
+++ b/superset-frontend/packages/generator-superset/generators/plugin-chart/templates/README.erb
@@ -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