/
baseGenerator.ts
246 lines (211 loc) · 6.72 KB
/
baseGenerator.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
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
import fse from 'fs-extra';
import { dedent } from 'ts-dedent';
import { NpmOptions } from '../NpmOptions';
import { SupportedRenderers, Builder, CoreBuilder } from '../project_types';
import { getBabelDependencies, copyComponents } from '../helpers';
import { configureMain, configurePreview } from './configure';
import { getPackageDetails, JsPackageManager } from '../js-package-manager';
import { generateStorybookBabelConfigInCWD } from '../babel-config';
import packageVersions from '../versions';
import { FrameworkOptions, GeneratorOptions } from './types';
const defaultOptions: FrameworkOptions = {
extraPackages: [],
extraAddons: [],
staticDir: undefined,
addScripts: true,
addComponents: true,
addBabel: true,
addESLint: false,
extraMain: undefined,
framework: undefined,
extensions: undefined,
commonJs: false,
};
const getBuilderDetails = (builder: string) => {
const map = packageVersions as Record<string, string>;
if (map[builder]) {
return builder;
}
const builderPackage = `@storybook/${builder}`;
if (map[builderPackage]) {
return builderPackage;
}
return builder;
};
const wrapForPnp = (packageName: string) =>
`%%path.dirname(require.resolve(path.join('${packageName}', 'package.json')))%%`;
const getFrameworkDetails = (
renderer: SupportedRenderers,
builder: Builder,
pnp: boolean
): {
type: 'framework' | 'renderer';
packages: string[];
builder?: string;
framework?: string;
renderer?: string;
rendererId: SupportedRenderers;
} => {
const frameworkPackage = `@storybook/${renderer}-${builder}`;
const frameworkPackagePath = pnp ? wrapForPnp(frameworkPackage) : frameworkPackage;
const rendererPackage = `@storybook/${renderer}`;
const rendererPackagePath = pnp ? wrapForPnp(rendererPackage) : rendererPackage;
const builderPackage = getBuilderDetails(builder);
const builderPackagePath = pnp ? wrapForPnp(builderPackage) : builderPackage;
const isKnownFramework = !!(packageVersions as Record<string, string>)[frameworkPackage];
const isKnownRenderer = !!(packageVersions as Record<string, string>)[rendererPackage];
if (renderer === 'angular') {
return {
packages: [rendererPackage],
framework: rendererPackagePath,
rendererId: 'angular',
type: 'framework',
};
}
if (isKnownFramework) {
return {
packages: [frameworkPackage],
framework: frameworkPackagePath,
rendererId: renderer,
type: 'framework',
};
}
if (isKnownRenderer) {
return {
packages: [rendererPackage, builderPackage],
builder: builderPackagePath,
renderer: rendererPackagePath,
rendererId: renderer,
type: 'renderer',
};
}
throw new Error(
`Could not find the framework (${frameworkPackage}) or renderer (${rendererPackage}) package`
);
};
const stripVersions = (addons: string[]) => addons.map((addon) => getPackageDetails(addon)[0]);
const hasInteractiveStories = (rendererId: SupportedRenderers) =>
['react', 'angular', 'preact', 'svelte', 'vue', 'vue3', 'html'].includes(rendererId);
export async function baseGenerator(
packageManager: JsPackageManager,
npmOptions: NpmOptions,
{ language, builder = CoreBuilder.Webpack5, pnp, commonJs }: GeneratorOptions,
renderer: SupportedRenderers,
options: FrameworkOptions = defaultOptions
) {
const {
extraAddons: extraAddonPackages,
extraPackages,
staticDir,
addScripts,
addComponents,
addBabel,
addESLint,
extraMain,
extensions,
} = {
...defaultOptions,
...options,
};
const {
packages: frameworkPackages,
type,
// @ts-ignore
renderer: rendererInclude, // deepscan-disable-line UNUSED_DECL
rendererId,
framework: frameworkInclude,
builder: builderInclude,
} = getFrameworkDetails(renderer, builder, pnp);
// added to main.js
const addons = [
'@storybook/addon-links',
'@storybook/addon-essentials',
...stripVersions(extraAddonPackages),
];
// added to package.json
const addonPackages = [
'@storybook/addon-links',
'@storybook/addon-essentials',
...extraAddonPackages,
];
if (hasInteractiveStories(rendererId)) {
addons.push('@storybook/addon-interactions');
addonPackages.push('@storybook/addon-interactions', '@storybook/testing-library');
}
const yarn2ExtraPackages =
packageManager.type === 'yarn2' ? ['@storybook/addon-docs', '@mdx-js/react@1.x.x'] : [];
const files = await fse.readdir(process.cwd());
const packageJson = packageManager.retrievePackageJson();
const installedDependencies = new Set(
Object.keys({ ...packageJson.dependencies, ...packageJson.devDependencies })
);
// TODO: We need to start supporting this at some point
if (type === 'renderer') {
throw new Error(
dedent`
Sorry, for now, you can not do this, please use a framework such as @storybook/react-webpack5
https://github.com/storybookjs/storybook/issues/18360
`
);
}
const packages = [
'storybook',
...frameworkPackages,
...addonPackages,
...extraPackages,
...yarn2ExtraPackages,
]
.filter(Boolean)
.filter(
(packageToInstall) => !installedDependencies.has(getPackageDetails(packageToInstall)[0])
);
const versionedPackages = await packageManager.getVersionedPackages(packages);
await fse.ensureDir('./.storybook');
await configureMain({
framework: { name: frameworkInclude, options: options.framework || {} },
addons: pnp ? addons.map(wrapForPnp) : addons,
extensions,
commonJs,
...extraMain,
...(type !== 'framework'
? {
core: {
builder: builderInclude,
},
}
: {}),
});
await configurePreview(renderer, options.commonJs);
if (addComponents) {
await copyComponents(renderer, language);
}
// FIXME: temporary workaround for https://github.com/storybookjs/storybook/issues/17516
if (frameworkPackages.find((pkg) => pkg.match(/^@storybook\/.*-vite$/))) {
const previewHead = dedent`
<script>
window.global = window;
</script>
`;
await fse.writeFile(`.storybook/preview-head.html`, previewHead, { encoding: 'utf8' });
}
const babelDependencies = addBabel ? await getBabelDependencies(packageManager, packageJson) : [];
const isNewFolder = !files.some(
(fname) => fname.startsWith('.babel') || fname.startsWith('babel') || fname === 'package.json'
);
if (isNewFolder) {
await generateStorybookBabelConfigInCWD();
}
packageManager.addDependencies({ ...npmOptions, packageJson }, [
...versionedPackages,
...babelDependencies,
]);
if (addScripts) {
packageManager.addStorybookCommandInScripts({
port: 6006,
staticFolder: staticDir,
});
}
if (addESLint) {
packageManager.addESLintConfig();
}
}