A Danger plugin for displaying SwiftLint issues in your PR
Ruby
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
spec
.gitignore
.travis.yml
Gemfile
LICENSE
README.md
Rakefile
configure
danger-swiftlint.gemspec

README.md

swiftlint

Surface your SwiftLint JSON report in pull requests. If no report exists, one will be created using the existing SwiftLint install. Results are displayed in a markdown table.

Run report
# Runs SwiftLint if necessary and processes the report using the default settings
swiftlint.report
Run a report with a specific report file
# Assumes your path starts in the present directory
swiftlint.report 'path/to/report.json'
Run a report, ignoring warnings
swiftlint.enabled_types = [:error]
swiftlint.report
Run a report, defining custom warning emoji
swiftlint.issue_emoji[:warning] = '❓'
swiftlint.report

Attributes

enabled_types - Allows you to set which issue types are displayed. Defaults to [:warning", :error]

issue_emoji - Allows configuration of which emoji is shown for an issue type. Defaults to {:warning: '⚠', :error: '❌'}

Methods

report - Lint an existing report or have one generated. Will fail if swiftlint is not installed. Generates a markdown list of warnings and errors from the JSON report, linking to each issue's line in the PR. Does nothing when there are no valid issues to raise.

swiftlint_installed? - Determine if swiftlint is currently installed in the system paths.