Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: adds skipAnalysisNotInRules option #979

Merged
merged 9 commits into from
Jan 7, 2025

Conversation

sverweij
Copy link
Owner

@sverweij sverweij commented Jan 4, 2025

Description

  • adds a skipAnalysisNotInRules option that, when switched to true skips all analyses not necessary for checking the current rule set.
  • Defaults the option to false for backwards compatibility of both cli and api.
  • Add this option with the value true to the --init template that scaffolds initial .dependency-cruiser.js configurations
  • Takes the new option into account in the cache-dirty check
  • Adds a paragraph in the options reference

TODO:

  • implement for cycle analysis
  • implement for dependents analysis
  • implement for orphan check

For the focus, metrics and reachables analyses this was already in place by default

Motivation and Context

Addresses #978

How Has This Been Tested?

  • green ci
  • additional and updated automated non-regression tests

Screenshots

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)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist

  • 📖

    • My change doesn't require a documentation update, or ...
    • it does and I have updated it
  • ⚖️

    • 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.

@sverweij sverweij marked this pull request as ready for review January 5, 2025 14:24
@sverweij sverweij force-pushed the feature/skip-unnecessary-derivations branch from 09ffe26 to 4c5b276 Compare January 6, 2025 18:21
Copy link

codeclimate bot commented Jan 6, 2025

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

View more on Code Climate.

Copy link

sonarqubecloud bot commented Jan 6, 2025

@sverweij sverweij merged commit a00d3a0 into main Jan 7, 2025
8 checks passed
@sverweij sverweij deleted the feature/skip-unnecessary-derivations branch January 7, 2025 00:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant