Clarification on `exclude` option

[aackerman]

Clarification on `exclude` option

[aackerman]

onDetected is for advanced usage, you're on your own for everything aside from detection. It's very easy to exclude modules you don't want to see.

new CircularDependencyPlugin({
  onDetected({ module: webpackModuleRecord, paths, compilation }) {
    if (!/(node_modules|bower_components)/.test(webpackModuleRecord.resource)) {
      compilation.errors.push(new Error(paths.join(' -> ')));
    }
  }
})

[j3tan]

Whoops, just realized it is commented in the example. Maybe have separate examples?

[aackerman]

I went ahead and split this up in 4.2.1 to make it even more clear

[oomathias]

Same here, I got confused when defining onDetected.
2 distinct examples would be better for those, like me, who didn't read everything 🤦‍♂️

[vikasraj789]

@aackerman
version: 4.4.0
The issue of exclude option not being honoured when onDetected is available still exists.
Below is the configuration:

new CircularDependencyPlugin({
        exclude: /(node_modules|bower_components)/,
        // `onDetected` is called for each module that is cyclical
        onDetected({ module: webpackModuleRecord, paths, compilation }) {
          // `paths` will be an Array of the relative module paths that make up the cycle
          // `module` will be the module record generated by webpack that caused the cycle
          compilation.errors.push(new Error(paths.join(' -> ')));
        }
      }),

[LoicGombeaud]

First of all, thanks a lot for this module!
Regarding the exclude / onDetected confusion: is there any chance you could also put the exclude logic before onDetected gets fired on version 4 of the module? I know I can do the exclusion manually in onDetected, but it would save a few lines and be cleaner if it was in the dedicated exclude option instead.

[abirmingham]

For posterity - it appears that exclude logic is now executed prior to firing onDetected. I am using [email protected] and saw a reduction in detections by adding exclude: /node_modules/, to the following configuration:

Configuration

        new CircularDependencyPlugin({
            failOnError: true,
            onStart({ compilation }) {
                circularDepCycles = [];
            },
            onDetected({ module: webpackModuleRecord, paths, compilation }) {
                circularDepCycles.push(
                    new Error(
                        `Circular dependency detected:\n${paths.join(' -> ')}`,
                    ),
                );
            },
            onEnd({ compilation }) {
                const count = circularDepCycles.length;
                if (count > MAX_CIRCULAR_DEP_CYCLES) {
                    circularDepCycles
                        .slice(MAX_CIRCULAR_DEP_CYCLES)
                        .forEach(error => {
                            compilation.errors.push(error);
                        });
                    compilation.warnings.push(
                        new Error(
                            `Circular dependency count exceeds allowed ` +
                                `threshold ` +
                                `(${count} > ${MAX_CIRCULAR_DEP_CYCLES})`,
                        ),
                    );
                }
            },
        }),

(Note that I believe that failOnError is ignored here due to the presence of onDetected - it just so happened to be set when I ran these tests)