-
Notifications
You must be signed in to change notification settings - Fork 12.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(generator-superset): add scaffolder for chart plugin (#456)
* feat: add plugin generator * feat: add templates * feat: add templates * fix: wrong path * fix: unit test * fix: coverage * fix: simplify template
- Loading branch information
1 parent
3364f0f
commit dfa166c
Showing
13 changed files
with
292 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
52 changes: 52 additions & 0 deletions
52
...rary_superset_ui/superset-ui/packages/generator-superset/generators/plugin-chart/index.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| /* eslint-disable sort-keys */ | ||
|
|
||
| const Generator = require('yeoman-generator'); | ||
| const _ = require('lodash'); | ||
|
|
||
| module.exports = class extends Generator { | ||
| async prompting() { | ||
| this.option('skipInstall'); | ||
|
|
||
| this.answers = await this.prompt([ | ||
| { | ||
| type: 'input', | ||
| name: 'packageName', | ||
| message: 'Package name:', | ||
| // Default to current folder name | ||
| default: _.kebabCase(this.appname.replace('plugin chart', '').trim()), | ||
| }, | ||
| { | ||
| type: 'input', | ||
| name: 'description', | ||
| message: 'Description:', | ||
| // Default to current folder name | ||
| default: _.upperFirst(_.startCase(this.appname.replace('plugin chart', '').trim())), | ||
| }, | ||
| ]); | ||
| } | ||
|
|
||
| writing() { | ||
| const packageLabel = _.upperFirst(_.camelCase(this.answers.packageName)); | ||
|
|
||
| const params = { | ||
| ...this.answers, | ||
| packageLabel, | ||
| }; | ||
|
|
||
| [ | ||
| ['package.erb', 'package.json'], | ||
| ['README.erb', 'README.md'], | ||
| ['src/index.erb', 'src/index.ts'], | ||
| ['src/plugin/index.erb', 'src/plugin/index.ts'], | ||
| ['src/plugin/transformProps.txt', 'src/plugin/transformProps.ts'], | ||
| ['src/MyChart.erb', `src/${packageLabel}.tsx`], | ||
| ['test/index.erb', 'test/index.test.ts'], | ||
| ].forEach(([src, dest]) => { | ||
| this.fs.copyTpl(this.templatePath(src), this.destinationPath(dest), params); | ||
| }); | ||
|
|
||
| ['types/external.d.ts', 'src/images/thumbnail.png'].forEach(file => { | ||
| this.fs.copy(this.templatePath(file), this.destinationPath(file)); | ||
| }); | ||
| } | ||
| }; |
32 changes: 32 additions & 0 deletions
32
...t_ui/superset-ui/packages/generator-superset/generators/plugin-chart/templates/README.erb
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| ## @superset-ui/plugin-chart-<%= packageName %> | ||
|
|
||
| [](https://img.shields.io/npm/v/@superset-ui/plugin-chart-<%= packageName %>.svg?style=flat-square) | ||
| [](https://david-dm.org/apache-superset/superset-ui?path=packages/superset-ui-plugin-chart-<%= packageName %>) | ||
|
|
||
| This plugin provides <%= description %> for Superset. | ||
|
|
||
| ### Usage | ||
|
|
||
| Configure `key`, which can be any `string`, and register the plugin. This `key` will be used to lookup this chart throughout the app. | ||
|
|
||
| ```js | ||
| import <%= packageLabel %>ChartPlugin from '@superset-ui/plugin-chart-<%= packageName %>'; | ||
|
|
||
| new <%= packageLabel %>ChartPlugin() | ||
| .configure({ key: '<%= packageName %>' }) | ||
| .register(); | ||
| ``` | ||
|
|
||
| Then use it via `SuperChart`. See [storybook](https://apache-superset.github.io/superset-ui/?selectedKind=plugin-chart-<%= packageName %>) for more details. | ||
|
|
||
| ```js | ||
| <SuperChart | ||
| chartType="<%= packageName %>" | ||
| width={600} | ||
| height={600} | ||
| formData={...} | ||
| queryData={{ | ||
| data: {...}, | ||
| }} | ||
| /> | ||
| ``` |
32 changes: 32 additions & 0 deletions
32
..._ui/superset-ui/packages/generator-superset/generators/plugin-chart/templates/package.erb
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| { | ||
| "name": "@superset-ui/plugin-chart-<%= packageName %>", | ||
| "version": "0.0.0", | ||
| "description": "Superset Chart - <%= description %>", | ||
| "sideEffects": false, | ||
| "main": "lib/index.js", | ||
| "module": "esm/index.js", | ||
| "files": [ | ||
| "esm", | ||
| "lib" | ||
| ], | ||
| "repository": { | ||
| "type": "git", | ||
| "url": "git+https://github.com/apache-superset/superset-ui.git" | ||
| }, | ||
| "keywords": [ | ||
| "superset" | ||
| ], | ||
| "author": "Superset", | ||
| "license": "Apache-2.0", | ||
| "bugs": { | ||
| "url": "https://github.com/apache-superset/superset-ui/issues" | ||
| }, | ||
| "homepage": "https://github.com/apache-superset/superset-ui#readme", | ||
| "publishConfig": { | ||
| "access": "public" | ||
| }, | ||
| "peerDependencies": { | ||
| "@superset-ui/chart": "latest", | ||
| "@superset-ui/translation": "latest" | ||
| } | ||
| } |
40 changes: 40 additions & 0 deletions
40
...superset-ui/packages/generator-superset/generators/plugin-chart/templates/src/MyChart.erb
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| /** | ||
| * 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. | ||
| */ | ||
| import React from 'react'; | ||
|
|
||
| export type <%= packageLabel %>Props = { | ||
| height: number; | ||
| width: number; | ||
| data: { x: number; y: number }[]; | ||
| }; | ||
|
|
||
| export default class <%= packageLabel %> extends React.PureComponent<<%= packageLabel %>Props> { | ||
| render() { | ||
| const { data, height, width } = this.props; | ||
|
|
||
| return ( | ||
| <div style={{ backgroundColor: '#ffe459', padding: 16, borderRadius: 8, height, width }}> | ||
| <h3>Hello!</h3> | ||
| <pre> | ||
| {JSON.stringify(this.props, null, 2)} | ||
| </pre> | ||
| </div> | ||
| ); | ||
| } | ||
| } |
Binary file added
BIN
+3.53 KB
...s/generator-superset/generators/plugin-chart/templates/src/images/thumbnail.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions
1
...i/superset-ui/packages/generator-superset/generators/plugin-chart/templates/src/index.erb
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| export { default as <%= packageLabel %>ChartPlugin } from './plugin'; |
38 changes: 38 additions & 0 deletions
38
...set-ui/packages/generator-superset/generators/plugin-chart/templates/src/plugin/index.erb
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| /** | ||
| * 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. | ||
| */ | ||
| import { t } from '@superset-ui/translation'; | ||
| import { ChartMetadata, ChartPlugin } from '@superset-ui/chart'; | ||
| import transformProps from './transformProps'; | ||
| import thumbnail from '../images/thumbnail.png'; | ||
|
|
||
| const metadata = new ChartMetadata({ | ||
| description: '<%= description %>', | ||
| name: t('<%= packageLabel %>'), | ||
| thumbnail, | ||
| }); | ||
|
|
||
| export default class <%= packageLabel %>ChartPlugin extends ChartPlugin { | ||
| constructor() { | ||
| super({ | ||
| loadChart: () => import('../<%= packageLabel %>'), | ||
| metadata, | ||
| transformProps, | ||
| }); | ||
| } | ||
| } |
32 changes: 32 additions & 0 deletions
32
...ckages/generator-superset/generators/plugin-chart/templates/src/plugin/transformProps.txt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| import { ChartProps } from '@superset-ui/chart'; | ||
|
|
||
| /** | ||
| * 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. | ||
| */ | ||
| export default function transformProps(chartProps: ChartProps) { | ||
| const { width, height, formData, queryData } = chartProps; | ||
| const { color } = formData; | ||
| const { data } = queryData; | ||
|
|
||
| return { | ||
| width, | ||
| height, | ||
| color, | ||
| data, | ||
| }; | ||
| } |
7 changes: 7 additions & 0 deletions
7
.../superset-ui/packages/generator-superset/generators/plugin-chart/templates/test/index.erb
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| import { <%= packageLabel %>ChartPlugin } from '../src'; | ||
|
|
||
| describe('@superset-ui/plugin-chart-<%= packageName %>', () => { | ||
| it('exists', () => { | ||
| expect(<%= packageLabel %>ChartPlugin).toBeDefined(); | ||
| }); | ||
| }); |
4 changes: 4 additions & 0 deletions
4
...rset-ui/packages/generator-superset/generators/plugin-chart/templates/types/external.d.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| declare module '*.png' { | ||
| const value: any; | ||
| export default value; | ||
| } |
45 changes: 45 additions & 0 deletions
45
...d/temporary_superset_ui/superset-ui/packages/generator-superset/test/plugin-chart.test.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| const path = require('path'); | ||
| const assert = require('yeoman-assert'); | ||
| const helpers = require('yeoman-test'); | ||
|
|
||
| describe('generator-superset:plugin-chart', () => { | ||
| let dir; | ||
|
|
||
| beforeAll(() => { | ||
| dir = process.cwd(); | ||
|
|
||
| return helpers | ||
| .run(path.join(__dirname, '../generators/plugin-chart')) | ||
| .withPrompts({ packageName: 'cold-map', description: 'Cold Map' }) | ||
| .withOptions({ skipInstall: true }); | ||
| }); | ||
|
|
||
| /* | ||
| * Change working directory back to original working directory | ||
| * after the test has completed. | ||
| * yeoman tests switch to tmp directory and write files there. | ||
| * Usually this is fine for solo package. | ||
| * However, for a monorepo like this one, | ||
| * it made jest confuses with current directory | ||
| * (being in tmp directory instead of superset-ui root) | ||
| * and interferes with other tests in sibling packages | ||
| * that are run after the yeoman tests. | ||
| */ | ||
| afterAll(() => { | ||
| process.chdir(dir); | ||
| }); | ||
|
|
||
| it('creates files', () => { | ||
| assert.file([ | ||
| 'package.json', | ||
| 'README.md', | ||
| 'src/plugin/index.ts', | ||
| 'src/plugin/transformProps.ts', | ||
| 'src/index.ts', | ||
| 'src/ColdMap.tsx', | ||
| 'test/index.test.ts', | ||
| 'types/external.d.ts', | ||
| 'src/images/thumbnail.png', | ||
| ]); | ||
| }); | ||
| }); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters