feature(*): emit circular paths

[sverweij]

Description

• exposes detected circular paths to reporters
• shows circular paths in the err, err-long, err-html and teamcity reporters

Motivation and Context

• Various requests both off line and on line (Feature request: Option to show full path to reachable and circular dependencies #191, Support for circular dependency checks #5)
• Adds a new way to trace what the cycle is, beyond the graphical output formats. Especially if there's a lot of circular dependencies, this might be helpful in communication & fixing

How Has This Been Tested?

• additional unit tests
• adapted automated integration tests
• automated non-regression tests

Screenshots

err-html (browser)

err (console)

err-long (console)

teamcity

##teamcity[inspectionType id='no-circular' name='no-circular' description='This dependency is part of a circular relationship. You might want to revise your solution (i.e. use dependency inversion, make sure the modules have a single responsibility) ' category='dependency-cruiser' flowId='6300761164' timestamp='2019-10-05T07:26:32.436']
##teamcity[inspection typeId='no-circular' message='src/some/folder/nested/center.js -> src/some/folder/loop-a.js -> src/some/folder/loop-b.js -> src/some/folder/nested/center.js' file='src/some/folder/nested/center.js' SEVERITY='ERROR' flowId='6300761164' timestamp='2019-10-05T07:26:32.437']
##teamcity[inspection typeId='no-circular' message='src/some/folder/loop-a.js -> src/some/folder/loop-b.js -> src/some/folder/nested/center.js -> src/some/folder/loop-a.js' file='src/some/folder/loop-a.js' SEVERITY='ERROR' flowId='6300761164' timestamp='2019-10-05T07:26:32.437']
##teamcity[inspection typeId='no-circular' message='src/some/folder/loop-b.js -> src/some/folder/nested/center.js -> src/some/folder/loop-a.js -> src/some/folder/loop-b.js' file='src/some/folder/loop-b.js' SEVERITY='ERROR' flowId='6300761164' timestamp='2019-10-05T07:26:32.437']

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• Refactor (non-breaking change which fixes an issue without changing functionality)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)

Checklist

• The code I add will be subject to The MIT license, and I'm OK with that.
• The code I've added is my own original work.
• My code follows the code style of this project.
• I have read the CONTRIBUTING document.
• I have added tests to cover my changes.
• All new and existing tests passed.

[lgtm-com]

This pull request fixes 57 alerts when merging c7bf7ee into 6d8b353 - view on LGTM.com

fixed alerts:

• 57 for Unused variable, import, function or class

[codeclimate]

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

The test coverage on the diff in this pull request is 100.0% (99% is the threshold).

This pull request will bring the total coverage in the repository to 99.9% (0.0% change).

View more on Code Climate.