Skip to content

Latest commit

 

History

History
66 lines (45 loc) · 1.41 KB

debugging.md

File metadata and controls

66 lines (45 loc) · 1.41 KB

Debugging Superset plugins in Superset app

Activating plugins for local development

  1. Enable npm link for the package.
cd superset-ui
cd packages/superset-ui-chart
npm link
  1. Link the local package to incubator-superset.
cd incubator-superset/superset-frontend
npm link @superset-ui/chart \# use package name in package.json, not directory name
  1. After npm link complete, update the import statements in Superset.

Instead of

import { xxx } from '@superset-ui/plugin-chart-horizon';

which will point to the transpiled code.

do refer to src

import { xxx } from '@superset-ui/plugin-chart-horizon/src';
  1. After that you can run dev-server as usual.
npm run dev-server

Now when you change the code in @superset-ui, it will update the app immediately similar to code inside incubator-superset.

Deactivating plugins for local development

  1. Change the import statements back.

  2. Unlink the package from incubator-superset.

cd incubator-superset/superset-frontend
npm unlink @superset-ui/chart

Note: Quite often, npm link mess up your node_modules and the unlink command above does not work correctly, making webpack build fails or other unexpected behaviors. If that happens, just delete your node_modules and npm install from scratch.

  1. Clean up global link.
cd superset-ui
cd packages/superset-ui-chart
npm unlink