Allow filtering of full modules tree #282
Closed
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The goal of this PR is enable
dependencyFilter
to filter all modules rather than just a single level from the tree. While trying to be backwards compatible with current implementations as much as possible. Backwards compatibility can't be achieved for those who use a filter withincludeNpm
.Use cases are for example filtering all scoped dependencies, especially if those scoped dependencies depend on other modules within the same scope. Imagine a monorepo where composites are derived from a set of base components within the same monorepo. Technically Madge could be run for each dependency but getting the full import tree would be cumbersome that way.
There are two alternatives to this solution and I'm happy to change the code towards the desired direction.
config.dependencyFilter
overrides the default filter implementation. This provides flexibility but will not be backwards compatible. Anyone using a filter today would need to include the defaults. The default filter could easily be exposed for re-use within custom filters. Personally this would have my preference as its much easier to document, code and keep consistent.includeNpm
to allow for a certain depth ofn
with a default of 1.