/
storybook-metadata.test.ts
209 lines (189 loc) · 4.98 KB
/
storybook-metadata.test.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
import type { PackageJson, StorybookConfig } from '@storybook/core-common';
import { computeStorybookMetadata, metaFrameworks } from './storybook-metadata';
const packageJsonMock: PackageJson = {
name: 'some-user-project',
version: 'x.x.x',
};
const mainJsMock: StorybookConfig = {
stories: [],
};
jest.mock('./package-versions', () => {
const getActualPackageVersion = jest.fn((name) =>
Promise.resolve({
name,
version: 'x.x.x',
})
);
const getActualPackageVersions = jest.fn((packages) =>
Promise.all(Object.keys(packages).map(getActualPackageVersion))
);
return {
getActualPackageVersions,
getActualPackageVersion,
};
});
jest.mock('./get-monorepo-type', () => ({
getMonorepoType: () => 'Nx',
}));
jest.mock('detect-package-manager', () => ({
detect: () => 'Yarn',
getNpmVersion: () => '3.1.1',
}));
describe('await computeStorybookMetadata', () => {
test('should return frameworkOptions from mainjs', async () => {
const reactResult = await computeStorybookMetadata({
packageJson: {
...packageJsonMock,
devDependencies: {
'@storybook/react': 'x.x.x',
},
},
mainConfig: {
...mainJsMock,
reactOptions: {
fastRefresh: false,
},
},
});
expect(reactResult.framework).toEqual({ name: 'react', options: { fastRefresh: false } });
const angularResult = await computeStorybookMetadata({
packageJson: {
...packageJsonMock,
devDependencies: {
'@storybook/angular': 'x.x.x',
},
},
mainConfig: {
...mainJsMock,
angularOptions: {
enableIvy: true,
},
},
});
expect(angularResult.framework).toEqual({ name: 'angular', options: { enableIvy: true } });
});
test('should separate storybook packages and addons', async () => {
const result = await computeStorybookMetadata({
packageJson: {
...packageJsonMock,
devDependencies: {
'@storybook/react': 'x.y.z',
'@storybook/addon-essentials': 'x.x.x',
'@storybook/addon-knobs': 'x.x.y',
'storybook-addon-deprecated': 'x.x.z',
},
},
mainConfig: {
...mainJsMock,
addons: [
'@storybook/addon-essentials',
'storybook-addon-deprecated/register',
'@storybook/addon-knobs/preset',
],
},
});
expect(result.addons).toMatchInlineSnapshot(`
Object {
"@storybook/addon-essentials": Object {
"options": undefined,
"version": "x.x.x",
},
"@storybook/addon-knobs": Object {
"options": undefined,
"version": "x.x.x",
},
"storybook-addon-deprecated": Object {
"options": undefined,
"version": "x.x.x",
},
}
`);
expect(result.storybookPackages).toMatchInlineSnapshot(`
Object {
"@storybook/react": Object {
"version": "x.x.x",
},
}
`);
});
test('should return user specified features', async () => {
const features = {
interactionsDebugger: true,
};
const result = await computeStorybookMetadata({
packageJson: packageJsonMock,
mainConfig: {
...mainJsMock,
features,
},
});
expect(result.features).toEqual(features);
});
test('should handle different types of builders', async () => {
const simpleBuilder = 'webpack4';
const complexBuilder = {
name: 'webpack5',
options: {
lazyCompilation: true,
},
};
expect(
(
await computeStorybookMetadata({
packageJson: packageJsonMock,
mainConfig: {
...mainJsMock,
core: {
builder: complexBuilder,
},
},
})
).builder
).toEqual(complexBuilder);
expect(
(
await computeStorybookMetadata({
packageJson: packageJsonMock,
mainConfig: {
...mainJsMock,
core: {
builder: simpleBuilder,
},
},
})
).builder
).toEqual({ name: simpleBuilder });
});
test('should return the number of refs', async () => {
const res = await computeStorybookMetadata({
packageJson: packageJsonMock,
mainConfig: {
...mainJsMock,
refs: {
a: { title: '', url: '' },
b: { title: '', url: '' },
},
},
});
expect(res.refCount).toEqual(2);
});
test.each(Object.entries(metaFrameworks))(
'should detect the supported metaframework: %s',
async (metaFramework, name) => {
const res = await computeStorybookMetadata({
packageJson: {
...packageJsonMock,
dependencies: {
[metaFramework]: 'x.x.x',
},
},
mainConfig: mainJsMock,
});
expect(res.metaFramework).toEqual({
name,
packageName: metaFramework,
version: 'x.x.x',
});
}
);
});