-
Notifications
You must be signed in to change notification settings - Fork 593
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Detect and handle webpack module cycles
- Loading branch information
1 parent
e0e01c5
commit 9308d44
Showing
5 changed files
with
113 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,92 @@ | ||
| /* eslint-env node */ | ||
| import * as webpack from 'webpack'; | ||
| import * as path from 'path'; | ||
| import * as fs from 'fs'; | ||
| import * as moment from 'moment'; | ||
| import * as CircularDependencyPlugin from 'circular-dependency-plugin'; | ||
|
|
||
| type PresetOptions = { | ||
| exclude: RegExp; | ||
| maxCyclesAllowed: number; | ||
| reportFile: string; | ||
| }; | ||
|
|
||
| type DetectedCycle = { | ||
| // webpack module record that caused the cycle | ||
| causedBy: string; | ||
| // relative module paths that make up the cycle | ||
| modulePaths: string[]; | ||
| }; | ||
|
|
||
| export class CircularDependencyPreset { | ||
| private readonly HandleCyclesPluginName = 'HandleCyclesPlugin'; | ||
|
|
||
| constructor(private readonly options: PresetOptions) {} | ||
|
|
||
| private getCycleReport(cycles: DetectedCycle[], compilation: webpack.compilation.Compilation) { | ||
| const hash = compilation.getStats().hash; | ||
| const builtAt = moment(compilation.getStats().endTime).format('MM/DD/YYYY HH:mm:ss'); | ||
|
|
||
| const countByDir = cycles | ||
| .map((c) => c.modulePaths[0].replace(/\/.*$/, '')) | ||
| .reduce((acc, dir) => { | ||
| acc[dir] = (acc[dir] ?? 0) + 1; | ||
| return acc; | ||
| }, {} as { [key: string]: number }); | ||
|
|
||
| const header = | ||
| `# webpack compilation ${hash} built at ${builtAt}\n` + | ||
| '# this file is auto-generated on every webpack development build\n'; | ||
|
|
||
| const stats = | ||
| `# ${cycles.length} total cycles: ${Object.keys(countByDir) | ||
| .map((d) => `${d} (${countByDir[d]})`) | ||
| .join(', ')}\n` + | ||
| `# ${ | ||
| cycles.filter((c) => c.modulePaths.length === 3).length | ||
| } minimal-length cycles (A -> B -> A)\n`; | ||
|
|
||
| const entries = cycles.map((c) => `${c.causedBy}\n${c.modulePaths.join('\n-> ')}\n`).join('\n'); | ||
|
|
||
| return [header, stats, entries].join('\n'); | ||
| } | ||
|
|
||
| apply(plugins: webpack.Plugin[]) { | ||
| const cycles: DetectedCycle[] = []; | ||
|
|
||
| plugins.push( | ||
| new CircularDependencyPlugin({ | ||
| exclude: this.options.exclude, | ||
| onDetected: ({ module: { resource }, paths: modulePaths }) => { | ||
| cycles.push({ causedBy: resource, modulePaths }); | ||
| }, | ||
| }), | ||
| { | ||
| // Ad-hoc plugin to handle detected module cycle information | ||
| apply: (compiler) => { | ||
| compiler.hooks.emit.tap(this.HandleCyclesPluginName, (compilation) => { | ||
| if (cycles.length === 0) { | ||
| return; | ||
| } else { | ||
| console.log(`detected ${cycles.length} cycles`); | ||
| } | ||
|
|
||
| const maxCycles = this.options.maxCyclesAllowed; | ||
| const reportPath = path.resolve(__dirname, this.options.reportFile); | ||
|
|
||
| fs.writeFileSync(reportPath, this.getCycleReport(cycles, compilation)); | ||
| console.log(`module cycle report written to ${reportPath}`); | ||
|
|
||
| if (cycles.length > maxCycles) { | ||
| compilation.errors.push( | ||
| new Error( | ||
| `${this.HandleCyclesPluginName}: number of cycles (${cycles.length}) exceeds configured threshold (${maxCycles})`, | ||
| ), | ||
| ); | ||
| } | ||
| }); | ||
| }, | ||
| }, | ||
| ); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters