File size: 2,531 Bytes
1e92f2d
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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
// Source: https://github.com/mondaychen/devtools-ignore-webpack-plugin/blob/e35ce41d9606a92a455ef247f509a1c2ccab5778/src/index.ts

// eslint-disable-next-line import/no-extraneous-dependencies -- this is a dev-only file
const webpack = require('@rspack/core')

// Following the naming conventions from
// https://tc39.es/source-map/#source-map-format
const IGNORE_LIST = 'ignoreList'
const PLUGIN_NAME = 'devtools-ignore-plugin'
function defaultShouldIgnorePath(path) {
  return path.includes('/node_modules/') || path.includes('/webpack/')
}
function defaultIsSourceMapAsset(name) {
  return name.endsWith('.map')
}

/**
 * This plugin adds a field to source maps that identifies which sources are
 * vendored or runtime-injected (aka third-party) sources. These are consumed by
 * Chrome DevTools to automatically ignore-list sources.
 */
module.exports = class DevToolsIgnorePlugin {
  options
  constructor(options = {}) {
    this.options = {
      shouldIgnorePath: options.shouldIgnorePath ?? defaultShouldIgnorePath,
      isSourceMapAsset: options.isSourceMapAsset ?? defaultIsSourceMapAsset,
    }
  }
  apply(compiler) {
    const { RawSource } = compiler.webpack.sources
    compiler.hooks.compilation.tap(PLUGIN_NAME, (compilation) => {
      compilation.hooks.processAssets.tap(
        {
          name: PLUGIN_NAME,
          stage: webpack.Compilation.PROCESS_ASSETS_STAGE_DEV_TOOLING,
          additionalAssets: true,
        },
        (assets) => {
          for (const [name, asset] of Object.entries(assets)) {
            // Instead of using `asset.map()` to fetch the source maps from
            // SourceMapSource assets, process them directly as a RawSource.
            // This is because `.map()` is slow and can take several seconds.
            if (!this.options.isSourceMapAsset(name)) {
              // Ignore non source map files.
              continue
            }
            const mapContent = asset.source().toString()
            if (!mapContent) {
              continue
            }
            const sourcemap = JSON.parse(mapContent)
            const ignoreList = []
            for (const [index, path] of sourcemap.sources.entries()) {
              if (this.options.shouldIgnorePath(path)) {
                ignoreList.push(index)
              }
            }
            sourcemap[IGNORE_LIST] = ignoreList
            compilation.updateAsset(
              name,
              new RawSource(JSON.stringify(sourcemap))
            )
          }
        }
      )
    })
  }
}