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

fix(storybook): add args to auto generate docs #5979

Merged
merged 3 commits into from
Jul 22, 2022
Merged

fix(storybook): add args to auto generate docs #5979

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
951eb84
fix(storybook): add `args` to auto generate docs
virtuoushub Jul 16, 2022
86c95cd
test(unit): update snapshots
virtuoushub Jul 18, 2022
ff515b1
Merge branch 'main' into fix/storybook/enable-doc-block
jtoar Jul 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
144 changes: 72 additions & 72 deletions packages/cli/src/commands/generate/cell/__tests__/__snapshots__/cell.test.js.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,20 +131,20 @@ exports[`TypeScript: generates list cells if list flag passed in 3`] = `
"import { Loading, Empty, Failure, Success } from './BazingaCell'
import { standard } from './BazingaCell.mock'

export const loading = () => {
return Loading ? <Loading /> : null
export const loading = (args) => {
return Loading ? <Loading {...args} /> : null
}

export const empty = () => {
return Empty ? <Empty /> : null
export const empty = (args) => {
return Empty ? <Empty {...args} /> : null
}

export const failure = () => {
return Failure ? <Failure error={new Error('Oh no')} /> : null
export const failure = (args) => {
return Failure ? <Failure error={new Error('Oh no')} {...args} /> : null
}

export const success = () => {
return Success ? <Success {...standard()} /> : null
export const success = (args) => {
return Success ? <Success {...standard()} {...args} /> : null
}

export default { title: 'Cells/BazingaCell' }
Expand Down Expand Up @@ -363,20 +363,20 @@ exports[`creates a cell stories with a camelCase word name 1`] = `
"import { Loading, Empty, Failure, Success } from './UserProfileCell'
import { standard } from './UserProfileCell.mock'

