https://github.com/cph-cachet/detekt-verify-implementation
A detekt plugin to enable static checking of concrete classes according to annotations on base classes.
https://github.com/cph-cachet/detekt-verify-implementation
dataclass detekt-plugin hacktoberfest immutability kotlin static-analysis
Last synced: 8 days ago
JSON representation
A detekt plugin to enable static checking of concrete classes according to annotations on base classes.
- Host: GitHub
- URL: https://github.com/cph-cachet/detekt-verify-implementation
- Owner: cph-cachet
- License: mit
- Created: 2020-08-12T14:43:35.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-10-28T22:10:06.000Z (6 months ago)
- Last Synced: 2025-03-29T12:46:07.579Z (29 days ago)
- Topics: dataclass, detekt-plugin, hacktoberfest, immutability, kotlin, static-analysis
- Language: Kotlin
- Homepage:
- Size: 119 KB
- Stars: 6
- Watchers: 4
- Forks: 0
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Detekt Plugin: Verify Implementation
[](https://mvnrepository.com/artifact/dk.cachet.detekt.extensions/detekt-verify-implementation)
This is a plugin for [detekt](https://detekt.github.io/detekt/), a static code analyzer for Kotlin,
which enables verifying whether concrete classes are implemented as specified **according to
annotations applied to base types**.
The following detekt rules are included:
- `DataClass`: requires extending classes to be [data classes](https://kotlinlang.org/docs/reference/data-classes.html) or [object declarations](https://kotlinlang.org/docs/object-declarations.html#object-declarations).
This guarantees a predictable default implementation for `equals` and `hashcode` implementations, i.e., value equality instead of referential equality.
- `Immutable`: requires classes or extending classes to be immutable;
they may not contain mutable properties (var) or properties of mutable types (types with var properties).
Due to the nature of this plugin, [a specific flavor of semantic versioning is used which makes more sense for linters](https://stylelint.io/about/semantic-versioning). Any minor update may report more errors than the previous release.
## Enabling the Plugin in Gradle
Load the plugin through the [detekt Gradle configuration block](https://detekt.github.io/detekt/extensions.html#let-detekt-know-about-your-extensions):
_Groovy DSL_
```groovy
detekt {
dependencies {
detektPlugins "dk.cachet.detekt.extensions:detekt-verify-implementation:1.2.5"
}
}
```
Since this plugin uses type resolution, the rules won't run when using the basic `detekt` task.
Use `detektMain` or a custom detekt task, [as per the detekt documentation](https://detekt.dev/type-resolution.html).
## Configuration
By default, the rules are not activated in the [detekt configuration file](https://detekt.github.io/detekt/configurations.html).
To enable a rule, set it to `active` and specify the fully qualified name of the `annotationClass` which determines which concrete classes to verify. For example:
```yaml
verify-implementation:
DataClass:
active: true
annotationClass: "dk.cachet.carp.common.ImplementAsDataClass"
Immutable:
active: true
annotationClass: "dk.cachet.carp.common.Immutable"
```
In case the annotation class cannot be found and the rule is active, an `IllegalStateException` will be thrown.
Using `assumeNoAnnotations`, you can specify a list of fully qualified type names
for which it is assumed they don't have the annotation applied to them.
This may be useful when the plugin fails to analyze classes which are known not to carry the annotation.
```yaml
verify-implementation:
Immutable:
active: true
annotationClass: "dk.cachet.carp.common.Immutable"
assumeNoAnnotations: ['kotlin.Any']
```
Additional rule-specific configuration options are described next.
### Immutable
- `assumeImmutable` can list fully qualified class names which won't be verified and are assumed to be immutable.
This may be useful when the plugin fails to analyze classes which you know to be immutable. Example configuration:
```yaml
verify-implementation:
Immutable:
active: true
annotationClass: "dk.cachet.carp.common.Immutable"
includes: ['**/domain/**']
assumeImmutable: [
'dk.cachet.carp.common.DateTime',
'kotlinx.serialization.json.Json'
]
```