Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: adding Storybook to Superset #10383

Merged
merged 24 commits into from
Jul 22, 2020
Merged

feat: adding Storybook to Superset #10383

merged 24 commits into from
Jul 22, 2020

Conversation

rusackas
Copy link
Member

@rusackas rusackas commented Jul 21, 2020 •
edited
Loading

SUMMARY

So far, there's not much here... just a humble button, but it all loads, webpack works, and both the LESS codebase and the Emotion theme are applied to all stories.

This PR only adds the story for the button. More coming in subsequent PRs.

The stories for a component are recommended to be next to the component itself, neighboring the component's [jt]sx files.

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

image

TEST PLAN

npm run storybook from within superset-frontend

ADDITIONAL INFORMATION

  • Has associated issue:
  • Changes UI
  • Requires DB Migration.
  • Confirm DB Migration upgrade and downgrade tested.
  • Introduces new feature or API
  • Removes existing feature or API

@codecov-commenter
Copy link

codecov-commenter commented Jul 21, 2020 •
edited
Loading

Codecov Report

Merging #10383 into master will increase coverage by 4.30%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master   #10383      +/-   ##
==========================================
+ Coverage   65.44%   69.75%   +4.30%     
==========================================
  Files         603      196     -407     
  Lines       32418    19026   -13392     
  Branches     3297        0    -3297     
==========================================
- Hits        21215    13271    -7944     
+ Misses      11019     5755    -5264     
+ Partials      184        0     -184
Flag Coverage Δ
#javascript ?
#python 69.75% <ø> (+0.03%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
superset-frontend/src/components/ModalTrigger.jsx
...ontend/src/dashboard/components/dnd/DragHandle.jsx
...rontend/src/SqlLab/components/QueryAutoRefresh.jsx
...tend/src/visualizations/FilterBox/controlPanel.jsx
...uperset-frontend/src/components/TooltipWrapper.jsx
...rc/dashboard/components/dnd/dragDroppableConfig.js
...perset-frontend/src/components/CopyToClipboard.jsx
...et-frontend/src/explore/reducers/exploreReducer.js
...-frontend/src/explore/components/controls/index.js
...nd/src/dashboard/util/getFilterValuesByFilterId.js
... and 399 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update dc4b1b1...873a6de. Read the comment docs.

@rusackas rusackas requested a review from nytai July 22, 2020 00:55
@rusackas
Copy link
Member Author

@nytai this seems to be failing CI due to some TS errors around list view components. Not sure how that slipped in here, but maybe you can help?

rusackas
rusackas commented Jul 22, 2020
View reviewed changes
superset-frontend/src/components/Button/button.stories.jsx
},
defaultValue: null,
};
// TODO remove the use of these in the codebase where they're not necessary
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Leaving this here for the moment... it's the result of taking inventory, and I'll remove these comments as I (at least try to) remove these classes from the codebase

@rusackas rusackas marked this pull request as ready for review July 22, 2020 04:32
nytai
nytai approved these changes Jul 22, 2020
View reviewed changes
Copy link
Member

@nytai nytai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm.

I wonder if we can somehow include the storybook from superset-ui in this one.

@rusackas
Copy link
Member Author

lgtm.

I wonder if we can somehow include the storybook from superset-ui in this one.

Interesting question... not sure! But I'll note the task for investigation and a potential follow-up PR.

@rusackas rusackas merged commit ca71d4d into apache:master Jul 22, 2020
@rusackas rusackas deleted the storybook branch July 22, 2020 17:21
auxten pushed a commit to auxten/incubator-superset that referenced this pull request Nov 20, 2020
@rusackas @auxten
feat: adding Storybook to Superset (apache#10383)
d3d5255 
* Storybook added!

* starting to configure junk....

* Storybook works!!!

* Now with theme!

* apache boilerplate

* more apache comments

* lots o' knobs for the Button.... taking stock of the codebase

* more classes, but killing the knob for now.

* nixing unused module

* linting

* fresh package-lock

* now with tooltip!

* adding path and zlip because the linter told me to

* upgrading storybook packages from devdeps

* linting

* removing cruft

* killing an annoying (and old?) lint issue

* lint fix, take 2.

* removing zlib/path

* package lock reset from master

* re-adding new packages for this here PR

* nixing console log, simplifying

* nixing comment TODOs (done enough!)

* basic docs.
@benceorlai
Copy link

Roadmap: apache-superset/superset-roadmap#23

@mistercrunch mistercrunch added 🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels 🚢 0.38.0 labels Mar 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nytai nytai nytai approved these changes

@mistercrunch mistercrunch Awaiting requested review from mistercrunch

Assignees
No one assigned
Labels
🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels 🚢 0.38.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@rusackas @codecov-commenter @benceorlai @nytai @mistercrunch