🔌 💡
@superset-ui/plugins
@superset-ui/legacy-*
packages are extracted from the classic Apache 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. If a third-party plugin becomes really good, we can consider merging into this repo later.
Packages
Package | Version |
---|---|
@superset-ui/plugin-chart-word-cloud |
Development
lerna and yarn are used to manage versions and dependencies between packages in this monorepo.
superset-ui/
lerna.json
package.json
...
packages/
package1/
package.json
...
src/
test/
...
lib/
esm/
...
...
Installation
- clone this repo
- have yarn install package dependencies and manage the symlinking between packages for you
git clone ...superset-ui-plugins && cd superset-ui-plugins
yarn install
yarn build
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.
Committing
This repository follows conventional commits 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.
Publishing
Prerequisite: You'll need an npmjs.com account that is part of the @superset-ui
organization.
- Make sure you're logged in to NPM from your shell. Run
npm login
if necessary. - To make the release, run
yarn run release
and follow the prompts.
License
Apache-2.0