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: Add webpack4/5 detection #17908

Merged
merged 7 commits into from Apr 7, 2022
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
31 changes: 29 additions & 2 deletions lib/cli/src/detect.ts
Expand Up @@ -13,7 +13,7 @@ import {
CoreBuilder,
} from './project_types';
import { getBowerJson, paddedLog } from './helpers';
import { PackageJson, readPackageJson } from './js-package-manager';
import { PackageJson, readPackageJson, JsPackageManager } from './js-package-manager';

const viteConfigFiles = ['vite.config.ts', 'vite.config.js', 'vite.config.mjs'];

Expand Down Expand Up @@ -104,14 +104,41 @@ export function detectFrameworkPreset(packageJson = {}) {
*
* @returns CoreBuilder
*/
export function detectBuilder() {
export function detectBuilder(packageManager: JsPackageManager) {
const viteConfig = findUp.sync(viteConfigFiles);

if (viteConfig) {
paddedLog('Detected vite project, setting builder to @storybook/builder-vite');
return CoreBuilder.Vite;
}

try {
let out = '';
if (packageManager.type === 'npm') {
try {
// npm <= v7
out = packageManager.executeCommand('npm', ['ls', 'webpack']);
} catch (e2) {
// npm >= v8
out = packageManager.executeCommand('npm', ['why', 'webpack']);
}
} else {
out = packageManager.executeCommand('yarn', ['why', 'webpack']);
}

// if the user has BOTH webpack 4 and 5 installed already, we'll pick the safest options (4)
if (out.includes('webpack@4') || out.includes('webpack@npm:4')) {
return CoreBuilder.Webpack5;
}

// the user has webpack 4 installed, but not 5
if (out.includes('webpack@5') || out.includes('webpack@npm:5')) {
return CoreBuilder.Webpack5;
}
} catch (err) {
//
}

// Fallback to webpack4
return CoreBuilder.Webpack4;
}
Expand Down
5 changes: 1 addition & 4 deletions lib/cli/src/generators/VUE3/index.ts
@@ -1,10 +1,7 @@
import { baseGenerator, Generator } from '../baseGenerator';
import { CoreBuilder } from '../../project_types';

const generator: Generator = async (packageManager, npmOptions, options) => {
const updatedOptions = { ...options, builder: CoreBuilder.Webpack5 };

baseGenerator(packageManager, npmOptions, updatedOptions, 'vue3', {
baseGenerator(packageManager, npmOptions, options, 'vue3', {
extraPackages: ['vue-loader@^16.0.0'],
});
};
Expand Down
2 changes: 1 addition & 1 deletion lib/cli/src/generators/baseGenerator.ts
Expand Up @@ -49,7 +49,7 @@ const defaultOptions: FrameworkOptions = {
const builderDependencies = (builder: Builder) => {
switch (builder) {
case CoreBuilder.Webpack4:
return [];
return ['@storybook/builder-webpack4', '@storybook/manager-webpack4'];
case CoreBuilder.Webpack5:
return ['@storybook/builder-webpack5', '@storybook/manager-webpack5'];
case CoreBuilder.Vite:
Expand Down
2 changes: 1 addition & 1 deletion lib/cli/src/initiate.ts
Expand Up @@ -57,7 +57,7 @@ const installStorybook = (projectType: ProjectType, options: CommandOptions): Pr

const generatorOptions = {
language,
builder: options.builder || detectBuilder(),
builder: options.builder || detectBuilder(packageManager),
linkable: !!options.linkable,
commonJs: options.commonJs,
};
Expand Down