https://github.com/medly/detekt-extensions
useful detekt extensions
https://github.com/medly/detekt-extensions
detekt extensions immutability kotlin
Last synced: 5 months ago
JSON representation
useful detekt extensions
- Host: GitHub
- URL: https://github.com/medly/detekt-extensions
- Owner: medly
- Created: 2020-05-27T05:59:04.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2021-04-04T12:47:48.000Z (about 5 years ago)
- Last Synced: 2024-05-28T19:14:32.353Z (about 2 years ago)
- Topics: detekt, extensions, immutability, kotlin
- Language: Kotlin
- Homepage: https://github.com/medly/detekt-extensions
- Size: 67.4 KB
- Stars: 2
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# detekt-extensions
This detekt plugin includes custom rules we use at [Medly](https://medly.com)
## Custom Rules
### mutation
**MutationRule**:
Reports usage of mutable variables, collections usages and parameters as code smells
- Mutable variables declared using `var`
- Mutable collections(mutableListOf, mutableSetOf, mutableMapOf)
- Mutable parameters
*Noncompliant Code*:
```
var listOfSquares = mutableListOf()
for(i in 1..10) listOfSquares.add(i * i)
```
*Compliant Code*:
```
val listOfSquares = (1..10).map { it * it }
```
## Usage
- Import detekt as a gradle, as mentioned [here](https://detekt.github.io/detekt/gradle.html).
- Add *jitpack* in your root build.gradle at the end of repositories:
```
allprojects {
repositories {
...
maven { url 'https://jitpack.io' }
}
}
dependencies {
detektPlugins "com.medly:detekt-extensions:v0.0.1"
}
```