export const loading = () => {
return Loading ? <Loading /> : null
export const loading = (args) => {
return Loading ? <Loading {...args} /> : null
}

export const empty = () => {
return Empty ? <Empty /> : null
export const empty = (args) => {
return Empty ? <Empty {...args} /> : null
}

export const failure = () => {
return Failure ? <Failure error={new Error('Oh no')} /> : null
export const failure = (args) => {
return Failure ? <Failure error={new Error('Oh no')} {...args} /> : null
}

export const success = () => {
return Success ? <Success {...standard()} /> : null
export const success = (args) => {
return Success ? <Success {...standard()} {...args} /> : null
}

export default { title: 'Cells/UserProfileCell' }
Expand All @@ -387,20 +387,20 @@ exports[`creates a cell stories with a kebabCase word name 1`] = `
"import { Loading, Empty, Failure, Success } from './UserProfileCell'
import { standard } from './UserProfileCell.mock'

export const loading = () => {
return Loading ? <Loading /> : null
export const loading = (args) => {
return Loading ? <Loading {...args} /> : null
}

export const empty = () => {
return Empty ? <Empty /> : null
export const empty = (args) => {
return Empty ? <Empty {...args} /> : null
}

export const failure = () => {
return Failure ? <Failure error={new Error('Oh no')} /> : null
export const failure = (args) => {
return Failure ? <Failure error={new Error('Oh no')} {...args} /> : null
}

export const success = () => {
return Success ? <Success {...standard()} /> : null
export const success = (args) => {
return Success ? <Success {...standard()} {...args} /> : null
}

export default { title: 'Cells/UserProfileCell' }
Expand All @@ -411,20 +411,20 @@ exports[`creates a cell stories with a multi word name 1`] = `
"import { Loading, Empty, Failure, Success } from './UserProfileCell'
import { standard } from './UserProfileCell.mock'

export const loading = () => {
return Loading ? <Loading /> : null
export const loading = (args) => {
return Loading ? <Loading {...args} /> : null
}

export const empty = () => {
return Empty ? <Empty /> : null
export const empty = (args) => {
return Empty ? <Empty {...args} /> : null
}

export const failure = () => {
return Failure ? <Failure error={new Error('Oh no')} /> : null
export const failure = (args) => {
return Failure ? <Failure error={new Error('Oh no')} {...args} /> : null
}

export const success = () => {
return Success ? <Success {...standard()} /> : null
export const success = (args) => {
return Success ? <Success {...standard()} {...args} /> : null
}

export default { title: 'Cells/UserProfileCell' }
Expand All @@ -435,20 +435,20 @@ exports[`creates a cell stories with a single word name 1`] = `
"import { Loading, Empty, Failure, Success } from './UserCell'
import { standard } from './UserCell.mock'

export const loading = () => {
return Loading ? <Loading /> : null
export const loading = (args) => {
return Loading ? <Loading {...args} /> : null
}

export const empty = () => {
return Empty ? <Empty /> : null
export const empty = (args) => {
return Empty ? <Empty {...args} /> : null
}

export const failure = () => {
return Failure ? <Failure error={new Error('Oh no')} /> : null
export const failure = (args) => {
return Failure ? <Failure error={new Error('Oh no')} {...args} /> : null
}

export const success = () => {
return Success ? <Success {...standard()} /> : null
export const success = (args) => {
return Success ? <Success {...standard()} {...args} /> : null
}

export default { title: 'Cells/UserCell' }
Expand All @@ -459,20 +459,20 @@ exports[`creates a cell stories with a snakeCase word name 1`] = `
"import { Loading, Empty, Failure, Success } from './UserProfileCell'
import { standard } from './UserProfileCell.mock'

export const loading = () => {
return Loading ? <Loading /> : null
export const loading = (args) => {
return Loading ? <Loading {...args} /> : null
}

export const empty = () => {
return Empty ? <Empty /> : null
export const empty = (args) => {
return Empty ? <Empty {...args} /> : null
}

export const failure = () => {
return Failure ? <Failure error={new Error('Oh no')} /> : null
export const failure = (args) => {
return Failure ? <Failure error={new Error('Oh no')} {...args} /> : null
}

export const success = () => {
return Success ? <Success {...standard()} /> : null
export const success = (args) => {
return Success ? <Success {...standard()} {...args} /> : null
}

export default { title: 'Cells/UserProfileCell' }
Expand Down Expand Up @@ -776,20 +776,20 @@ exports[`generates a cell with a string primary id key 3`] = `
"import { Loading, Empty, Failure, Success } from './AddressCell'
import { standard } from './AddressCell.mock'

export const loading = () => {
return Loading ? <Loading /> : null
export const loading = (args) => {
return Loading ? <Loading {...args} /> : null
}

export const empty = () => {
return Empty ? <Empty /> : null
export const empty = (args) => {
return Empty ? <Empty {...args} /> : null
}

export const failure = () => {
return Failure ? <Failure error={new Error('Oh no')} /> : null
export const failure = (args) => {
return Failure ? <Failure error={new Error('Oh no')} {...args} /> : null
}

export const success = () => {
return Success ? <Success {...standard()} /> : null
export const success = (args) => {
return Success ? <Success {...standard()} {...args} /> : null
}

export default { title: 'Cells/AddressCell' }
Expand Down Expand Up @@ -884,20 +884,20 @@ exports[`generates list a cell with a string primary id keys 3`] = `
"import { Loading, Empty, Failure, Success } from './AddressesCell'
import { standard } from './AddressesCell.mock'

export const loading = () => {
return Loading ? <Loading /> : null
export const loading = (args) => {
return Loading ? <Loading {...args} /> : null
}

export const empty = () => {
return Empty ? <Empty /> : null
export const empty = (args) => {
return Empty ? <Empty {...args} /> : null
}

export const failure = () => {
return Failure ? <Failure error={new Error('Oh no')} /> : null
export const failure = (args) => {
return Failure ? <Failure error={new Error('Oh no')} {...args} /> : null
}

export const success = () => {
return Success ? <Success {...standard()} /> : null
export const success = (args) => {
return Success ? <Success {...standard()} {...args} /> : null
}

export default { title: 'Cells/AddressesCell' }
Expand Down Expand Up @@ -990,20 +990,20 @@ exports[`generates list cells if list flag passed in 3`] = `
"import { Loading, Empty, Failure, Success } from './MembersCell'
import { standard } from './MembersCell.mock'

export const loading = () => {
return Loading ? <Loading /> : null
export const loading = (args) => {
return Loading ? <Loading {...args} /> : null
}

export const empty = () => {
return Empty ? <Empty /> : null
export const empty = (args) => {
return Empty ? <Empty {...args} /> : null
}

export const failure = () => {
return Failure ? <Failure error={new Error('Oh no')} /> : null
export const failure = (args) => {
return Failure ? <Failure error={new Error('Oh no')} {...args} /> : null
}

export const success = () => {
return Success ? <Success {...standard()} /> : null
export const success = (args) => {
return Success ? <Success {...standard()} {...args} /> : null
}

export default { title: 'Cells/MembersCell' }
Expand Down
16 changes: 8 additions & 8 deletions packages/cli/src/commands/generate/cell/templates/stories.js.template
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
import { Loading, Empty, Failure, Success } from './${pascalName}Cell'
import { standard } from './${pascalName}Cell.mock'

export const loading = () => {
return Loading ? <Loading /> : null
export const loading = (args) => {
return Loading ? <Loading {...args} /> : null
}

export const empty = () => {
return Empty ? <Empty /> : null
export const empty = (args) => {
return Empty ? <Empty {...args} /> : null
}

export const failure = () => {
return Failure ? <Failure error={new Error("Oh no")} /> : null
export const failure = (args) => {
return Failure ? <Failure error={new Error("Oh no")} {...args} /> : null
}

export const success = () => {
return Success ? <Success {...standard()} /> : null
export const success = (args) => {
return Success ? <Success {...standard()} {...args} /> : null
}

export default { title: 'Cells/${pascalName}Cell' }
8 changes: 4 additions & 4 deletions packages/cli/src/commands/generate/component/__tests__/__snapshots__/component.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,8 @@ export default UserProfile
exports[`creates a multi word component story 1`] = `
"import UserProfile from './UserProfile'

export const generated = () => {
return <UserProfile />
export const generated = (args) => {
return <UserProfile {...args} />
}

export default { title: 'Components/UserProfile' }
Expand Down Expand Up @@ -92,8 +92,8 @@ export default User
exports[`creates a single word component story 1`] = `
"import User from './User'

export const generated = () => {
return <User />
export const generated = (args) => {
return <User {...args} />
}

export default { title: 'Components/User' }
Expand Down
4 changes: 2 additions & 2 deletions packages/cli/src/commands/generate/component/templates/stories.tsx.template
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import ${pascalName} from './${pascalName}'

export const generated = () => {
return <${pascalName} />
export const generated = (args) => {
return <${pascalName} {...args} />
}

export default { title: 'Components/${pascalName}' }
8 changes: 4 additions & 4 deletions packages/cli/src/commands/generate/layout/__tests__/__snapshots__/layout.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,8 +88,8 @@ describe('SinglePageLayout', () => {
exports[`creates a multi word layout test 2`] = `
"import SinglePageLayout from './SinglePageLayout'

export const generated = () => {
return <SinglePageLayout />
export const generated = (args) => {
return <SinglePageLayout {...args} />
}

export default { title: 'Layouts/SinglePageLayout' }
Expand All @@ -108,8 +108,8 @@ export default AppLayout
exports[`creates a single word layout stories 1`] = `
"import AppLayout from './AppLayout'

export const generated = () => {
return <AppLayout />
export const generated = (args) => {
return <AppLayout {...args} />
}

export default { title: 'Layouts/AppLayout' }
Expand Down
4 changes: 2 additions & 2 deletions packages/cli/src/commands/generate/layout/templates/stories.tsx.template
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import ${singularPascalName}Layout from './${pascalName}Layout'

export const generated = () => {
return <${singularPascalName}Layout />
export const generated = (args) => {
return <${singularPascalName}Layout {...args} />
}

export default { title: 'Layouts/${singularPascalName}Layout' }
Loading