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

Typescript: Export IStory in @storybook/angular #9097

Merged
merged 1 commit into from
Jan 21, 2020
Merged

Typescript: Export IStory in @storybook/angular #9097

merged 1 commit into from
Jan 21, 2020

Conversation

atanasster
Copy link
Member

@atanasster atanasster commented Dec 8, 2019 •
edited
Loading

Issue: #9041

What I did

added export of IStory for compatibility

How to test

in angular
import { IStory } from '@storybook/angular';

@vercel
Copy link

vercel bot commented Dec 8, 2019 •
edited
Loading

This pull request is being automatically deployed with ZEIT Now (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://zeit.co/storybook/monorepo/btc0fxt7z
🌍 Preview: https://monorepo-git-fork-atanasster-angular-export-istory.storybook.now.sh

@shilman
Copy link
Member

shilman commented Dec 9, 2019

Should we do this for all frameworks?
Isn't this a breaking change?

cc @kroeder @gaetanmaisse

@atanasster
Copy link
Member Author

@shilman seems this is angular specific PR, there was a breaking change that renamed IStory to StoryFnAngularReturnType

997ce27#diff-24186810dba01fce38b56c8e599a9ed5

My change is not breaking, I am only naming as IStory for the export from client/index.ts

@shilman
Copy link
Member

shilman commented Dec 9, 2019

Sorry my bad. You're adding an export, not modifying an existing export. 👍

@shilman shilman added this to the 6.0.0 milestone Dec 20, 2019
@stale stale bot added the inactive label Jan 10, 2020
@stale stale bot removed the inactive label Jan 11, 2020
shilman
shilman approved these changes Jan 21, 2020
View reviewed changes
Copy link
Member

@shilman shilman left a comment

Choose a reason for hiding this comment

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

LGTM

@shilman
Copy link
Member

shilman commented Jan 21, 2020

@atanasster @kroeder @gaetanmaisse do we want to do this for all frameworks, not just angular?

@shilman shilman changed the title export StoryFnAngularReturnType as IStory Typescript: Export StoryFnAngularReturnType as IStory Jan 21, 2020
@shilman shilman changed the title Typescript: Export StoryFnAngularReturnType as IStory Typescript: Export IStory in @storybook/angular Jan 21, 2020
shilman
shilman requested changes Jan 21, 2020
View reviewed changes
Copy link
Member

@shilman shilman left a comment

Choose a reason for hiding this comment

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

Do we want IStory to be StoryFn<StoryFnAngularReturnType>?

@ndelangen
Copy link
Member

@shilman YES we do

@storybookjs storybookjs deleted a comment from stale bot Jan 21, 2020
@atanasster
Copy link
Member Author

Do we want IStory to be StoryFn<StoryFnAngularReturnType>?

In the breaking change IStory was just renamed to StoryFnAngularReturnType, so I am not sure:

 - export interface IStory {
 + export interface StoryFnAngularReturnType {

shilman
shilman approved these changes Jan 21, 2020
View reviewed changes
Copy link
Member

@shilman shilman left a comment

Choose a reason for hiding this comment

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

I see. Thanks for the clarification @atanasster

@shilman shilman added the patch:yes Bugfix & documentation PR that need to be picked to main branch label Jan 21, 2020
@shilman shilman merged commit 7aef75f into storybookjs:next Jan 21, 2020
@shilman shilman deleted the angular-export-istory branch January 21, 2020 15:52
@shilman shilman added the patch:done Patch/release PRs already cherry-picked to main/release branch label Jan 21, 2020
shilman added a commit that referenced this pull request Jan 21, 2020
@shilman
Typescript: Export IStory in @storybook/angular (#9097)
98176b3 
Typescript: Export IStory in `@storybook/angular`
@shilman shilman mentioned this pull request Jan 21, 2020
Closed
This was referenced Feb 12, 2020
Closed
Closed
Closed
Closed
Closed
This was referenced Feb 24, 2020
Closed
Closed
Closed
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ndelangen ndelangen ndelangen approved these changes

@shilman shilman shilman approved these changes

@alterx alterx Awaiting requested review from alterx

@igor-dv igor-dv Awaiting requested review from igor-dv

Assignees
No one assigned
Labels
bug patch:done Patch/release PRs already cherry-picked to main/release branch patch:yes Bugfix & documentation PR that need to be picked to main branch typescript
Projects
None yet
Milestone
6.0
Development

Successfully merging this pull request may close these issues.
3 participants
@atanasster @shilman @ndelangen