TestBuild: Add tests and rename to camelCase #24911
Merged
Conversation
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
ndelangen
requested review from
JReinhold,
tmeasday,
shilman and
yannbf
as code owners
ndelangen
commented
Nov 20, 2023
Comment on lines
-28
to
-70
| const list = normalizeStories(entries, { | ||
| configDir: options.configDir, | ||
| workingDir: options.configDir, | ||
| default_files_pattern: '**/*.@(stories.@(js|jsx|mjs|ts|tsx))', | ||
| }); | ||
| const result = ( | ||
| await Promise.all( | ||
| list.map(async ({ directory, files, titlePrefix }) => { | ||
| const pattern = join(directory, files); | ||
| const absolutePattern = isAbsolute(pattern) ? pattern : join(options.configDir, pattern); | ||
| const absoluteDirectory = isAbsolute(directory) | ||
| ? directory | ||
| : join(options.configDir, directory); | ||
|
|
||
| return { | ||
| files: ( | ||
| await glob(slash(absolutePattern), { | ||
| ...commonGlobOptions(absolutePattern), | ||
| follow: true, | ||
| }) | ||
| ).map((f) => relative(absoluteDirectory, f)), | ||
| directory, | ||
| titlePrefix, | ||
| }; | ||
| }) | ||
| ) | ||
| ).flatMap<StoriesEntry>((expanded, i) => { | ||
| const filteredEntries = expanded.files.filter((s) => !s.endsWith('.mdx')); | ||
| // only return the filtered entries when there is something to filter | ||
| // as webpack is faster with unexpanded globs | ||
| let items = []; | ||
| if (filteredEntries.length < expanded.files.length) { | ||
| items = filteredEntries.map((k) => ({ | ||
| ...expanded, | ||
| files: `**/${k}`, | ||
| })); | ||
| } else { | ||
| items = [list[i]]; | ||
| } | ||
|
|
||
| return items; | ||
| }); | ||
| return result; |
There was a problem hiding this comment.
Extracted into a separate file: code/lib/core-server/src/utils/remove-mdx-entries.ts
ndelangen
commented
Nov 20, 2023
Comment on lines
232
to
273
| test('expands to multiple entries', async () => { | ||
| const configDir = '/configDir/'; | ||
| 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', | ||
| ], | ||
| }, | ||
| ], | ||
| configDir | ||
| ); | ||
| glob.mockImplementation(createGlobMock(list)); | ||
|
|
||
| await expect( | ||
| removeMDXEntries( | ||
| Object.values(list).map((e) => e.entry), | ||
| { configDir } | ||
| ) | ||
| ).resolves.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", | ||
| }, | ||
| ] | ||
| `); |
There was a problem hiding this comment.
@kasperpeulen If you wanted to improve the mechanism, by rewriting the files property to not include |mdx or mdx|; this test would break. But you can use this test to TDD that feature.
kasperpeulen
approved these changes
Nov 20, 2023
36 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Addresses: #24890 (review) and #24890 (review)
What I did
normalizeStoriesEntryto camelCase.removeMDXEntries-functionalityChecklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
I think the unit tests should suffice.
Documentation
MIGRATION.MD
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal,ci:mergedorci:dailyGH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli/src/sandbox-templates.tsMake sure this PR contains one of the labels below:
Available labels
bug: Internal changes that fixes incorrect behavior.maintenance: User-facing maintenance tasks.dependencies: Upgrading (sometimes downgrading) dependencies.build: Internal-facing build tooling & test updates. Will not show up in release changelog.cleanup: Minor cleanup style change. Will not show up in release changelog.documentation: Documentation only changes. Will not show up in release changelog.feature request: Introducing a new feature.BREAKING CHANGE: Changes that break compatibility in some way with current major version.other: Changes that don't fit in the above categories.馃 Canary release
This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the
@storybookjs/coreteam here.core team members can create a canary release here or locally with
gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>