-
-
Notifications
You must be signed in to change notification settings - Fork 9.3k
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.
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
TestBuild: Add tests and rename to camelCase #24911
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
248 changes: 248 additions & 0 deletions
248
code/lib/core-server/src/utils/__tests__/remove-mdx-stories.test.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,248 @@ | ||
| import { glob as globlOriginal } from 'glob'; | ||
| import { type StoriesEntry } from '@storybook/types'; | ||
| import { normalizeStoriesEntry } from '@storybook/core-common'; | ||
| import { join } from 'path'; | ||
| import slash from 'slash'; | ||
| import { removeMDXEntries } from '../remove-mdx-entries'; | ||
|
|
||
| const glob = globlOriginal as jest.MockedFunction<typeof globlOriginal>; | ||
|
|
||
| const configDir = '/configDir/'; | ||
| const workingDir = '/'; | ||
|
|
||
| jest.mock('glob', () => ({ glob: jest.fn() })); | ||
|
|
||
| const createList = (list: { entry: StoriesEntry; result: string[] }[]) => { | ||
| return list.reduce<Record<string, { result: string[]; entry: StoriesEntry }>>( | ||
| (acc, { entry, result }) => { | ||
| const { directory, files } = normalizeStoriesEntry(entry, { | ||
| configDir, | ||
| workingDir, | ||
| }); | ||
| acc[slash(join('/', directory, files))] = { result, entry }; | ||
| return acc; | ||
| }, | ||
| {} | ||
| ); | ||
| }; | ||
|
|
||
| const createGlobMock = (input: ReturnType<typeof createList>) => { | ||
| return async (k: string | string[]) => { | ||
| if (Array.isArray(k)) { | ||
| throw new Error('do not pass an array to glob during tests'); | ||
| } | ||
| if (input[slash(k)]) { | ||
| return input[slash(k)]?.result; | ||
| } | ||
|
|
||
| throw new Error('can not find key in input'); | ||
| }; | ||
| }; | ||
|
|
||
| test('empty', async () => { | ||
| const list = createList([]); | ||
| glob.mockImplementation(createGlobMock(list)); | ||
|
|
||
| await expect(() => removeMDXEntries(Object.keys(list), { configDir })).rejects | ||
| .toThrowErrorMatchingInlineSnapshot(` | ||
| "Storybook could not index your stories. | ||
| Your main configuration somehow does not contain a 'stories' field, or it resolved to an empty array. | ||
|
|
||
| Please check your main configuration file and make sure it exports a 'stories' field that is not an empty array. | ||
|
|
||
| More info: https://storybook.js.org/docs/react/faq#can-i-have-a-storybook-with-no-local-stories | ||
| " | ||
| `); | ||
| }); | ||
|
|
||
| test('minimal', async () => { | ||
| const list = createList([{ entry: '*.js', result: [] }]); | ||
| glob.mockImplementation(createGlobMock(list)); | ||
|
|
||
| const result = await removeMDXEntries( | ||
| Object.values(list).map((e) => e.entry), | ||
| { configDir } | ||
| ); | ||
|
|
||
| expect(result).toMatchInlineSnapshot(` | ||
| Array [ | ||
| Object { | ||
| "directory": ".", | ||
| "files": "*.js", | ||
| "titlePrefix": "", | ||
| }, | ||
| ] | ||
| `); | ||
| }); | ||
|
|
||
| test('multiple', async () => { | ||
| const list = createList([ | ||
| { entry: '*.ts', result: [] }, | ||
| { entry: '*.js', result: [] }, | ||
| ]); | ||
| glob.mockImplementation(createGlobMock(list)); | ||
|
|
||
| const result = await removeMDXEntries( | ||
| Object.values(list).map((e) => e.entry), | ||
| { configDir } | ||
| ); | ||
|
|
||
| expect(result).toMatchInlineSnapshot(` | ||
| Array [ | ||
| Object { | ||
| "directory": ".", | ||
| "files": "*.ts", | ||
| "titlePrefix": "", | ||
| }, | ||
| Object { | ||
| "directory": ".", | ||
| "files": "*.js", | ||
| "titlePrefix": "", | ||
| }, | ||
| ] | ||
| `); | ||
| }); | ||
|
|
||
| test('mdx but not matching any files', async () => { | ||
| const list = createList([ | ||
| { entry: '*.mdx', result: [] }, | ||
| { entry: '*.js', result: [] }, | ||
| ]); | ||
| glob.mockImplementation(createGlobMock(list)); | ||
|
|
||
| const result = await removeMDXEntries( | ||
| Object.values(list).map((e) => e.entry), | ||
| { configDir } | ||
| ); | ||
|
|
||
| expect(result).toMatchInlineSnapshot(` | ||
| Array [ | ||
| Object { | ||
| "directory": ".", | ||
| "files": "*.mdx", | ||
| "titlePrefix": "", | ||
| }, | ||
| Object { | ||
| "directory": ".", | ||
| "files": "*.js", | ||
| "titlePrefix": "", | ||
| }, | ||
| ] | ||
| `); | ||
| }); | ||
|
|
||
| test('removes entries that only yield mdx files', async () => { | ||
| const list = createList([ | ||
| { entry: '*.mdx', result: ['/configDir/my-file.mdx'] }, | ||
| { entry: '*.js', result: [] }, | ||
| ]); | ||
| glob.mockImplementation(createGlobMock(list)); | ||
|
|
||
| const result = await removeMDXEntries( | ||
| Object.values(list).map((e) => e.entry), | ||
| { configDir } | ||
| ); | ||
|
|
||
| expect(result).toMatchInlineSnapshot(` | ||
| Array [ | ||
| Object { | ||
| "directory": ".", | ||
| "files": "*.js", | ||
| "titlePrefix": "", | ||
| }, | ||
| ] | ||
| `); | ||
| }); | ||
|
|
||
| test('expands entries that only yield mixed files', async () => { | ||
| const list = createList([ | ||
| { entry: '*.@(mdx|ts)', result: ['/configDir/my-file.mdx', '/configDir/my-file.ts'] }, | ||
| { entry: '*.js', result: [] }, | ||
| ]); | ||
| glob.mockImplementation(createGlobMock(list)); | ||
|
|
||
| const result = await removeMDXEntries( | ||
| Object.values(list).map((e) => e.entry), | ||
| { configDir } | ||
| ); | ||
|
|
||
| expect(result).toMatchInlineSnapshot(` | ||
| Array [ | ||
| Object { | ||
| "directory": ".", | ||
| "files": "**/my-file.ts", | ||
| "titlePrefix": "", | ||
| }, | ||
| Object { | ||
| "directory": ".", | ||
| "files": "*.js", | ||
| "titlePrefix": "", | ||
| }, | ||
| ] | ||
| `); | ||
| }); | ||
|
|
||
| test('passes titlePrefix', async () => { | ||
| const list = createList([ | ||
| { | ||
| entry: { files: '*.@(mdx|ts)', directory: '.', titlePrefix: 'foo' }, | ||
| result: ['/configDir/my-file.mdx', '/configDir/my-file.ts'], | ||
| }, | ||
| ]); | ||
| glob.mockImplementation(createGlobMock(list)); | ||
|
|
||
| const result = await removeMDXEntries( | ||
| Object.values(list).map((e) => e.entry), | ||
| { configDir } | ||
| ); | ||
|
|
||
| expect(result).toMatchInlineSnapshot(` | ||
| Array [ | ||
| Object { | ||
| "directory": ".", | ||
| "files": "**/my-file.ts", | ||
| "titlePrefix": "foo", | ||
| }, | ||
| ] | ||
| `); | ||
| }); | ||
|
|
||
| test('expands to multiple entries', async () => { | ||
| const list = createList([ | ||
| { | ||
| entry: { files: '*.@(mdx|ts)', directory: '.', titlePrefix: 'foo' }, | ||
| result: [ | ||
| '/configDir/my-file.mdx', | ||
| '/configDir/my-file1.ts', | ||
| '/configDir/my-file2.ts', | ||
| '/configDir/my-file3.ts', | ||
| ], | ||
| }, | ||
| ]); | ||
| glob.mockImplementation(createGlobMock(list)); | ||
|
|
||
| const result = await removeMDXEntries( | ||
| Object.values(list).map((e) => e.entry), | ||
| { configDir } | ||
| ); | ||
|
|
||
| expect(result).toMatchInlineSnapshot(` | ||
| Array [ | ||
| Object { | ||
| "directory": ".", | ||
| "files": "**/my-file1.ts", | ||
| "titlePrefix": "foo", | ||
| }, | ||
| Object { | ||
| "directory": ".", | ||
| "files": "**/my-file2.ts", | ||
| "titlePrefix": "foo", | ||
| }, | ||
| Object { | ||
| "directory": ".", | ||
| "files": "**/my-file3.ts", | ||
| "titlePrefix": "foo", | ||
| }, | ||
| ] | ||
| `); | ||
| }); |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Extracted into a separate file:
code/lib/core-server/src/utils/remove-mdx-entries.ts