dependency-cruiser 11.9.0 on Node.js NPM

✨ features

148cde2 feature(report): adds (configurable) markdown reporter (#614)

You can use this e.g. in conjunction with GitHub actions job summaries to make dependency-cruiser's output appear there in a snazzied-up shape.

  # ...
  steps:
  - name: Saving dependency check report to the job summary
     run:  depcruise src --config --output-type markdown >> $GITHUB_STEP_SUMMARY
  # ...

... which then could look something like the example below in its most expanded form. It's possible to only emit parts of it - see the markdown option documentation for details.

Forbidden dependency check - results

📈 Summary

495 modules 1224 dependencies 1 errors 0 warnings 5 informational 0 ignored

rule violations ignored explanation

❕ not-reachable-from-folder-index 3 0 (sample rule to demo reachable rules with capturing groups)
❕ utl-module-not-shared-enough 2 0 (sample rule to demo demo rules based on dependents)
❗ not-unreachable-from-cli 1 0 This module in the src/ tree is not reachable from the cli - and is likely dead wood. Either use it or remove it. If a module is flagged for which it's logical it is not reachable from cli (i.e. a configuration file), add it to the pathNot in the 'to' of this rule.

🔥 All violations

Violations found - click to expand

violated rule from to

❗ not-unreachable-from-cli src/schema/baseline-violations.schema.js src/schema/baseline-violations.schema.js
❕ not-reachable-from-folder-index src/cli/format.js src/cli/format.js
❕ not-reachable-from-folder-index src/cli/tools/wrap-stream-in-html.js src/cli/tools/wrap-stream-in-html.js
❕ not-reachable-from-folder-index src/cli/validate-node-environment.js src/cli/validate-node-environment.js
❕ utl-module-not-shared-enough src/utl/array-util.js src/utl/array-util.js
❕ utl-module-not-shared-enough src/utl/wrap-and-indent.js src/utl/wrap-and-indent.js

dependency-cruiser@11.9.0 / 2022-06-06T17:54:43.948Z

rule	violations	explanation
❕ not-reachable-from-folder-index	3	(sample rule to demo reachable rules with capturing groups)
❕ utl-module-not-shared-enough	2	(sample rule to demo demo rules based on dependents)
❗ not-unreachable-from-cli	1	This module in the src/ tree is not reachable from the cli - and is likely dead wood. Either use it or remove it. If a module is flagged for which it's logical it is not reachable from cli (i.e. a configuration file), add it to the pathNot in the 'to' of this rule.

violated rule	from	to
❗ not-unreachable-from-cli	`src/schema/baseline-violations.schema.js`	`src/schema/baseline-violations.schema.js`
❕ not-reachable-from-folder-index	`src/cli/format.js`	`src/cli/format.js`
❕ not-reachable-from-folder-index	`src/cli/tools/wrap-stream-in-html.js`	`src/cli/tools/wrap-stream-in-html.js`
❕ not-reachable-from-folder-index	`src/cli/validate-node-environment.js`	`src/cli/validate-node-environment.js`
❕ utl-module-not-shared-enough	`src/utl/array-util.js`	`src/utl/array-util.js`
❕ utl-module-not-shared-enough	`src/utl/wrap-and-indent.js`	`src/utl/wrap-and-indent.js`

📖 documentation

b44cfcc doc: clarify when the showMetrics dot reporter attribute works and when it doesn't (#615) - thanks @czlowiek488 for the question that led to this fix
7ad82e3 doc: first step to introduce strict variants of types for internal use (#607)

🐛 fixes

3090ae4 bugfix(mermaid-plugin): replace some meta chars (#613) thanks again to @MH4GF

👷 maintenance

01b4137 style: rename lodash function use to their real names
97ddcb0 chore: adds highlighting configuration for modules 'matching focus'
042be53 refactor(extract): use getExtension instead of endsWith to determine scannability of extensions (#609)
f7d95e8 build(npm): update external dependencies

🔏 shasum: ba3d5cdb800a9a3bb04dc0ede2252d95c96163a0