pt/superset
1
0
Fork 0
mirror of https://github.com/apache/superset.git synced 2024-09-16 10:39:55 -04:00
Code Issues Packages Projects Releases Wiki Activity
b07c07de05
superset/superset-frontend/packages/generator-superset/README.md

52 lines
1.7 KiB
Markdown
Raw Normal View History

chore: fix end-of-file (#1468) * chore: end of file fixer * compress image * lint without build * lintrc improvment * exporting * update parallel-coordinates tsconfig * add license to md file * add license * add eslintignore
2021-11-15 04:57:37 -05:00
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
Add generator-superset (#21) * add generator to monorepo * Squash all attempts (+21 squashed commits) Squashed commits: [cca27ae] enable jest projects [e7dc4ce] wip [dd3ea7a] run in order [cf87275] define projects [69baf16] use specific version [c880cfa] ignore generator test [e9e0fd3] update travis [4bbb3c0] update travis [d63118b] update travis config [267fe08] remove config [44883e8] update travis [40580c3] reduce node version [59b6add] update ignore rule [fbbd03c] update readme [b299dfe] remove script [a988933] fix test and lint [95b7d5b] try install and not install [f4583b4] remove unnecessary files [c735329] remove eslint-config-xo [49b3106] pass lint and test [56c6def] remove git and readd * can get test to pass if exclude generator-superset * add afterall to correct working directory * update config * add readme
2018-11-07 19:03:20 -05:00
# generator-superset
fix: point version badge to npm page (#821)
2020-11-05 07:59:06 -05:00
[![Version](https://img.shields.io/npm/v/@superset-ui/generator-superset.svg?style=flat)](https://www.npmjs.com/package/@superset-ui/generator-superset)
Add generator-superset (#21) * add generator to monorepo * Squash all attempts (+21 squashed commits) Squashed commits: [cca27ae] enable jest projects [e7dc4ce] wip [dd3ea7a] run in order [cf87275] define projects [69baf16] use specific version [c880cfa] ignore generator test [e9e0fd3] update travis [4bbb3c0] update travis [d63118b] update travis config [267fe08] remove config [44883e8] update travis [40580c3] reduce node version [59b6add] update ignore rule [fbbd03c] update readme [b299dfe] remove script [a988933] fix test and lint [95b7d5b] try install and not install [f4583b4] remove unnecessary files [c735329] remove eslint-config-xo [49b3106] pass lint and test [56c6def] remove git and readd * can get test to pass if exclude generator-superset * add afterall to correct working directory * update config * add readme
2018-11-07 19:03:20 -05:00
[![David (path)](https://img.shields.io/david/apache-superset/superset-ui.svg?path=packages%2Fgenerator-superset&style=flat-square)](https://david-dm.org/apache-superset/superset-ui?path=packages/generator-superset)
> Scaffolder for Superset
## Installation
feat: updated viz plugin generator (#636) * feat: hello world plugin * Fix yeoman generator * Adding Emotion to template and template result * adding `reactify` technique to example code * fixing errant comma * annoying lint issue * React needed for JSX * questionable typing fix * labelling options * freshly generated hello world * linting and freshly generated plugin * add comments to buildQuery * Add docs * nixing word cloud console logs * lint annoyance * a note on multiple plugin exports * second option for building a plugin is now enabled * Officially supporting viz plugins ;) * fresh plugin build * Adding note about controls, and TODOs for example controls * linting * new lock file * adding file structure to readme * more transform props notes * better notes, better linting * Adding a third option for rendering plugin * fresh package rendering * manually updated plugin. Now let's see if the generator matches it! * template changes, fresh plugin render. * moving file tree to the right place * touchups to template (killing third option) * thumbnail update * Spit out form data, for good measure. * more clarity * dummy controls * bold control works, fresh docs, fresh build! * typing for fancy props * bump superset-ui deps to 0.14 * Implement header text and font size * Add tests + mcense headers + inor cleanup * Replace YourPluginName with packageLabel in README * remove trailing spaces * fix hard coded reference to HelloWorld * removing legacy generators * plugin comment tweaks * typescript comments, minor formatting * adding option for badges in readme * generator offers choice of function or class plugin * Add timeseries option * killing the plugin... we'll make that a separate PR. * add new tests * remove unnecessary imports * fix timeseries type * comment on value/label in select options Co-authored-by: Jesse Yang <jesse.yang@airbnb.com> * moving renderTrigger note up to first instance * control-utils -> chart-controls * Wrapper -> Styles nomenclature * Stronger typing (H/T @ktmud) * ControlPanelConfig type on control config * nixing requiresTime * moving Styles component to be external, passing it props * lint nits * typing tweak Co-authored-by: Ville Brofeldt <ville.v.brofeldt@gmail.com> Co-authored-by: Jesse Yang <jesse.yang@airbnb.com>
2020-07-02 11:52:24 -04:00
First, install [Yeoman](http://yeoman.io) and `generator-superset` using
[npm](https://www.npmjs.com/) (we assume you have pre-installed [node.js](https://nodejs.org/)).
Add generator-superset (#21) * add generator to monorepo * Squash all attempts (+21 squashed commits) Squashed commits: [cca27ae] enable jest projects [e7dc4ce] wip [dd3ea7a] run in order [cf87275] define projects [69baf16] use specific version [c880cfa] ignore generator test [e9e0fd3] update travis [4bbb3c0] update travis [d63118b] update travis config [267fe08] remove config [44883e8] update travis [40580c3] reduce node version [59b6add] update ignore rule [fbbd03c] update readme [b299dfe] remove script [a988933] fix test and lint [95b7d5b] try install and not install [f4583b4] remove unnecessary files [c735329] remove eslint-config-xo [49b3106] pass lint and test [56c6def] remove git and readd * can get test to pass if exclude generator-superset * add afterall to correct working directory * update config * add readme
2018-11-07 19:03:20 -05:00
```bash
npm install -g yo
npm install -g @superset-ui/generator-superset
```
## Usage
fix(generator): more cleanup to plugin framework (#18027) * fix(generator): more cleanup to plugin framework * fix typo and package name * add docs * fix typo * Update superset-frontend/webpack.config.js Co-authored-by: Kamil Gabryjelski <kamil.gabryjelski@gmail.com> * fix generator reference * add steps to tutorial and fix package version * refine docs/readme Co-authored-by: Kamil Gabryjelski <kamil.gabryjelski@gmail.com>
2022-01-17 03:23:35 -05:00
Generate a new package or visualization plugin:
Add generator-superset (#21) * add generator to monorepo * Squash all attempts (+21 squashed commits) Squashed commits: [cca27ae] enable jest projects [e7dc4ce] wip [dd3ea7a] run in order [cf87275] define projects [69baf16] use specific version [c880cfa] ignore generator test [e9e0fd3] update travis [4bbb3c0] update travis [d63118b] update travis config [267fe08] remove config [44883e8] update travis [40580c3] reduce node version [59b6add] update ignore rule [fbbd03c] update readme [b299dfe] remove script [a988933] fix test and lint [95b7d5b] try install and not install [f4583b4] remove unnecessary files [c735329] remove eslint-config-xo [49b3106] pass lint and test [56c6def] remove git and readd * can get test to pass if exclude generator-superset * add afterall to correct working directory * update config * add readme
2018-11-07 19:03:20 -05:00
```bash
fix(generator): more cleanup to plugin framework (#18027) * fix(generator): more cleanup to plugin framework * fix typo and package name * add docs * fix typo * Update superset-frontend/webpack.config.js Co-authored-by: Kamil Gabryjelski <kamil.gabryjelski@gmail.com> * fix generator reference * add steps to tutorial and fix package version * refine docs/readme Co-authored-by: Kamil Gabryjelski <kamil.gabryjelski@gmail.com>
2022-01-17 03:23:35 -05:00
mkdir /tmp/superset-plugin-chart-hello-world
cd /tmp/superset-plugin-chart-hello-world
Add generator-superset (#21) * add generator to monorepo * Squash all attempts (+21 squashed commits) Squashed commits: [cca27ae] enable jest projects [e7dc4ce] wip [dd3ea7a] run in order [cf87275] define projects [69baf16] use specific version [c880cfa] ignore generator test [e9e0fd3] update travis [4bbb3c0] update travis [d63118b] update travis config [267fe08] remove config [44883e8] update travis [40580c3] reduce node version [59b6add] update ignore rule [fbbd03c] update readme [b299dfe] remove script [a988933] fix test and lint [95b7d5b] try install and not install [f4583b4] remove unnecessary files [c735329] remove eslint-config-xo [49b3106] pass lint and test [56c6def] remove git and readd * can get test to pass if exclude generator-superset * add afterall to correct working directory * update config * add readme
2018-11-07 19:03:20 -05:00
yo @superset-ui/superset
```
## License
Apache-2.0
[learn more about Yeoman](http://yeoman.io/).
Reference in New Issue Copy Permalink