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

CLI: Automigration for new frameworks #18919

Merged
merged 11 commits into from
Aug 15, 2022
Merged

CLI: Automigration for new frameworks #18919

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
27d58ad
CLI: add new frameworks format automigration
yannbf Aug 10, 2022
a7f3904
CLI: add pre-release flag to automigrate
yannbf Aug 10, 2022
a73c5b1
Revert "CLI: add pre-release flag to automigrate"
yannbf Aug 11, 2022
3e73eda
CLI: fix dependency logic in new-frameworks automigration
yannbf Aug 11, 2022
54e5f43
CLI: account for frameworks that did not change format in automigrate
yannbf Aug 11, 2022
fdcaf03
test: add case for angular in new-framerworks migration
yannbf Aug 11, 2022
9791f4e
cleanup
yannbf Aug 12, 2022
fcc4dca
Extend new frameworks automigration to include Webpack4
shilman Aug 15, 2022
e54e22a
log the error with stack trace in automigration
yannbf Aug 15, 2022
441d432
fix core builder logic in new-frameworks automigration
yannbf Aug 15, 2022
c0a47e1
fix new-frameworks logic
yannbf Aug 15, 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
2 changes: 2 additions & 0 deletions code/lib/cli/src/automigrate/fixes/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import { eslintPlugin } from './eslint-plugin';
import { builderVite } from './builder-vite';
import { npm7 } from './npm7';
import { sbScripts } from './sb-scripts';
import { newFrameworks } from './new-frameworks';
import { Fix } from '../types';

export * from '../types';
Expand All @@ -20,4 +21,5 @@ export const fixes: Fix[] = [
builderVite,
npm7,
sbScripts,
newFrameworks,
];
223 changes: 223 additions & 0 deletions code/lib/cli/src/automigrate/fixes/new-frameworks.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,223 @@
/* eslint-disable no-underscore-dangle */
import path from 'path';
import { JsPackageManager } from '../../js-package-manager';
import { newFrameworks } from './new-frameworks';

// eslint-disable-next-line global-require, jest/no-mocks-import
jest.mock('fs-extra', () => require('../../../../../__mocks__/fs-extra'));

const checkNewFrameworks = async ({ packageJson, main }) => {
if (main) {
// eslint-disable-next-line global-require
require('fs-extra').__setMockFiles({
[path.join('.storybook', 'main.js')]: `module.exports = ${JSON.stringify(main)};`,
});
}
const packageManager = {
retrievePackageJson: () => ({ dependencies: {}, devDependencies: {}, ...packageJson }),
} as JsPackageManager;
return newFrameworks.check({ packageManager });
};

describe('new-frameworks fix', () => {
describe('should no-op', () => {
it('in sb < 7', async () => {
const packageJson = { dependencies: { '@storybook/vue': '^6.2.0' } };
await expect(
checkNewFrameworks({
packageJson,
main: {},
})
).resolves.toBeFalsy();
});

it('in sb 7 with no main', async () => {
yannbf marked this conversation as resolved.
Show resolved Hide resolved
const packageJson = { dependencies: { '@storybook/vue': '^7.0.0' } };
await expect(
checkNewFrameworks({
packageJson,
main: undefined,
})
).resolves.toBeFalsy();
});

it('in sb 7 with no framework field in main', async () => {
yannbf marked this conversation as resolved.
Show resolved Hide resolved
const packageJson = { dependencies: { '@storybook/vue': '^7.0.0' } };
await expect(
checkNewFrameworks({
packageJson,
main: {},
})
).resolves.toBeFalsy();
});

it('in sb 7 with no builder', async () => {
yannbf marked this conversation as resolved.
Show resolved Hide resolved
const packageJson = { dependencies: { '@storybook/vue': '^7.0.0' } };
await expect(
checkNewFrameworks({
packageJson,
main: {
framework: '@storybook/vue',
},
})
).resolves.toBeFalsy();
});

it('in sb 7 with unsupported package', async () => {
const packageJson = { dependencies: { '@storybook/riot': '^7.0.0' } };
await expect(
checkNewFrameworks({
packageJson,
main: {
framework: '@storybook/riot',
core: {
builder: 'webpack5',
},
},
})
).resolves.toBeFalsy();
});

// TODO: once we have vite frameworks e.g. @storybook/react-vite, then we should remove this test
it('in sb 7 with vite', async () => {
const packageJson = { dependencies: { '@storybook/react': '^7.0.0' } };
await expect(
checkNewFrameworks({
packageJson,
main: {
framework: '@storybook/react',
core: {
builder: '@storybook/builder-vite',
},
},
})
).resolves.toBeFalsy();
});
});

describe('sb >= 7', () => {
describe('new-frameworks dependency', () => {
it('should update to @storybook/react-webpack5', async () => {
const packageJson = {
dependencies: {
'@storybook/react': '^7.0.0-alpha.0',
'@storybook/builder-webpack5': '^6.5.9',
'@storybook/manager-webpack5': '^6.5.9',
},
};
await expect(
checkNewFrameworks({
packageJson,
main: {
framework: '@storybook/react',
core: {
builder: {
name: 'webpack5',
options: {
lazyCompilation: true,
},
},
},
reactOptions: {
fastRefresh: true,
},
},
})
).resolves.toEqual(
expect.objectContaining({
frameworkPackage: '@storybook/react-webpack5',
dependenciesToAdd: ['@storybook/react-webpack5'],
dependenciesToRemove: [
'@storybook/builder-webpack5',
'@storybook/manager-webpack5',
'@storybook/react',
],
frameworkOptions: {
fastRefresh: true,
},
builderInfo: {
name: 'webpack5',
options: {
lazyCompilation: true,
},
},
})
);
});
it('should update only builders in @storybook/angular', async () => {
const packageJson = {
dependencies: {
'@storybook/angular': '^7.0.0-alpha.0',
'@storybook/builder-webpack5': '^6.5.9',
'@storybook/manager-webpack5': '^6.5.9',
},
};
await expect(
checkNewFrameworks({
packageJson,
main: {
framework: '@storybook/angular',
core: {
builder: {
name: 'webpack5',
options: {
lazyCompilation: true,
},
},
},
angularOptions: {
enableIvy: true,
},
},
})
).resolves.toEqual(
expect.objectContaining({
frameworkPackage: '@storybook/angular',
dependenciesToAdd: [],
dependenciesToRemove: ['@storybook/builder-webpack5', '@storybook/manager-webpack5'],
frameworkOptions: {
enableIvy: true,
},
builderInfo: {
name: 'webpack5',
options: {
lazyCompilation: true,
},
},
})
);
});
});

// TODO: enable this once Vite is supported
// eslint-disable-next-line jest/no-disabled-tests
it.skip('should update to @storybook/react-vite', async () => {
const packageJson = {
dependencies: {
'@storybook/react': '^7.0.0-alpha.0',
'@storybook/builder-vite': '^0.0.2',
},
};
await expect(
checkNewFrameworks({
packageJson,
main: {
framework: '@storybook/react',
core: {
builder: '@storybook/builder-vite',
},
},
})
).resolves.toEqual(
expect.objectContaining({
dependenciesToAdd: '@storybook/react-vite',
dependenciesToRemove: [
'@storybook/react',
'storybook-builder-vite',
'@storybook/builder-vite',
],
})
);
});
});
});
Loading