xushili
5cea5c6284
first
|
3 bulan lalu | |
|---|---|---|
| .. | ||
| src | 3 bulan lalu | |
| test | 3 bulan lalu | |
| types | 3 bulan lalu | |
| README.erb | 3 bulan lalu | |
| babel.config.erb | 3 bulan lalu | |
| gitignore.erb | 3 bulan lalu | |
| jest.config.erb | 3 bulan lalu | |
| package-lock.erb | 3 bulan lalu | |
| package.erb | 3 bulan lalu | |
| tsconfig.json | 3 bulan lalu | |
README.erb
# <%= packageName %>
This is the <%= description %> Superset Chart Plugin.
### Usage
To build the plugin, run the following commands:
```
npm ci
npm run build
```
Alternatively, to run the plugin in development mode (=rebuilding whenever changes are made), start the dev server with the following command:
```
npm run dev
```
To add the package to Superset, go to the `superset-frontend` subdirectory in your Superset source folder (assuming both the `<%= packageName %>` plugin and `superset` repos are in the same root directory) and run
```
npm i -S ../../<%= packageName %>
```
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
import { <%= packageLabel %> } from '<%= packageName %>';
```
to import the plugin and later add the following to the array that's passed to the `plugins` property:
```js
new <%= packageLabel %>().configure({ key: '<%= packageName %>' }),
```
After that the plugin should show up when you run Superset, e.g. the development server:
```
npm run dev-server
```
This is the <%= description %> Superset Chart Plugin.
### Usage
To build the plugin, run the following commands:
```
npm ci
npm run build
```
Alternatively, to run the plugin in development mode (=rebuilding whenever changes are made), start the dev server with the following command:
```
npm run dev
```
To add the package to Superset, go to the `superset-frontend` subdirectory in your Superset source folder (assuming both the `<%= packageName %>` plugin and `superset` repos are in the same root directory) and run
```
npm i -S ../../<%= packageName %>
```
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
import { <%= packageLabel %> } from '<%= packageName %>';
```
to import the plugin and later add the following to the array that's passed to the `plugins` property:
```js
new <%= packageLabel %>().configure({ key: '<%= packageName %>' }),
```
After that the plugin should show up when you run Superset, e.g. the development server:
```
npm run dev-server
```