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.

Sign up for GitHub

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

Jump to bottom

Update dependency com.lemonappdev:konsist to v0.17.0 #381

Merged
merged 1 commit into from
Nov 26, 2024
Merged

Update dependency com.lemonappdev:konsist to v0.17.0 #381

merged 1 commit into from
Nov 26, 2024

Conversation

renovate[bot]
Copy link

@renovate renovate bot commented Nov 26, 2024

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
com.lemonappdev:konsist (source) 0.16.1 -> 0.17.0 age adoption passing confidence

Release Notes

LemonAppDev/konsist (com.lemonappdev:konsist)

v0.17.0

Complete list of changes

First of all we have an exciting news - Konsist is the winner of the Kotlin Foundation Grants Program 2024 🎉.

We have been hearing you feedback, so this update bring many important improvements requested by the community.

This release bring bugs fixes and many API improvements as well as some groundwork for upcoming 1.0.0-Beta1 release.
Overall Kosnist API is quite stable now , so we don’t expect any more major API changes.

Big thanks goes to @​chrisbanes for the contributions.

Key changes

Improvement for Parent References (⚠️Breaking Change)

We enhanced parent references in the API to now support both examining the parent type declaration (enabling Konsist checks for annotations, modifiers, and other declaration properties) and analyzing actual parent usage details (such as inspecting generic type arguments) through separate access methods.

This is best demonstrated with the example:

Konsist
    .classes
    .withName("StringContainer")
    .assertTrue {
        it.parent.sourceDeclaration.hasModifier(KoModifier.PUBLIC) // previously it.parent.hasModifier
    }

This change allows to verify parent generic type arguments (parent use site).

Konsist
    .classes
    .withName("StringContainer")
    .assertTrue {
        it.typeArguments.flattern().contains { it.name == "String" }
    }
Added Support for Generic Type Arguments

This release bring top requested feature - support for generic types. Generic type parameters and type arguments can be now verified with Konsist.

Check Verifying Generics documentation page.

Source Declaration (⚠️Breaking Change)

API around source declarations has been unified. From property declaration, function declaration, function return type, parent
declaration, etc. it's possible to can access sourceDeclaration (declaration site) to get the actual type and verify it.

In this example we are checking if type of current property is a class declaration with internal modifier:

// Snippet
internal class Engine

val current: Engine? = null // testing this in below test

// Konsist test
Konsist
   .scopeFromProject()
   .properties
   .assertTrue {
      it.type?.sourceDeclaration?.asClassDeclaration()?.hasInnerModifier // true
   }

Note that explicit casting (asXDeclaration) has to be used to access specific properties of the declaration.

Due to updated API, some methods have been deprecated. For example, asClassDeclaration has been "moved to sourceDeclaration`:

Konsist
   .scopeFromProject()
   .functions()
   .returnTypes
   .assertTrue {
      it.asClassDeclaration() // Deprecated
         ?.hasPrivateModifier
   }
Konsist
   .scopeFromProject()
   .functions()
   .returnTypes
   .assertTrue {
      it.sourceDeclaration()
      ?.asClassDeclaration()
      ?.hasPrivateModifier
}
Improved Kotlin Backwards Compatibility

Konsist has been updated to ensure backward compatibility with Kotlin 1.8. This enhancement enables developers to integrate Konsist
into projects that haven't yet upgraded to the latest Kotlin version. By supporting Kotlin 1.8, Konsist can now be utilized in a wider
range of codebases, including those maintaining older Kotlin versions for various reasons. From now on Konsist should be compatible with
at least 3 most recent releases of Kotlin (does not take path releases into consideration). We will also slow down with updating minor
version of Kotlin to boost compatibility even more.

Language Reference Link

The Konsist Language reference was added.

API Improvements

Added isExtension:

// Snippet
fun String.sampleFunction() {}

// Konsist test
    Konsist
        .scopeFromProject()
        .functions()
        .assertTrue {
            it.isExtension shouldBeEqualTo true // true
        }

... and more.

Updated Architecture Assertions
  • Reimplemented assertArchitecture to fix few bugs.
  • Error handling has been improved to cover more edge cases for invalid architecture check configurations.
  • We have added new methods and improved validation and messaging around errors:
'Domain' layer does not depends on 'Presentation' layer failed. Files that depend on 'Presentation' layer:
	└──file /Users/igorwojda/domain/MyUseCase.kt
		├── import presentation.MyView.kt
		└── import presentation.MyUiState.kt

A new include() method was added to include layers in architecture verification, without defining a dependency.

private val domain = Layer("Domain",  "com.domain..")
private val presentation = Layer("Presentation", "com..presentation..")

Konsist
    .scopeFromProject()
    scope.assertArchitecture {
        presentation.include() // Include layer without defining a dependency
        domain.doesOnNothing()
    }
}
What's Next

We will now focus on adding baseline and processing community feedback.

Complete List Of Changes

⚠️ Breaking API Changes
🐛 API Bug Fixes
💡 API Improvements
💡 Improvements
📕 Documentation
🏗️ Maintenance

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.

  • If you want to rebase/retry this PR, check this box

This PR was generated by Mend Renovate. View the repository job log.

@mrmans0n mrmans0n merged commit 22df0f8 into main Nov 26, 2024
2 checks passed
@mrmans0n mrmans0n deleted the renovate/com.lemonappdev-konsist-0.x branch November 26, 2024 06:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@mrmans0n