/
utilities.ts
233 lines (213 loc) · 6.56 KB
/
utilities.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
import {
ExecutorContext,
logger,
readJson,
readJsonFile,
Tree,
} from '@nrwl/devkit';
import { CompilerOptions } from 'typescript';
import { storybookVersion } from './versions';
import { StorybookConfig } from '../executors/models';
import { constants, copyFileSync, mkdtempSync, statSync } from 'fs';
import { tmpdir } from 'os';
import { basename, join, sep } from 'path';
export const Constants = {
addonDependencies: ['@storybook/addons'],
tsConfigExclusions: ['stories', '**/*.stories.ts'],
pkgJsonScripts: {
storybook: 'start-storybook -p 9001 -c .storybook',
},
jsonIndentLevel: 2,
coreAddonPrefix: '@storybook/addon-',
uiFrameworks: {
angular: '@storybook/angular',
react: '@storybook/react',
html: '@storybook/html',
'web-components': '@storybook/web-components',
vue: '@storybook/vue',
vue3: '@storybook/vue3',
svelte: '@storybook/svelte',
'react-native': '@storybook/react-native',
} as const,
};
type Constants = typeof Constants;
type Framework = {
type: keyof Constants['uiFrameworks'];
uiFramework: Constants['uiFrameworks'][keyof Constants['uiFrameworks']];
};
export function isFramework(
type: Framework['type'],
schema: Pick<Framework, 'uiFramework'>
) {
if (type === 'angular' && schema.uiFramework === '@storybook/angular') {
return true;
}
if (type === 'react' && schema.uiFramework === '@storybook/react') {
return true;
}
if (type === 'html' && schema.uiFramework === '@storybook/html') {
return true;
}
if (
type === 'web-components' &&
schema.uiFramework === '@storybook/web-components'
) {
return true;
}
if (type === 'vue' && schema.uiFramework === '@storybook/vue') {
return true;
}
if (type === 'vue3' && schema.uiFramework === '@storybook/vue3') {
return true;
}
if (type === 'svelte' && schema.uiFramework === '@storybook/svelte') {
return true;
}
if (
type === 'react-native' &&
schema.uiFramework === '@storybook/react-native'
) {
return true;
}
return false;
}
export function safeFileDelete(tree: Tree, path: string): boolean {
if (tree.exists(path)) {
tree.delete(path);
return true;
} else {
return false;
}
}
export function readCurrentWorkspaceStorybookVersionFromGenerator(
tree: Tree
): string {
const packageJsonContents = readJson(tree, 'package.json');
return determineStorybookWorkspaceVersion(packageJsonContents);
}
export function readCurrentWorkspaceStorybookVersionFromExecutor() {
const packageJsonContents = readJsonFile('package.json');
return determineStorybookWorkspaceVersion(packageJsonContents);
}
function determineStorybookWorkspaceVersion(packageJsonContents) {
let workspaceStorybookVersion = storybookVersion;
if (packageJsonContents && packageJsonContents['devDependencies']) {
if (packageJsonContents['devDependencies']['@storybook/angular']) {
workspaceStorybookVersion =
packageJsonContents['devDependencies']['@storybook/angular'];
}
if (packageJsonContents['devDependencies']['@storybook/react']) {
workspaceStorybookVersion =
packageJsonContents['devDependencies']['@storybook/react'];
}
if (packageJsonContents['devDependencies']['@storybook/core']) {
workspaceStorybookVersion =
packageJsonContents['devDependencies']['@storybook/core'];
}
if (packageJsonContents['devDependencies']['@storybook/react-native']) {
workspaceStorybookVersion =
packageJsonContents['dependencies']['@storybook/react-native'];
}
}
if (packageJsonContents && packageJsonContents['dependencies']) {
if (packageJsonContents['dependencies']['@storybook/angular']) {
workspaceStorybookVersion =
packageJsonContents['dependencies']['@storybook/angular'];
}
if (packageJsonContents['dependencies']['@storybook/react']) {
workspaceStorybookVersion =
packageJsonContents['dependencies']['@storybook/react'];
}
if (packageJsonContents['dependencies']['@storybook/core']) {
workspaceStorybookVersion =
packageJsonContents['dependencies']['@storybook/core'];
}
if (packageJsonContents['dependencies']['@storybook/react-native']) {
workspaceStorybookVersion =
packageJsonContents['dependencies']['@storybook/react-native'];
}
}
return workspaceStorybookVersion;
}
export type TsConfig = {
extends: string;
compilerOptions: CompilerOptions;
files?: string[];
include?: string[];
exclude?: string[];
references?: Array<{ path: string }>;
};
export function findOrCreateConfig(
config: StorybookConfig,
context: ExecutorContext
): string {
if (config.configFolder && statSync(config.configFolder).isDirectory()) {
return config.configFolder;
} else if (
statSync(config.configPath).isFile() &&
statSync(config.pluginPath).isFile() &&
statSync(config.srcRoot).isFile()
) {
return createStorybookConfig(
config.configPath,
config.pluginPath,
config.srcRoot
);
} else {
const sourceRoot = context.workspace.projects[context.projectName].root;
if (statSync(join(context.root, sourceRoot, '.storybook')).isDirectory()) {
return join(context.root, sourceRoot, '.storybook');
}
}
throw new Error('No configuration settings');
}
function createStorybookConfig(
configPath: string,
pluginPath: string,
srcRoot: string
): string {
const tmpDir = tmpdir();
const tmpFolder = `${tmpDir}${sep}`;
mkdtempSync(tmpFolder);
copyFileSync(
configPath,
`${tmpFolder}/${basename(configPath)}`,
constants.COPYFILE_EXCL
);
copyFileSync(
pluginPath,
`${tmpFolder}/${basename(pluginPath)}`,
constants.COPYFILE_EXCL
);
copyFileSync(
srcRoot,
`${tmpFolder}/${basename(srcRoot)}`,
constants.COPYFILE_EXCL
);
return tmpFolder;
}
export function showStorybookV5Warning(
uiFramework:
| '@storybook/angular'
| '@storybook/react'
| '@storybook/html'
| '@storybook/web-components'
| '@storybook/vue'
| '@storybook/vue3'
| '@storybook/svelte'
| '@storybook/react-native'
) {
logger.warn(
`It looks like you're using Storybook version 5.
Please note that starting with version 14, Nx will drop support for Storybook version 5.
Before upgrading to Nx 14, please make sure you have migrated your Storybook configurations
to the latest version of Storybook.
For more information, please take a look at our upgrade guide:
${
uiFramework === '@storybook/angular'
? 'https://nx.dev/storybook/upgrade-storybook-v6-angular'
: 'https://nx.dev/storybook/upgrade-storybook-v6-react'
}
`
);
}