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!: makes entries in 'cycle' contain more information (BREAKING for API users) #888

Merged
merged 14 commits into from Dec 17, 2023

Conversation

sverweij
Copy link
Owner

@sverweij sverweij commented Dec 16, 2023

Description

  • makes getCycle to emit richer content - both a name and dependencyTypes for now, instead of a string.

This is a breaking change on the API only - rules keep the same interface and behavior.

Motivation and Context

So we can define rules on the additional attributes - prerequisite to fixing #695

How Has This Been Tested?

  • green ci
  • 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)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change) - on the API only.

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 changed the title feat(graph-utl): makes getCycle emit richer content feat(graph-utl)!: makes getCycle emit richer content (BREAKING for API users) Dec 17, 2023
@sverweij sverweij changed the title feat(graph-utl)!: makes getCycle emit richer content (BREAKING for API users) feat!: makes entries in 'cycle' contain more information (BREAKING for API users) Dec 17, 2023
so we can use this for reaches/ reachable chains as well might the need arise
Copy link

codeclimate bot commented Dec 17, 2023

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

View more on Code Climate.

@sverweij sverweij merged commit c6421e3 into main Dec 17, 2023
9 checks passed
@sverweij sverweij deleted the feature/enrich-the-cycle-output branch December 17, 2023 19:42
sverweij added a commit that referenced this pull request Dec 25, 2023
…BREAKING for API users) (#895)

## Description

- Same as #888, but for the path detection algorithm underlying
'reaches' and 'reachable' rules

The addition to the _rule_ will be in a separate PR

## Motivation and Context

- fixing #763 - this PR is a prerequisite to implement the feature
requested in there
- feature parity with similar restrictions on cycles

## How Has This Been Tested?

- [x] green ci
- [x] updated automated regression tests
- [x] dog-fooding on dependency-cruiser

## 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] 📖

  - My change doesn't require a documentation update, or ...
  - it _does_ and I have updated it

- [x] ⚖️
- The contribution will be subject to [The MIT
license](https://github.com/sverweij/dependency-cruiser/blob/main/LICENSE),
and I'm OK with that.
  - The contribution is my own original work.
- I am ok with the stuff in
[**CONTRIBUTING.md**](https://github.com/sverweij/dependency-cruiser/blob/main/.github/CONTRIBUTING.md).
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.

None yet

1 participant