feat!: restructures the via* sub-restrictions to also accept & validate against dependency types (BREAKING for API users) - Githubissues

sverweij / dependency-cruiser

Validate and visualize dependencies. Your rules. JavaScript, TypeScript, CoffeeScript. ES6, CommonJS, AMD.

https://npmjs.com/dependency-cruiser

MIT License

5.16k stars 249 forks source link

feat!: restructures the via* sub-restrictions to also accept & validate against dependency types (BREAKING for API users) #894

Closed sverweij closed 9 months ago

sverweij commented 9 months ago

Description

restructures the via* sub restrictions to also accept & validate against dependency types
deprecates the viaNot and viaSomeNot restrictions in favor of viaOnly.pathNot and via.pathNot restrictions respectively. You could still have them in dependency-cruiser configs, but internally they're rewritten into viaOnly and via rules when possible.

This is a breaking change for the API only

in the input/ rules instead of a string | string[] the via and viaOnly restrictions can now also be an object with path, pathNot, dependencyTypes and dependencyTypesNot attributes
in the cruise result via and viaOnly are only available as that object (in stead of string | string[])
in the cruise result the viaNot and viaSomeNot have disappeared (rules in the input will have been rewritten as via or viaOnly rules).

Motivation and Context

There's a long outstanding and much upvoted request (#695) to be able to exclude e.g. type-only over a whole cycle instead to just the first dependency of the cycle. This PR enables that.

How Has This Been Tested?

[x] green ci
[x] additional automated non-regression tests

Types of changes

[ ] Bug fix (non-breaking change which fixes an issue)
[ ] Documentation only change
[ ] Refactor (non-breaking change which fixes an issue without changing functionality)
[x] New feature (non-breaking change which adds functionality)
[x] Breaking change (fix or feature that would cause existing functionality to change) => for API only

Checklist

[x] :book:
- My change doesn't require a documentation update, or ...
- it does and I have updated it
[x] :balance_scale:
- The contribution will be subject to The MIT license, and I'm OK with that.
- The contribution is my own original work.
- I am ok with the stuff in CONTRIBUTING.md.

codeclimate[bot] commented 9 months ago

Code Climate has analyzed commit 67cf7611 and detected 0 issues on this pull request.

View more on Code Climate.