Skip to content

CLI: Respect --skip-install in postinstall scripts #31605

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
merged 4 commits into from
May 30, 2025
Merged
Show file tree
Hide file tree
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
33 changes: 23 additions & 10 deletions code/addons/vitest/src/postinstall.ts
Original file line number Diff line number Diff line change
Expand Up @@ -88,9 +88,10 @@ export default async function postInstall(options: PostinstallOptions) {
});

if (out.migrateToNextjsVite) {
await packageManager.addDependencies({ installAsDevDependencies: true }, [
`@storybook/nextjs-vite@${versions['@storybook/nextjs-vite']}`,
]);
await packageManager.addDependencies(
{ installAsDevDependencies: true, skipInstall: options.skipInstall },
[`@storybook/nextjs-vite@${versions['@storybook/nextjs-vite']}`]
);

await packageManager.removeDependencies({}, ['@storybook/nextjs']);

Expand Down Expand Up @@ -266,17 +267,25 @@ export default async function postInstall(options: PostinstallOptions) {
logger.plain(`${step} Installing dependencies:`);
logger.plain(colors.gray(' ' + versionedDependencies.join(', ')));

await packageManager.addDependencies({ installAsDevDependencies: true }, versionedDependencies);
await packageManager.addDependencies(
{ installAsDevDependencies: true, skipInstall: options.skipInstall },
versionedDependencies
);
}

logger.line(1);
logger.plain(`${step} Configuring Playwright with Chromium (this might take some time):`);
logger.plain(colors.gray(' npx playwright install chromium --with-deps'));

await packageManager.executeCommand({
command: 'npx',
args: ['playwright', 'install', 'chromium', '--with-deps'],
});
if (options.skipInstall) {
logger.plain('Skipping Playwright installation, please run this command manually:');
logger.plain(colors.gray(' npx playwright install chromium --with-deps'));
} else {
logger.plain(`${step} Configuring Playwright with Chromium (this might take some time):`);
logger.plain(colors.gray(' npx playwright install chromium --with-deps'));
await packageManager.executeCommand({
command: 'npx',
args: ['playwright', 'install', 'chromium', '--with-deps'],
});
}

const fileExtension =
allDeps.typescript || (await findFile('tsconfig', [...EXTENSIONS, '.json'])) ? 'ts' : 'js';
Expand Down Expand Up @@ -482,6 +491,10 @@ export default async function postInstall(options: PostinstallOptions) {
command.push('--package-manager', options.packageManager);
}

if (options.skipInstall) {
command.push('--skip-install');
}

if (options.configDir !== '.storybook') {
command.push('--config-dir', options.configDir);
}
Expand Down
17 changes: 15 additions & 2 deletions code/lib/cli-storybook/src/add.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ export interface PostinstallOptions {
packageManager: PackageManagerName;
configDir: string;
yes?: boolean;
skipInstall?: boolean;
}

/**
Expand Down Expand Up @@ -69,6 +70,7 @@ type CLIOptions = {
configDir?: string;
skipPostinstall: boolean;
yes?: boolean;
skipInstall?: boolean;
};

/**
Expand All @@ -86,7 +88,13 @@ type CLIOptions = {
*/
export async function add(
addon: string,
{ packageManager: pkgMgr, skipPostinstall, configDir: userSpecifiedConfigDir, yes }: CLIOptions,
{
packageManager: pkgMgr,
skipPostinstall,
configDir: userSpecifiedConfigDir,
yes,
skipInstall,
}: CLIOptions,
logger = console
) {
const [addonName, inputVersion] = getVersionSpecifier(addon);
Expand Down Expand Up @@ -178,7 +186,12 @@ export async function add(
}

if (!skipPostinstall && isCoreAddon(addonName)) {
await postinstallAddon(addonName, { packageManager: packageManager.type, configDir, yes });
await postinstallAddon(addonName, {
packageManager: packageManager.type,
configDir,
yes,
skipInstall,
});
}
}
function isValidVersion(version: string) {
Expand Down
1 change: 1 addition & 0 deletions code/lib/cli-storybook/src/bin/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@ command('add <addon>')
)
.option('-c, --config-dir <dir-name>', 'Directory where to load Storybook configurations from')
.option('-s --skip-postinstall', 'Skip package specific postinstall config modifications')
.option('--skip-install', 'Skip installing deps')
.option('-y --yes', 'Skip prompting the user')
.action((addonName: string, options: any) => add(addonName, options));

Expand Down
9 changes: 5 additions & 4 deletions code/lib/create-storybook/src/initiate.ts
Original file line number Diff line number Diff line change
Expand Up @@ -648,18 +648,19 @@ export async function doInitiate(options: CommandOptions): Promise<
: packageManager.getRunStorybookCommand();

if (selectedFeatures.has('test')) {
const flags = ['--yes', options.skipInstall && '--skip-install'].filter(Boolean).join(' ');
logger.log(
`> npx storybook@${versions.storybook} add --yes @storybook/addon-a11y@${versions['@storybook/addon-a11y']}`
`> npx storybook@${versions.storybook} add ${flags} @storybook/addon-a11y@${versions['@storybook/addon-a11y']}`
);
execSync(
`npx storybook@${versions.storybook} add --yes @storybook/addon-a11y@${versions['@storybook/addon-a11y']}`,
`npx storybook@${versions.storybook} add ${flags} @storybook/addon-a11y@${versions['@storybook/addon-a11y']}`,
{ cwd: process.cwd(), stdio: 'inherit' }
);
logger.log(
`> npx storybook@${versions.storybook} add --yes @storybook/addon-vitest@${versions['@storybook/addon-vitest']}`
`> npx storybook@${versions.storybook} add ${flags} @storybook/addon-vitest@${versions['@storybook/addon-vitest']}`
);
execSync(
`npx storybook@${versions.storybook} add --yes @storybook/addon-vitest@${versions['@storybook/addon-vitest']}`,
`npx storybook@${versions.storybook} add ${flags} @storybook/addon-vitest@${versions['@storybook/addon-vitest']}`,
{ cwd: process.cwd(), stdio: 'inherit' }
);
}
Expand Down