-
Notifications
You must be signed in to change notification settings - Fork 2.6k
/
dev.ts
465 lines (436 loc) · 13.7 KB
/
dev.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
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
import type { RequestHandler } from '@umijs/bundler-webpack';
import {
address,
chalk,
lodash,
logger,
portfinder,
rimraf,
winPath,
} from '@umijs/utils';
import { existsSync, readdirSync, readFileSync } from 'fs';
import { basename, join } from 'path';
import { Worker } from 'worker_threads';
import { DEFAULT_HOST, DEFAULT_PORT } from '../../constants';
import { LazySourceCodeCache } from '../../libs/folderCache/LazySourceCodeCache';
import type { GenerateFilesFn, IApi } from '../../types';
import { lazyImportFromCurrentPkg } from '../../utils/lazyImportFromCurrentPkg';
import { getProjectFileList } from '../../utils/projectFileList';
import { createRouteMiddleware } from './createRouteMiddleware';
import { faviconMiddleware } from './faviconMiddleware';
import { getBabelOpts } from './getBabelOpts';
import ViteHtmlPlugin from './plugins/ViteHtmlPlugin';
import { printMemoryUsage } from './printMemoryUsage';
import {
addUnWatch,
createDebouncedHandler,
expandCSSPaths,
expandJSPaths,
unwatch,
watch,
} from './watch';
const bundlerWebpack: typeof import('@umijs/bundler-webpack') =
lazyImportFromCurrentPkg('@umijs/bundler-webpack');
const bundlerVite: typeof import('@umijs/bundler-vite') =
lazyImportFromCurrentPkg('@umijs/bundler-vite');
const MFSU_EAGER_DEFAULT_INCLUDE = [
'react',
'react-error-overlay',
'react/jsx-dev-runtime',
'@umijs/utils/compiled/strip-ansi',
];
export default (api: IApi) => {
api.describe({
enableBy() {
return api.name === 'dev';
},
});
api.registerCommand({
name: 'dev',
description: 'dev server for development',
details: `
umi dev
# dev with specified port
PORT=8888 umi dev
`,
async fn() {
logger.info(chalk.cyan.bold(`Umi v${api.appData.umi.version}`));
const enableVite = !!api.config.vite;
// clear tmp
rimraf.sync(api.paths.absTmpPath);
// check package.json
await api.applyPlugins({
key: 'onCheckPkgJSON',
args: {
origin: null,
current: api.appData.pkg,
},
});
// clean cache if umi version not matched
// const umiJSONPath = join(api.paths.absTmpPath, 'umi.json');
// if (existsSync(umiJSONPath)) {
// const originVersion = require(umiJSONPath).version;
// if (originVersion !== api.appData.umi.version) {
// logger.info(`Delete cache folder since umi version updated.`);
// rimraf.sync(api.paths.absTmpPath);
// }
// }
// fsExtra.outputFileSync(
// umiJSONPath,
// JSON.stringify({ version: api.appData.umi.version }),
// );
// generate files
const generate: GenerateFilesFn = async (opts) => {
await api.applyPlugins({
key: 'onGenerateFiles',
args: {
files: opts.files || null,
isFirstTime: opts.isFirstTime,
},
});
};
await generate({
isFirstTime: true,
});
const { absPagesPath, absSrcPath } = api.paths;
const watcherPaths: string[] = await api.applyPlugins({
key: 'addTmpGenerateWatcherPaths',
initialValue: [
absPagesPath,
!api.config.routes && api.config.conventionRoutes?.base,
join(absSrcPath, 'layouts'),
...expandJSPaths(join(absSrcPath, 'loading')),
...expandJSPaths(join(absSrcPath, 'app')),
...expandJSPaths(join(absSrcPath, 'global')),
...expandCSSPaths(join(absSrcPath, 'global')),
...expandCSSPaths(join(absSrcPath, 'overrides')),
].filter(Boolean),
});
lodash.uniq<string>(watcherPaths.map(winPath)).forEach((p: string) => {
watch({
path: p,
addToUnWatches: true,
onChange: createDebouncedHandler({
timeout: 2000,
async onChange(opts) {
await generate({ files: opts.files, isFirstTime: false });
},
}),
});
});
// watch package.json change
const pkgPath = join(api.cwd, 'package.json');
watch({
path: pkgPath,
addToUnWatches: true,
onChange() {
// Why try catch?
// ref: https://github.com/umijs/umi/issues/8608
try {
const origin = api.appData.pkg;
api.appData.pkg = JSON.parse(readFileSync(pkgPath, 'utf-8'));
api.applyPlugins({
key: 'onCheckPkgJSON',
args: {
origin,
current: api.appData.pkg,
},
});
api.applyPlugins({
key: 'onPkgJSONChanged',
args: {
origin,
current: api.appData.pkg,
},
});
} catch (e) {
logger.error(e);
}
},
});
// watch config change
addUnWatch(
api.service.configManager!.watch({
schemas: api.service.configSchemas,
onChangeTypes: api.service.configOnChanges,
async onChange(opts) {
await api.applyPlugins({
key: 'onCheckConfig',
args: {
config: api.config,
userConfig: api.userConfig,
},
});
const { data } = opts;
if (data.changes[api.ConfigChangeType.reload]) {
logger.event(
`config ${data.changes[api.ConfigChangeType.reload].join(
', ',
)} changed, restart server...`,
);
api.restartServer();
return;
}
await api.service.resolveConfig();
if (data.changes[api.ConfigChangeType.regenerateTmpFiles]) {
logger.event(
`config ${data.changes[
api.ConfigChangeType.regenerateTmpFiles
].join(', ')} changed, regenerate tmp files...`,
);
await generate({ isFirstTime: false });
}
for await (const fn of data.fns) {
await fn();
}
},
}),
);
// watch plugin change
const pluginFiles: string[] = [
join(api.cwd, 'plugin.ts'),
join(api.cwd, 'plugin.js'),
];
pluginFiles.forEach((filePath: string) => {
watch({
path: filePath,
addToUnWatches: true,
onChange() {
logger.event(`${basename(filePath)} changed, restart server...`);
api.restartServer();
},
});
});
// watch public dir change and restart server
function watchPublicDirChange() {
const publicDir = join(api.cwd, 'public');
const isPublicAvailable =
existsSync(publicDir) && readdirSync(publicDir).length;
let restarted = false;
const restartServer = () => {
if (restarted) return;
restarted = true;
logger.event(`public dir changed, restart server...`);
api.restartServer();
};
watch({
path: publicDir,
addToUnWatches: true,
onChange(event, path) {
if (isPublicAvailable) {
// listen public dir delete event
if (event === 'unlinkDir' && path === publicDir) {
restartServer();
} else if (
// listen public files all deleted
event === 'unlink' &&
existsSync(publicDir) &&
readdirSync(publicDir).length === 0
) {
restartServer();
}
} else {
// listen public dir add first file event
if (
event === 'add' &&
existsSync(publicDir) &&
readdirSync(publicDir).length === 1
) {
restartServer();
}
}
},
});
}
watchPublicDirChange();
// start dev server
const beforeMiddlewares = await api.applyPlugins({
key: 'addBeforeMiddlewares',
initialValue: [],
});
const middlewares = await api.applyPlugins({
key: 'addMiddlewares',
initialValue: [],
});
const {
babelPreset,
beforeBabelPlugins,
beforeBabelPresets,
extraBabelPlugins,
extraBabelPresets,
} = await getBabelOpts({ api });
const chainWebpack = async (memo: any, args: Object) => {
await api.applyPlugins({
key: 'chainWebpack',
type: api.ApplyPluginsType.modify,
initialValue: memo,
args,
});
};
const modifyWebpackConfig = async (memo: any, args: Object) => {
return await api.applyPlugins({
key: 'modifyWebpackConfig',
initialValue: memo,
args,
});
};
const modifyViteConfig = async (memo: any, args: Object) => {
return await api.applyPlugins({
key: 'modifyViteConfig',
initialValue: memo,
args,
});
};
const debouncedPrintMemoryUsage = lodash.debounce(printMemoryUsage, 5000);
let srcCodeCache: LazySourceCodeCache | undefined;
let startBuildWorker: (deps: any[]) => Worker = (() => {}) as any;
if (api.config.mfsu?.strategy === 'eager') {
srcCodeCache = new LazySourceCodeCache({
cwd: api.paths.absSrcPath,
cachePath: join(
api.paths.absNodeModulesPath,
'.cache',
'mfsu',
'mfsu_v4',
),
});
if (api.appData.framework === 'vue') {
await srcCodeCache!.initWithScan();
} else {
const files = getProjectFileList(api);
await srcCodeCache!.init(files);
}
addUnWatch(() => {
srcCodeCache!.unwatch();
});
let currentWorker: Worker | null = null;
const initWorker = () => {
currentWorker = new Worker(
join(__dirname, 'depBuildWorker/depBuildWorker.js'),
);
currentWorker.on('exit', () => {
initWorker();
});
return currentWorker;
};
currentWorker = initWorker();
startBuildWorker = () => {
return currentWorker!;
};
}
const entry = await api.applyPlugins({
key: 'modifyEntry',
initialValue: {
umi: join(api.paths.absTmpPath, 'umi.ts'),
},
});
const opts: any = {
config: api.config,
pkg: api.pkg,
cwd: api.cwd,
rootDir: process.cwd(),
entry,
port: api.appData.port,
host: api.appData.host,
ip: api.appData.ip,
...(enableVite
? { modifyViteConfig }
: { babelPreset, chainWebpack, modifyWebpackConfig }),
beforeBabelPlugins,
beforeBabelPresets,
extraBabelPlugins,
extraBabelPresets,
beforeMiddlewares: ([] as RequestHandler[]).concat([
...beforeMiddlewares,
]),
// vite 模式使用 ./plugins/ViteHtmlPlugin.ts 处理
afterMiddlewares: enableVite
? [middlewares.concat(faviconMiddleware)]
: middlewares.concat([
...(api.config.mpa ? [] : [createRouteMiddleware({ api })]),
// 放置 favicon 在 webpack middleware 之后,兼容 public 目录下有 favicon.ico 的场景
// ref: https://github.com/umijs/umi/issues/8024
faviconMiddleware,
]),
onDevCompileDone(opts: any) {
debouncedPrintMemoryUsage;
// debouncedPrintMemoryUsage();
api.appData.bundleStatus.done = true;
api.applyPlugins({
key: 'onDevCompileDone',
args: opts,
});
},
onProgress(opts: any) {
api.appData.bundleStatus.progresses = opts.progresses;
},
onMFSUProgress(opts: any) {
api.appData.mfsuBundleStatus = {
...api.appData.mfsuBundleStatus,
...opts,
};
},
mfsuWithESBuild: api.config.mfsu?.esbuild,
mfsuStrategy: api.config.mfsu?.strategy,
cache: {
buildDependencies: [
api.pkgPath,
api.service.configManager!.mainConfigFile || '',
].filter(Boolean),
},
srcCodeCache,
mfsuInclude: lodash.union([
...MFSU_EAGER_DEFAULT_INCLUDE,
...(api.config.mfsu?.include || []),
]),
startBuildWorker,
onBeforeMiddleware(app: any) {
api.applyPlugins({
key: 'onBeforeMiddleware',
args: {
app,
},
});
},
};
await api.applyPlugins({
key: 'onBeforeCompiler',
args: { compiler: enableVite ? 'vite' : 'webpack', opts },
});
if (enableVite) {
await bundlerVite.dev(opts);
} else if (process.env.OKAM) {
require('@umijs/bundler-webpack/dist/requireHook');
const { dev } = require(process.env.OKAM);
await dev(opts);
} else {
await bundlerWebpack.dev(opts);
}
},
});
api.modifyAppData(async (memo) => {
memo.port = await portfinder.getPortPromise({
port: parseInt(String(process.env.PORT || DEFAULT_PORT), 10),
});
memo.host = process.env.HOST || DEFAULT_HOST;
memo.ip = address.ip();
return memo;
});
api.registerMethod({
name: 'restartServer',
fn() {
logger.info(`Restart dev server with port ${api.appData.port}...`);
unwatch();
process.send?.({
type: 'RESTART',
payload: {
port: api.appData.port,
},
});
},
});
api.modifyViteConfig((viteConfig) => {
viteConfig.plugins?.push(ViteHtmlPlugin(api));
return viteConfig;
});
};