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

Ensure preview annotations are resolved relative to the cwd #19594

Merged
merged 2 commits into from
Oct 25, 2022
Merged

Ensure preview annotations are resolved relative to the cwd #19594

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ac8fca6
Ensure preview annotatios are resolved relative to the cwd
tmeasday Oct 24, 2022
b431446
Update code/lib/builder-webpack5/src/preview/iframe-webpack.config.ts
tmeasday Oct 25, 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
24 changes: 14 additions & 10 deletions code/lib/builder-webpack5/src/preview/iframe-webpack.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,21 +125,24 @@ export default async (
path.join(__dirname, '..', '..', 'templates', 'virtualModuleEntry.template.js')
);

previewAnnotations.forEach((previewAnnotationFilename: any) => {
previewAnnotations.forEach((previewAnnotationFilename: string | undefined) => {
if (!previewAnnotationFilename) return;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When does this exit early?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No idea. Previously it was just being cast to any and then used as a string

const clientApi = storybookPaths['@storybook/client-api'];
const clientLogger = storybookPaths['@storybook/client-logger'];

// Ensure that relative paths end up mapped to a filename in the cwd, so a later import
// of the `previewAnnotationFilename` in the template works.
const entryFilename = previewAnnotationFilename.startsWith('.')
? `${previewAnnotationFilename.replace(/(\w)(\/|\\)/g, '$1-')}-generated-config-entry.js`
: previewAnnotationFilename;
// NOTE: although this file is also from the `dist/cjs` directory, it is actually a ESM
// file, see https://github.com/storybookjs/storybook/pull/16727#issuecomment-986485173
virtualModuleMapping[`${previewAnnotationFilename}-generated-config-entry.js`] = interpolate(
entryTemplate,
{
previewAnnotationFilename,
clientApi,
clientLogger,
}
);
entries.push(`${previewAnnotationFilename}-generated-config-entry.js`);
virtualModuleMapping[entryFilename] = interpolate(entryTemplate, {
previewAnnotationFilename,
clientApi,
clientLogger,
});
entries.push(entryFilename);
});
if (stories.length > 0) {
const storyTemplate = await readTemplate(
Expand All @@ -157,6 +160,7 @@ export default async (
entries.push(storiesFilename);
}
}
// console.log(virtualModuleMapping);

const shouldCheckTs = typescriptOptions.check && !typescriptOptions.skipBabel;
const tsCheckOptions = typescriptOptions.checkOptions || {};
Expand Down