feat(plugin-word-cloud): change how wordcloud is exported (apache#418)

* feat(plugin-word-cloud): change how wordcloud is exported * docs: fix storybook
zhaoyongjie · Nov 25, 2021 · 3708ade · 3708ade
1 parent 2a728d5
commit 3708ade
Show file tree

Hide file tree

Showing 12 changed files with 50 additions and 35 deletions.
diff --git a/...i/packages/superset-ui-demo/storybook/stories/plugins/plugin-chart-word-cloud/Stories.tsx b/...i/packages/superset-ui-demo/storybook/stories/plugins/plugin-chart-word-cloud/Stories.tsx
@@ -1,8 +1,10 @@
 import React from 'react';
 import { SuperChart } from '@superset-ui/chart';
 import { select, withKnobs } from '@storybook/addon-knobs';
-import WordCloudChartPlugin from '@superset-ui/plugin-chart-word-cloud';
-import LegacyWordCloudChartPlugin from '@superset-ui/plugin-chart-word-cloud/esm/legacy';
+import {
+  WordCloudChartPlugin,
+  LegacyWordCloudChartPlugin,
+} from '@superset-ui/plugin-chart-word-cloud';
 import data from './data';
 
 new WordCloudChartPlugin().configure({ key: 'word-cloud2' }).register();

diff --git a/...ackages/superset-ui-demo/storybook/stories/superset-ui-chart/ChartDataProviderStories.tsx b/...ackages/superset-ui-demo/storybook/stories/superset-ui-chart/ChartDataProviderStories.tsx
@@ -7,7 +7,7 @@ import { BigNumberChartPlugin as LegacyBigNumberPlugin } from '@superset-ui/lega
 import LegacySankeyPlugin from '@superset-ui/legacy-plugin-chart-sankey';
 import LegacySunburstPlugin from '@superset-ui/legacy-plugin-chart-sunburst';
 import LegacyWordCloudPlugin from '@superset-ui/legacy-plugin-chart-word-cloud';
-import WordCloudPlugin from '@superset-ui/plugin-chart-word-cloud';
+import { WordCloudChartPlugin } from '@superset-ui/plugin-chart-word-cloud';
 
 import {
   bigNumberFormData,
@@ -33,7 +33,7 @@ new LegacySunburstPlugin().configure({ key: SUNBURST }).register();
 // @ts-ignore
 new LegacyWordCloudPlugin().configure({ key: WORD_CLOUD_LEGACY }).register();
 // @ts-ignore
-new WordCloudPlugin().configure({ key: WORD_CLOUD }).register();
+new WordCloudChartPlugin().configure({ key: WORD_CLOUD }).register();
 
 const VIS_TYPES = [BIG_NUMBER, SANKEY, SUNBURST, WORD_CLOUD, WORD_CLOUD_LEGACY];
 const FORM_DATA_LOOKUP = {

diff --git a/...t-frontend/temporary_superset_ui/superset-ui/plugins/plugin-chart-word-cloud/src/index.ts b/...t-frontend/temporary_superset_ui/superset-ui/plugins/plugin-chart-word-cloud/src/index.ts
@@ -1,24 +1,3 @@
-import { t } from '@superset-ui/translation';
-import { ChartMetadata, ChartPlugin } from '@superset-ui/chart';
-import buildQuery from './buildQuery';
-import { WordCloudFormData } from './types';
-import transformProps from './transformProps';
-import thumbnail from './images/thumbnail.png';
-
-const metadata = new ChartMetadata({
-  credits: ['https://github.com/jasondavies/d3-cloud'],
-  description: '',
-  name: t('Word Cloud'),
-  thumbnail,
-});
-
-export default class WordCloudChartPlugin extends ChartPlugin<WordCloudFormData> {
-  constructor() {
-    super({
-      buildQuery,
-      loadChart: () => import('./chart/WordCloud'),
-      metadata,
-      transformProps,
-    });
-  }
-}
+export { default as WordCloudChartPlugin } from './plugin';
+export { default as LegacyWordCloudChartPlugin } from './legacyPlugin';
+export * from './types';
diff --git a/...ugin-chart-word-cloud/src/legacy/index.ts → ...hart-word-cloud/src/legacyPlugin/index.ts b/...ugin-chart-word-cloud/src/legacy/index.ts → ...hart-word-cloud/src/legacyPlugin/index.ts
@@ -1,6 +1,6 @@
 import { t } from '@superset-ui/translation';
 import { ChartMetadata, ChartPlugin } from '@superset-ui/chart';
-import buildQuery from '../buildQuery';
+import buildQuery from '../plugin/buildQuery';
 import transformProps from './transformProps';
 import thumbnail from '../images/thumbnail.png';
 import { LegacyWordCloudFormData } from './types';
@@ -13,7 +13,7 @@ const metadata = new ChartMetadata({
   useLegacyApi: true,
 });
 
-export default class WordCloudChartPlugin extends ChartPlugin<LegacyWordCloudFormData> {
+export default class LegacyWordCloudChartPlugin extends ChartPlugin<LegacyWordCloudFormData> {
   constructor() {
     super({
       buildQuery,

diff --git a/...t-word-cloud/src/legacy/transformProps.ts → ...-cloud/src/legacyPlugin/transformProps.ts b/...t-word-cloud/src/legacy/transformProps.ts → ...-cloud/src/legacyPlugin/transformProps.ts
diff --git a/...ugin-chart-word-cloud/src/legacy/types.ts → ...hart-word-cloud/src/legacyPlugin/types.ts b/...ugin-chart-word-cloud/src/legacy/types.ts → ...hart-word-cloud/src/legacyPlugin/types.ts
diff --git a/...plugin-chart-word-cloud/src/buildQuery.ts → ...chart-word-cloud/src/plugin/buildQuery.ts b/...plugin-chart-word-cloud/src/buildQuery.ts → ...chart-word-cloud/src/plugin/buildQuery.ts
@@ -1,5 +1,5 @@
 import { buildQueryContext } from '@superset-ui/query';
-import { WordCloudFormData } from './types';
+import { WordCloudFormData } from '../types';
 
 export default function buildQuery(formData: WordCloudFormData) {
   // Set the single QueryObject's groupby field with series in formData

diff --git a/...end/temporary_superset_ui/superset-ui/plugins/plugin-chart-word-cloud/src/plugin/index.ts b/...end/temporary_superset_ui/superset-ui/plugins/plugin-chart-word-cloud/src/plugin/index.ts
@@ -0,0 +1,24 @@
+import { t } from '@superset-ui/translation';
+import { ChartMetadata, ChartPlugin } from '@superset-ui/chart';
+import buildQuery from './buildQuery';
+import { WordCloudFormData } from '../types';
+import transformProps from './transformProps';
+import thumbnail from '../images/thumbnail.png';
+
+const metadata = new ChartMetadata({
+  credits: ['https://github.com/jasondavies/d3-cloud'],
+  description: '',
+  name: t('Word Cloud'),
+  thumbnail,
+});
+
+export default class WordCloudChartPlugin extends ChartPlugin<WordCloudFormData> {
+  constructor() {
+    super({
+      buildQuery,
+      loadChart: () => import('../chart/WordCloud'),
+      metadata,
+      transformProps,
+    });
+  }
+}
diff --git a/...in-chart-word-cloud/src/transformProps.ts → ...t-word-cloud/src/plugin/transformProps.ts b/...in-chart-word-cloud/src/transformProps.ts → ...t-word-cloud/src/plugin/transformProps.ts
@@ -1,6 +1,6 @@
 import { ChartProps } from '@superset-ui/chart';
-import { WordCloudProps } from './chart/WordCloud';
-import { WordCloudFormData } from './types';
+import { WordCloudProps } from '../chart/WordCloud';
+import { WordCloudFormData } from '../types';
 
 export default function transformProps(chartProps: ChartProps): WordCloudProps {
   const { width, height, formData, queryData } = chartProps;

diff --git a/...tend/temporary_superset_ui/superset-ui/plugins/plugin-chart-word-cloud/test/index.test.ts b/...tend/temporary_superset_ui/superset-ui/plugins/plugin-chart-word-cloud/test/index.test.ts
@@ -0,0 +1,10 @@
+import { WordCloudChartPlugin, LegacyWordCloudChartPlugin } from '../src';
+
+describe('plugin-chart-word-cloud', () => {
+  it('exports WordCloudChartPlugin', () => {
+    expect(WordCloudChartPlugin).toBeDefined();
+  });
+  it('exports LegacyWordCloudChartPlugin', () => {
+    expect(LegacyWordCloudChartPlugin).toBeDefined();
+  });
+});
diff --git a/...-cloud/test/legacy/transformProps.test.ts → .../test/legacyPlugin/transformProps.test.ts b/...-cloud/test/legacy/transformProps.test.ts → .../test/legacyPlugin/transformProps.test.ts
@@ -1,6 +1,6 @@
 import 'babel-polyfill';
 import { ChartProps } from '@superset-ui/chart';
-import transformProps from '../../src/legacy/transformProps';
+import transformProps from '../../src/legacyPlugin/transformProps';
 
 describe('WordCloud tranformProps', () => {
   const formData = {

diff --git a/...-chart-word-cloud/test/buildQuery.test.ts → ...word-cloud/test/plugin/buildQuery.test.ts b/...-chart-word-cloud/test/buildQuery.test.ts → ...word-cloud/test/plugin/buildQuery.test.ts
@@ -1,5 +1,5 @@
 import 'babel-polyfill';
-import buildQuery from '../src/buildQuery';
+import buildQuery from '../../src/plugin/buildQuery';
 
 describe('WordCloud buildQuery', () => {
   const formData = {