2019-02-22 20:30:35 -05:00
# @superset-ui/plugins 🔌💡
2019-01-23 15:31:45 -05:00
2019-02-22 20:30:35 -05:00
[](http://codecov.io/github/apache-superset/superset-ui-plugins/coverage.svg?branch=master)
[](https://travis-ci.com/apache-superset/superset-ui-plugins)
[](https://david-dm.org/apache-superset/superset-ui-plugins?type=dev)
2019-04-12 13:23:08 -04:00
[](https://app.netlify.com/sites/superset-ui-plugins/deploys)
2019-01-23 15:31:45 -05:00
2019-02-22 20:30:35 -05:00
`@superset-ui/legacy-*` packages are extracted from the classic [Apache Superset ](https://github.com/apache/incubator-superset ) and converted into plugins.
These packages are extracted with minimal changes (almost as-is). They also depend on legacy API (`viz.py`) to function.
`@superset-ui/plugin-*` packages are newer and has higher quality in general.
We are not accepting pull requests for new community-contributed plugins to be merged into this repository at the moment.
We will keep it lean for now to improve the standard and reduce operational load on maintenance.
Bug fixes are welcome.
In the future, we plan to have a template for new repository or generator for everybody to setup a single plugin repository easily on his/her own.
This way anybody can create and publish a Superset plugin.
2019-04-12 13:23:08 -04:00
## Demo (Storybook)
Most recent release: https://apache-superset.github.io/superset-ui-plugins/
Current master: https://superset-ui-plugins.netlify.com
2019-01-23 15:31:45 -05:00
## Packages
2019-04-23 17:04:07 -04:00
| Package | Version | Note |
|--|--|--|
| [@superset-ui/plugin-chart-word-cloud ](https://github.com/apache-superset/superset-ui/tree/master/packages/superset-ui-plugin-chart-word-cloud ) | [](https://img.shields.io/npm/v/@superset-ui/plugin-chart-word-cloud.svg?style=flat-square) | |
| [@superset-ui/preset-chart-xy ](https://github.com/apache-superset/superset-ui/tree/master/packages/superset-ui-preset-chart-xy ) | [](https://img.shields.io/npm/v/@superset-ui/preset-chart-xy.svg?style=flat-square) | experimental |
2019-02-22 21:04:38 -05:00
2019-01-23 15:31:45 -05:00
| Package | Version |
|--|--|
2019-02-22 20:30:35 -05:00
| [@superset-ui/legacy-preset-chart-big-number ](https://github.com/apache-superset/superset-ui-plugins/tree/master/packages/superset-ui-legacy-preset-chart-big-number ) | [](https://img.shields.io/npm/v/@superset-ui/legacy-preset-chart-big-number.svg?style=flat-square) |
2019-03-18 16:53:03 -04:00
| [@superset-ui/legacy-preset-chart-nvd3 ](https://github.com/apache-superset/superset-ui-plugins/tree/master/packages/superset-ui-legacy-preset-chart-nvd3 ) | [](https://img.shields.io/npm/v/@superset-ui/legacy-preset-chart-nvd3.svg?style=flat-square) |
2019-02-22 20:30:35 -05:00
| [@superset-ui/legacy-plugin-chart-calendar ](https://github.com/apache-superset/superset-ui-plugins/tree/master/packages/superset-ui-legacy-plugin-chart-calendar ) | [](https://img.shields.io/npm/v/@superset-ui/legacy-plugin-chart-calendar.svg?style=flat-square) |
| [@superset-ui/legacy-plugin-chart-chord ](https://github.com/apache-superset/superset-ui-plugins/tree/master/packages/superset-ui-legacy-plugin-chart-chord ) | [](https://img.shields.io/npm/v/@superset-ui/legacy-plugin-chart-chord.svg?style=flat-square) |
| [@superset-ui/legacy-plugin-chart-country-map ](https://github.com/apache-superset/superset-ui-plugins/tree/master/packages/superset-ui-legacy-plugin-chart-country-map ) | [](https://img.shields.io/npm/v/@superset-ui/legacy-plugin-chart-country-map.svg?style=flat-square) |
| [@superset-ui/legacy-plugin-chart-event-flow ](https://github.com/apache-superset/superset-ui-plugins/tree/master/packages/superset-ui-legacy-plugin-chart-event-flow ) | [](https://img.shields.io/npm/v/@superset-ui/legacy-plugin-chart-event-flow.svg?style=flat-square) |
| [@superset-ui/legacy-plugin-chart-force-directed ](https://github.com/apache-superset/superset-ui-plugins/tree/master/packages/superset-ui-legacy-plugin-chart-force-directed ) | [](https://img.shields.io/npm/v/@superset-ui/legacy-plugin-chart-force-directed.svg?style=flat-square) |
| [@superset-ui/legacy-plugin-chart-heatmap ](https://github.com/apache-superset/superset-ui-plugins/tree/master/packages/superset-ui-legacy-plugin-chart-heatmap ) | [](https://img.shields.io/npm/v/@superset-ui/legacy-plugin-chart-heatmap.svg?style=flat-square) |
| [@superset-ui/legacy-plugin-chart-histogram ](https://github.com/apache-superset/superset-ui-plugins/tree/master/packages/superset-ui-legacy-plugin-chart-histogram ) | [](https://img.shields.io/npm/v/@superset-ui/legacy-plugin-chart-histogram.svg?style=flat-square) |
| [@superset-ui/legacy-plugin-chart-horizon ](https://github.com/apache-superset/superset-ui-plugins/tree/master/packages/superset-ui-legacy-plugin-chart-horizon ) | [](https://img.shields.io/npm/v/@superset-ui/legacy-plugin-chart-horizon.svg?style=flat-square) |
| [@superset-ui/legacy-plugin-chart-iframe ](https://github.com/apache-superset/superset-ui-plugins/tree/master/packages/superset-ui-legacy-plugin-chart-iframe ) | [](https://img.shields.io/npm/v/@superset-ui/legacy-plugin-chart-iframe.svg?style=flat-square) |
| [@superset-ui/legacy-plugin-chart-markup ](https://github.com/apache-superset/superset-ui-plugins/tree/master/packages/superset-ui-legacy-plugin-chart-markup ) | [](https://img.shields.io/npm/v/@superset-ui/legacy-plugin-chart-markup.svg?style=flat-square) |
| [@superset-ui/legacy-plugin-chart-map-box ](https://github.com/apache-superset/superset-ui-plugins/tree/master/packages/superset-ui-legacy-plugin-chart-map-box ) | [](https://img.shields.io/npm/v/@superset-ui/legacy-plugin-chart-map-box.svg?style=flat-square) |
| [@superset-ui/legacy-plugin-chart-paired-t-test ](https://github.com/apache-superset/superset-ui-plugins/tree/master/packages/superset-ui-legacy-plugin-chart-paired-t-test ) | [](https://img.shields.io/npm/v/@superset-ui/legacy-plugin-chart-paired-t-test.svg?style=flat-square) |
| [@superset-ui/legacy-plugin-chart-parallel-coordinates ](https://github.com/apache-superset/superset-ui-plugins/tree/master/packages/superset-ui-legacy-plugin-chart-parallel-coordinates ) | [](https://img.shields.io/npm/v/@superset-ui/legacy-plugin-chart-parallel-coordinates.svg?style=flat-square) |
| [@superset-ui/legacy-plugin-chart-partition ](https://github.com/apache-superset/superset-ui-plugins/tree/master/packages/superset-ui-legacy-plugin-chart-partition ) | [](https://img.shields.io/npm/v/@superset-ui/legacy-plugin-chart-partition.svg?style=flat-square) |
| [@superset-ui/legacy-plugin-chart-pivot-table ](https://github.com/apache-superset/superset-ui-plugins/tree/master/packages/superset-ui-legacy-plugin-chart-pivot-table ) | [](https://img.shields.io/npm/v/@superset-ui/legacy-plugin-chart-pivot-table.svg?style=flat-square) |
| [@superset-ui/legacy-plugin-chart-rose ](https://github.com/apache-superset/superset-ui-plugins/tree/master/packages/superset-ui-legacy-plugin-chart-rose ) | [](https://img.shields.io/npm/v/@superset-ui/legacy-plugin-chart-rose.svg?style=flat-square) |
| [@superset-ui/legacy-plugin-chart-sankey ](https://github.com/apache-superset/superset-ui-plugins/tree/master/packages/superset-ui-legacy-plugin-chart-sankey ) | [](https://img.shields.io/npm/v/@superset-ui/legacy-plugin-chart-sankey.svg?style=flat-square) |
| [@superset-ui/legacy-plugin-chart-sunburst ](https://github.com/apache-superset/superset-ui-plugins/tree/master/packages/superset-ui-legacy-plugin-chart-sunburst ) | [](https://img.shields.io/npm/v/@superset-ui/legacy-plugin-chart-sunburst.svg?style=flat-square) |
| [@superset-ui/legacy-plugin-chart-table ](https://github.com/apache-superset/superset-ui-plugins/tree/master/packages/superset-ui-legacy-plugin-chart-table ) | [](https://img.shields.io/npm/v/@superset-ui/legacy-plugin-chart-table.svg?style=flat-square) |
| [@superset-ui/legacy-plugin-chart-treemap ](https://github.com/apache-superset/superset-ui-plugins/tree/master/packages/superset-ui-legacy-plugin-chart-treemap ) | [](https://img.shields.io/npm/v/@superset-ui/legacy-plugin-chart-treemap.svg?style=flat-square) |
| [@superset-ui/legacy-plugin-chart-word-cloud ](https://github.com/apache-superset/superset-ui-plugins/tree/master/packages/superset-ui-legacy-plugin-chart-word-cloud ) | [](https://img.shields.io/npm/v/@superset-ui/legacy-plugin-chart-word-cloud.svg?style=flat-square) |
| [@superset-ui/legacy-plugin-chart-world-map ](https://github.com/apache-superset/superset-ui-plugins/tree/master/packages/superset-ui-legacy-plugin-chart-world-map ) | [](https://img.shields.io/npm/v/@superset-ui/legacy-plugin-chart-world-map.svg?style=flat-square) |
2019-01-23 15:31:45 -05:00
### Development
2019-02-22 20:30:35 -05:00
[lerna ](https://github.com/lerna/lerna/ ) and [yarn ](https://yarnpkg.com ) are used to manage versions and dependencies between
2019-01-23 15:31:45 -05:00
packages in this monorepo.
```
superset-ui/
lerna.json
package.json
...
packages/
package1/
package.json
...
src/
test/
...
lib/
esm/
...
...
```
### Installation
1. clone this repo
2. have yarn install package dependencies and manage the symlinking between packages for you
```sh
2019-02-22 20:30:35 -05:00
git clone ...superset-ui-plugins & & cd superset-ui-plugins
2019-01-23 15:31:45 -05:00
yarn install
2019-01-29 20:19:31 -05:00
yarn build
2019-01-23 15:31:45 -05:00
```
### Builds, linting, and testing
Each package defines its own build config, linting, and testing. You can have lerna run commands
across all packages using the syntax `yarn run test` (or `yarn run test:watch` for watch mode) from the root `@superset-ui` directory.
2019-02-25 16:24:22 -05:00
### Committing
This repository follows [conventional commits ](https://www.conventionalcommits.org/en/v1.0.0-beta.3/ ) guideline for commit messages and has a `commitlint` hook which will require you to have the valid commit message before committing. You can use `npm run commit` to help you create a commit message.
2019-01-23 15:31:45 -05:00
### Publishing
2019-02-22 20:30:35 -05:00
**Prerequisite:** You'll need an [npmjs.com ](https://npmjs.com ) account that is part of the `@superset-ui` organization.
2019-01-23 15:31:45 -05:00
1. Make sure you're logged in to NPM from your shell. Run `npm login` if necessary.
2. To make the release, run `yarn run release` and follow the prompts.
### License
Apache-2.0
