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.

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

CLI: determine whether to add interactive stories from renderer rather than framework #18968

Merged
merged 1 commit into from
Aug 20, 2022
Merged
Changes from all commits
Commits
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
28 changes: 17 additions & 11 deletions code/lib/cli/src/generators/baseGenerator.ts
Original file line number Diff line number Diff line change
@@ -51,6 +51,7 @@ const getFrameworkDetails = (
builder?: string;
framework?: string;
renderer?: string;
rendererId: SupportedRenderers;
} => {
const frameworkPackage = `@storybook/${renderer}-${builder}`;
const frameworkPackagePath = pnp ? wrapForPnp(frameworkPackage) : frameworkPackage;
@@ -68,6 +69,7 @@ const getFrameworkDetails = (
return {
packages: [rendererPackage],
framework: rendererPackagePath,
rendererId: 'angular',
type: 'framework',
};
}
@@ -76,6 +78,7 @@ const getFrameworkDetails = (
return {
packages: [frameworkPackage],
framework: frameworkPackagePath,
rendererId: renderer,
type: 'framework',
};
}
@@ -85,6 +88,7 @@ const getFrameworkDetails = (
packages: [rendererPackage, builderPackage],
builder: builderPackagePath,
renderer: rendererPackagePath,
rendererId: renderer,
type: 'renderer',
};
}
@@ -96,8 +100,8 @@ const getFrameworkDetails = (

const stripVersions = (addons: string[]) => addons.map((addon) => getPackageDetails(addon)[0]);

const hasInteractiveStories = (framework: SupportedRenderers) =>
['react', 'angular', 'preact', 'svelte', 'vue', 'vue3', 'html'].includes(framework);
const hasInteractiveStories = (rendererId: SupportedRenderers) =>
['react', 'angular', 'preact', 'svelte', 'vue', 'vue3', 'html'].includes(rendererId);

export async function baseGenerator(
packageManager: JsPackageManager,
@@ -121,6 +125,16 @@ export async function baseGenerator(
...options,
};

const {
packages: frameworkPackages,
type,
// @ts-ignore
renderer: rendererInclude, // deepscan-disable-line UNUSED_DECL
rendererId,
framework: frameworkInclude,
builder: builderInclude,
} = getFrameworkDetails(renderer, builder, pnp);

// added to main.js
const addons = [
'@storybook/addon-links',
@@ -134,7 +148,7 @@ export async function baseGenerator(
...extraAddonPackages,
];

if (hasInteractiveStories(renderer)) {
if (hasInteractiveStories(rendererId)) {
addons.push('@storybook/addon-interactions');
addonPackages.push('@storybook/addon-interactions', '@storybook/testing-library');
}
@@ -148,14 +162,6 @@ export async function baseGenerator(
const installedDependencies = new Set(
Object.keys({ ...packageJson.dependencies, ...packageJson.devDependencies })
);
const {
packages: frameworkPackages,
type,
// @ts-ignore
renderer: rendererInclude, // deepscan-disable-line UNUSED_DECL
framework: frameworkInclude,
builder: builderInclude,
} = getFrameworkDetails(renderer, builder, pnp);

// TODO: We need to start supporting this at some point
if (type === 'renderer') {