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

provider/storybook: Allow *.stories.ts #194

Merged
merged 1 commit into from
Aug 16, 2024
+60 −53
Merged

provider/storybook: Allow *.stories.ts #194

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
105 changes: 54 additions & 51 deletions provider/storybook/index.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,28 +18,30 @@ describe('storybook', () => {
afterAll(() => fetchMocker.disableMocks())

describe('annotations', () => {
test('story file', async () => {
__test__.suppressConsoleLog = true
__test__.skipRewriteForOEmbed = true
afterEach(() => {
__test__.suppressConsoleLog = false
__test__.skipRewriteForOEmbed = false
})
test.each(['story.ts', 'story.tsx', 'stories.ts', 'stories.tsx'])(
'story file ext %s',
async fileExt => {
__test__.suppressConsoleLog = true
__test__.skipRewriteForOEmbed = true
afterEach(() => {
__test__.suppressConsoleLog = false
__test__.skipRewriteForOEmbed = false
})

fetchMocker.mockResponses(
JSON.stringify({
title: 'chromatic-oembed-image',
thumbnail_url: 'https://example.com/thumbnail.png',
thumbnail_width: 400,
thumbnail_height: 300,
}),
['404 Not Found', { status: 404 }],
)
expect(
await storybook.annotations?.(
{
uri: 'file:///a/b.story.tsx',
content: `
fetchMocker.mockResponses(
JSON.stringify({
title: 'chromatic-oembed-image',
thumbnail_url: 'https://example.com/thumbnail.png',
thumbnail_width: 400,
thumbnail_height: 300,
}),
['404 Not Found', { status: 404 }],
)
expect(
await storybook.annotations?.(
{
uri: `file:///a/b.${fileExt}`,
content: `
const config: Meta = {
title: 'a/b',
}
Expand All @@ -48,39 +50,40 @@ export const Foo: Story = {}

export const Bar: Story = {}
`,
},
SETTINGS,
),
).toEqual<AnnotationsResult>([
{
uri: 'file:///a/b.story.tsx',
range: {
start: { line: 5, character: 13 },
end: { line: 5, character: 16 },
},
item: {
title: '🖼️ Storybook: a/b/Foo',
url: 'https://main--abc123.chromatic.com/?path=%2Fstory%2Fa-b--foo',
ui: {
hover: {
markdown:
'<img src="https://example.com/thumbnail.png" alt="chromatic-oembed-image" width="400" height="300" />',
},
SETTINGS,
),
).toEqual<AnnotationsResult>([
{
uri: `file:///a/b.${fileExt}`,
range: {
start: { line: 5, character: 13 },
end: { line: 5, character: 16 },
},
item: {
title: '🖼️ Storybook: a/b/Foo',
url: 'https://main--abc123.chromatic.com/?path=%2Fstory%2Fa-b--foo',
ui: {
hover: {
markdown:
'<img src="https://example.com/thumbnail.png" alt="chromatic-oembed-image" width="400" height="300" />',
},
},
},
},
},
{
uri: 'file:///a/b.story.tsx',
range: {
start: { line: 7, character: 13 },
end: { line: 7, character: 16 },
},
item: {
title: '🖼️ Storybook: a/b/Bar',
url: 'https://main--abc123.chromatic.com/?path=%2Fstory%2Fa-b--bar',
{
uri: `file:///a/b.${fileExt}`,
range: {
start: { line: 7, character: 13 },
end: { line: 7, character: 16 },
},
item: {
title: '🖼️ Storybook: a/b/Bar',
url: 'https://main--abc123.chromatic.com/?path=%2Fstory%2Fa-b--bar',
},
},
},
])
})
])
},
)
})
})
8 changes: 6 additions & 2 deletions provider/storybook/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ const storybook: Provider<Settings> = {
return {
annotations: {
selectors: [
{ path: '**/*.story.(t|j)s?(x)' },
{ path: '**/*.(story|stories).(t|j)s?(x)' },
{ path: '**/*.(t|j)s(x)', contentContains: 'react' },
],
},
Expand All @@ -53,7 +53,11 @@ const storybook: Provider<Settings> = {
}

const contentLines = params.content.split(/\r?\n/)
const fileKind = basename(params.uri).includes('.story.') ? 'story-file' : 'component-file'
const fileName = basename(params.uri)
const fileKind =
fileName.includes('.story.') || fileName.includes('.stories.')
? 'story-file'
: 'component-file'

if (fileKind === 'story-file') {
// Story file.
Expand Down