https://github.com/uzzu/danger-checkstyle-plugin
Checkstyle plugin for Danger Kotlin will be available when Danger Kotlin using Kotlin 1.4 is released.
https://github.com/uzzu/danger-checkstyle-plugin
Last synced: 5 months ago
JSON representation
Checkstyle plugin for Danger Kotlin will be available when Danger Kotlin using Kotlin 1.4 is released.
- Host: GitHub
- URL: https://github.com/uzzu/danger-checkstyle-plugin
- Owner: uzzu
- License: apache-2.0
- Archived: true
- Created: 2020-08-16T07:22:09.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2020-10-22T04:04:05.000Z (over 5 years ago)
- Last Synced: 2023-06-29T15:36:22.598Z (almost 3 years ago)
- Language: Kotlin
- Homepage:
- Size: 118 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
[![Coding Style][ktlint-img]][ktlint] [![Released Version][maven-img]][maven]
# danger-checkstyle-plugin
A [Danger Kotlin](https://github.com/danger/kotlin) plugin for reporting [checkstyle](https://checkstyle.org/) result.
## Setup
- [Install Danger Kotlin](https://github.com/danger/kotlin#setup)
- Add the following dependency in your `Dangerfile.df.kts` :
```kotlin
@file:DependsOn("co.uzzu.danger.plugins:checkstyle:0.2.0")
```
- Register plugin and then write script to report your checkstyle result.
```kotlin
import co.uzzu.danger.plugins.checkstyle.CheckStyle
import systems.danger.kotlin.Danger
import systems.danger.kotlin.register
register plugin CheckStyle
// :
```
## Examples
### Simple use
```kotlin
@file:DependsOn("co.uzzu.danger.plugins:checkstyle:0.2.0")
import co.uzzu.danger.plugins.checkstyle.CheckStyle
import systems.danger.kotlin.Danger
import systems.danger.kotlin.register
register plugin CheckStyle
val d = Danger(args)
CheckStyle.report("path/to/checkstyle_result.xml")
```
### Use with glob matcher
```kotlin
@file:DependsOn("co.uzzu.danger.plugins:checkstyle:0.2.0")
import co.uzzu.danger.plugins.checkstyle.CheckStyle
import systems.danger.kotlin.Danger
import systems.danger.kotlin.register
register plugin CheckStyle
val d = Danger(args)
CheckStyle.report("glob:**/path/to/*check_result.xml")
```
### Use with configuration block
```kotlin
@file:DependsOn("co.uzzu.danger.plugins:checkstyle:0.2.0")
import co.uzzu.danger.plugins.checkstyle.CheckStyle
import systems.danger.kotlin.Danger
import systems.danger.kotlin.register
register plugin CheckStyle
val d = Danger(args)
CheckStyle.report {
// Set configuration properties
// :
// [Required] Set path to checkstyle result file.
path = "path/to/checkstyle_result.xml"
}
```
## Configuration
You can customize reporting styles as you needed by using configuration scope.
The CheckStyle plugin object also has same properties, and these properties are used as default of configuration scope.
### reporter
Determinate the reporting style. You can choose the following reporter.
#### Inline
Report as inline comment
You can choose reporting method `MESSAGE`, `WARN`, and `FAIL` .
```kotlin
import co.uzzu.danger.plugins.checkstyle.Inline
import co.uzzu.danger.plugins.checkstyle.ReportMethod.*
CheckStyle.reporter = Inline // reporterMethod = ERROR is used by default.
CheckStyle.reporter = Inline { reportMethod = WARN }
```
#### Markdown
Report as message with the Markdown format.
```kotlin
import co.uzzu.danger.plugins.checkstyle.Markdown
CheckStyle.reporter = Markdown // label = "Checkstyle" is used by default.
CheckStyle.reporter = Markdown { label = "My checkstyle" }
```
### severities
Determinate list of the checkstyle severities(`ERROR`, `IGNORE`, `INFO`, `WARNING` ) to report.
Only `ERROR` is reported by default.
```kotlin
import co.uzzu.danger.plugins.checkstyle.Severity.*
CheckStyle.severities = listOf(ERROR, IGNORE, INFO, WARNING)
```
### basePath
Determinate base of check style result file path.
The working directory is used by default.
```kotlin
CheckStyle.basePath = "path/to/your/base/directory"
```
## License
[Apache 2.0 License](LICENSE.txt)
[ktlint-img]: https://img.shields.io/badge/code%20style-%E2%9D%A4-FF4081.svg
[ktlint]: https://ktlint.github.io/
[maven-img]: https://img.shields.io/maven-central/v/co.uzzu.danger.plugins/checkstyle.svg?maxAge=2000
[maven]: https://search.maven.org/search?q=g:co.uzzu.danger.plugins