From 87cab58edcd21e990c3fad8bf737f4712ede8f55 Mon Sep 17 00:00:00 2001
From: Alex Bain <alex_s_bain@apple.com>
Date: Thu, 23 Feb 2023 10:42:03 -0800
Subject: [PATCH] Adds notes to Superset plugin generator about TypeScript
 errors the user is likely to encounter.

---
 .../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 6a72fb3efec09..adb55c9deb9b3 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