https://github.com/417-72ki/danger-kotlin-checkstyle_format

Danger-Kotlin plugin for processing checkstyle formatted xml file.
https://github.com/417-72ki/danger-kotlin-checkstyle_format

danger-kotlin danger-plugin kotlin ktlint-gradle

Last synced: 3 months ago
JSON representation

Danger-Kotlin plugin for processing checkstyle formatted xml file.

• Host: GitHub
• URL: https://github.com/417-72ki/danger-kotlin-checkstyle_format
• Owner: 417-72KI
• License: apache-2.0
• Created: 2023-01-04T02:13:19.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-09-23T23:54:38.000Z (4 months ago)
• Last Synced: 2024-10-10T17:12:05.700Z (3 months ago)
• Topics: danger-kotlin, danger-plugin, kotlin, ktlint-gradle
• Language: Kotlin
• Homepage: https://central.sonatype.dev/artifact/io.github.417-72ki/danger-kotlin-checkstyle_format/0.0.1
• Size: 185 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# danger-kotlin-checkstyle_format

![publish](https://github.com/417-72KI/danger-kotlin-checkstyle_format/actions/workflows/publish.yml/badge.svg)

[![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.github.417-72ki/danger-kotlin-checkstyle_format/badge.svg?style=plastic)](https://maven-badges.herokuapp.com/maven-central/io.github.417-72ki/danger-kotlin-checkstyle_format)

[Danger-Kotlin](https://github.com/danger/kotlin) plugin for processing checkstyle formatted xml file.

## Installation

Put

```kotlin

@file:Repository("https://repo.maven.apache.org/maven2/")

@file:DependsOn("io.github.417-72ki:danger-kotlin-checkstyle_format:0.1.0")

```

to the top of your `Dangerfile.df.kts`

## Usage

```kotlin

// Required to register the plugin

register plugin CheckstyleFormat

danger(args) {

    // You should run `./gradlew KtlintCheck` with `checkstyle` reporter before executing `Danger-Kotlin`.

    CheckstyleFormat.reportKtlint()

}

```

See [Dangerfile.df.kts](https://github.com/417-72KI/danger-kotlin-checkstyle_format/blob/main/Dangerfile.df.kts) for more specific usage.