-
Notifications
You must be signed in to change notification settings - Fork 6.4k
feat(ct): type mount() story ids through a generated Stories registry #42518
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
Merged
Pavel Feldman (pavelfeldman)
merged 1 commit into
microsoft:main
from
pavelfeldman:fix-42083
Sep 3, 2026
+351
−47
Merged
Changes from all commits
Commits
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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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
File renamed without changes.
This file contains hidden or 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 hidden or 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,28 @@ | ||
| /** | ||
| * Copyright (c) Microsoft Corporation. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| // This file is generated by storyTypes.ts, do not edit manually. | ||
|
|
||
| type StoriesOf<Prefix extends string, Mod> = { [K in keyof Mod & string as `${Prefix}/${K}`]: Mod[K] }; | ||
|
|
||
| declare module '@playwright/test' { | ||
| interface Stories extends | ||
| StoriesOf<'html-reporter/chip', typeof import('../src/chip.story')>, | ||
| StoriesOf<'html-reporter/headerView', typeof import('../src/headerView.story')>, | ||
| StoriesOf<'html-reporter/testCaseView', typeof import('../src/testCaseView.story')>, | ||
| StoriesOf<'html-reporter/testFileView', typeof import('../src/testFileView.story')> {} | ||
| } | ||
|
|
||
| export {}; | ||
This file contains hidden or 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,95 @@ | ||
| /** | ||
| * Copyright (c) Microsoft Corporation. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| import fs from 'fs'; | ||
| import path from 'path'; | ||
| import type { Plugin } from 'vite'; | ||
|
|
||
| const storyFile = /\.story\.(tsx|jsx)$/; | ||
| const license = `/** | ||
| * Copyright (c) Microsoft Corporation. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */`; | ||
|
|
||
| // Story ids follow the gallery convention in main.tsx. | ||
| export function storyTypes(options: { prefix: string, src: string, outFile: string }): Plugin { | ||
| const generate = () => { | ||
| const content = render(listStoryFiles(options.src), options); | ||
| if (fs.existsSync(options.outFile) && fs.readFileSync(options.outFile, 'utf8') === content) | ||
| return; | ||
| fs.writeFileSync(options.outFile, content); | ||
| }; | ||
| return { | ||
| name: 'playwright-story-types', | ||
| buildStart() { | ||
| this.addWatchFile(options.src); | ||
| generate(); | ||
| }, | ||
| configureServer(server) { | ||
| const onFile = (file: string) => { | ||
| if (storyFile.test(file)) | ||
| generate(); | ||
| }; | ||
| server.watcher.on('add', onFile); | ||
| server.watcher.on('unlink', onFile); | ||
| }, | ||
| }; | ||
| } | ||
|
|
||
| function listStoryFiles(dir: string): string[] { | ||
| const result: string[] = []; | ||
| for (const entry of fs.readdirSync(dir, { withFileTypes: true })) { | ||
| const file = path.join(dir, entry.name); | ||
| if (entry.isDirectory()) | ||
| result.push(...listStoryFiles(file)); | ||
| else if (storyFile.test(entry.name)) | ||
| result.push(file); | ||
| } | ||
| return result.sort(); | ||
| } | ||
|
|
||
| function render(files: string[], { prefix, src, outFile }: { prefix: string, src: string, outFile: string }): string { | ||
| const outDir = path.dirname(outFile); | ||
| const posix = (p: string) => p.split(path.sep).join('/'); | ||
| const entries = files.map(file => { | ||
| const id = prefix + '/' + posix(path.relative(src, file)).replace(storyFile, ''); | ||
| const specifier = posix(path.relative(outDir, file)).replace(/\.\w+$/, ''); | ||
| return ` StoriesOf<'${id}', typeof import('${specifier.startsWith('.') ? specifier : './' + specifier}')>`; | ||
| }); | ||
| const stories = entries.length ? `interface Stories extends\n${entries.join(',\n')} {}` : 'interface Stories {}'; | ||
| return `${license} | ||
| // This file is generated by ${posix(path.relative(outDir, __filename))}, do not edit manually. | ||
|
|
||
| type StoriesOf<Prefix extends string, Mod> = { [K in keyof Mod & string as \`\${Prefix}/\${K}\`]: Mod[K] }; | ||
|
|
||
| declare module '@playwright/test' { | ||
| ${stories} | ||
| } | ||
|
|
||
| export {}; | ||
| `; | ||
| } |
This file contains hidden or 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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.