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

Build: Fix sandbox generation in linked mode #30469

Merged
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
17 changes: 13 additions & 4 deletions code/lib/cli-storybook/src/link.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { mkdir, readFile } from 'node:fs/promises';
import { mkdir, readFile, writeFile } from 'node:fs/promises';
import { basename, extname, join } from 'node:path';

import { logger } from 'storybook/internal/node-logger';
Expand Down Expand Up @@ -108,14 +108,23 @@ export const link = async ({ target, local, start }: LinkOptions) => {
await exec(`yarn link --all --relative ${storybookDir}`, { cwd: reproDir });

logger.info(`Installing ${reproName}`);
await exec(`yarn install`, { cwd: reproDir });

if (!reproPackageJson.devDependencies?.vite) {
await exec(`yarn add -D webpack-hot-middleware`, { cwd: reproDir });
reproPackageJson.devDependencies = {
...reproPackageJson.devDependencies,
'webpack-hot-middleware': '*',
};
}

// ensure that linking is possible
await exec(`yarn add @types/node@22`, { cwd: reproDir });
reproPackageJson.devDependencies = {
...reproPackageJson.devDependencies,
'@types/node': '^22',
};

await writeFile(join(reproDir, 'package.json'), JSON.stringify(reproPackageJson, null, 2));

await exec(`yarn install`, { cwd: reproDir });

if (start) {
logger.info(`Running ${reproName} storybook`);
Expand Down
12 changes: 11 additions & 1 deletion code/lib/create-storybook/src/generators/NUXT/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ import type { Generator } from '../types';
const generator: Generator = async (packageManager, npmOptions, options) => {
await baseGenerator(
packageManager,
npmOptions,
{
...npmOptions,
},
options,
'vue3',
{
Expand All @@ -19,6 +21,14 @@ const generator: Generator = async (packageManager, npmOptions, options) => {
},
'nuxt'
);

if (npmOptions.skipInstall === true) {
console.log(
'The --skip-install flag is not supported for generating Storybook for Nuxt. We will continue to install dependencies.'
);
await packageManager.installDependencies();
}

// Add nuxtjs/storybook to nuxt.config.js
await packageManager.runPackageCommand('nuxi', [
'module',
Expand Down
16 changes: 12 additions & 4 deletions scripts/tasks/sandbox-parts.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import {
writeFile,
writeJson,
} from 'fs-extra';
import { readFile } from 'fs/promises';
import JSON5 from 'json5';
import { createRequire } from 'module';
import { join, relative, resolve, sep } from 'path';
Expand Down Expand Up @@ -144,7 +145,7 @@ export const init: Task['run'] = async (

await executeCLIStep(steps.init, {
cwd,
optionValues: { debug, yes: true, ...extra },
optionValues: { debug, yes: true, 'skip-install': true, ...extra },
dryRun,
debug,
});
Expand Down Expand Up @@ -538,17 +539,24 @@ export async function addExtraDependencies({
return;
}

const packageJson = JSON.parse(await readFile(join(cwd, 'package.json'), { encoding: 'utf8' }));

const packageManager = JsPackageManagerFactory.getPackageManager({}, cwd);
await packageManager.addDependencies({ installAsDevDependencies: true }, extraDevDeps);
await packageManager.addDependencies(
{ installAsDevDependencies: true, skipInstall: true, packageJson },
extraDevDeps
);

if (extraDeps) {
const versionedExtraDeps = await packageManager.getVersionedPackages(extraDeps);
if (debug) {
logger.log('\uD83C\uDF81 Adding extra deps', versionedExtraDeps);
}
await packageManager.addDependencies({ installAsDevDependencies: true }, versionedExtraDeps);
await packageManager.addDependencies(
{ installAsDevDependencies: true, skipInstall: true, packageJson },
versionedExtraDeps
);
}
await packageManager.installDependencies();
}

export const addStories: Task['run'] = async (
Expand Down
6 changes: 6 additions & 0 deletions scripts/tasks/sandbox.ts
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,12 @@ export const sandbox: Task = {

await setImportMap(details.sandboxDir);

const { JsPackageManagerFactory } = await import('../../code/core/src/common');

const packageManager = JsPackageManagerFactory.getPackageManager({}, details.sandboxDir);

await packageManager.installDependencies();

logger.info(`✅ Storybook sandbox created at ${details.sandboxDir}`);
},
};
1 change: 1 addition & 0 deletions scripts/utils/cli-step.ts
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ export const steps = {
yes: { type: 'boolean' },
type: { type: 'string' },
debug: { type: 'boolean' },
'skip-install': { type: 'boolean' },
}),
},
add: {
Expand Down