Skip to content
This repository has been archived by the owner on Sep 20, 2020. It is now read-only.

DangerJS plugin to read / parse checkstyle XML formatted ktlint reports and post inline comments in Github pull requests.

License

Notifications You must be signed in to change notification settings

damian-burke/danger-plugin-ktlint-report

Repository files navigation

Deprecated by danger-plugin-lint-report

This DangerJS plugin is functional, but no longer being worked on.

Consider switching to danger-plugin-lint-report.

It can parse ktlint reports (and more, for example detekt, Android lint, Swift Lint, ...) as well and offers more configuration options.

danger-plugin-ktlint-report

Build Status npm version semantic-release

This plugin reads ktlint reports and posts inline comments in pull requests.

Screenshot of an inline comment in a GitHub pull request:

inline comment

Requirements

The plugin does not execute ktlint.

Instead, the plugin will search the file tree for ktlint reports and parse them.

At the moment the plugin is searching using the following file mask: **/reports/ktlint/*.xml.

It is limited to XML checkstyle reports.

Usage

Install:

yarn add danger-plugin-ktlint-report --dev

At a glance:

// dangerfile.js
import { schedule } from 'danger'

const ktlintReport = require("danger-plugin-ktlint-report")
schedule(ktlintReport.scan())

Changelog

See the GitHub release history.

Contributing

See CONTRIBUTING.md.

About

DangerJS plugin to read / parse checkstyle XML formatted ktlint reports and post inline comments in Github pull requests.

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published