https://github.com/arunvelsriram/ktlint-ruleset-junit
Custom ktlint ruleset for linting JUnit tests.
https://github.com/arunvelsriram/ktlint-ruleset-junit
junit kotlin ktlint
Last synced: 13 days ago
JSON representation
Custom ktlint ruleset for linting JUnit tests.
- Host: GitHub
- URL: https://github.com/arunvelsriram/ktlint-ruleset-junit
- Owner: arunvelsriram
- Created: 2019-10-01T21:15:57.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2019-10-08T19:29:27.000Z (over 5 years ago)
- Last Synced: 2025-03-28T05:31:40.329Z (about 1 month ago)
- Topics: junit, kotlin, ktlint
- Language: Kotlin
- Homepage:
- Size: 72.3 KB
- Stars: 7
- Watchers: 2
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ktlint-ruleset-junit [](https://travis-ci.org/arunvelsriram/ktlint-ruleset-junit)
Custom [ktlint](https://github.com/pinterest/ktlint) ruleset for linting [JUnit](https://junit.org/junit5/) tests.
[Link to bintray](https://bintray.com/arunvelsriram/maven/ktlint-ruleset-junit)
## Rules
`junit-backticked-test-description` - Checks if JUnit test description follows backticks style. For example,
```kotlin
@Test
fun `should add two numbers`() {
assertEquals(3, add(1,2))
}
```
`junit-test-without-assertion` - Checks if JUnit test asserts anything. For example,
```kotlin
@Test
fun `should pass when test body asserts`() {
assertTrue(true)
}
```
## Setup
* Add repository:
```kotlin
repositories {
mavenCentral()
maven {
setUrl("https://dl.bintray.com/arunvelsriram/maven")
}
}
```
* Add dependency:
```kotlin
dependencies {
ktlint("dev.arunvelsriram.ktlint.rulesets.junit:ktlint-ruleset-junit:1.0.0")
}
```
## Contributing
### Development environment
* Install [OpenJDK11](https://adoptopenjdk.net/?variant=openjdk11&jvmVariant=hotspot)
* Install [IntelliJ IDEA](https://www.jetbrains.com/idea/)
### Run test and build:
```bash
./gradlew clean build
```
### Release to [bintray](https://bintray.com)
* Add a Git tag for the release
* Update project version in [build.gradle.kts](./build.gradle.kts) and run:
```bash
./gradlew bintrayUpload
```