Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Adds docs for missing inputs in README.md #37

Merged
merged 1 commit into from
Mar 29, 2023
+10 −0
Merged

Adds docs for missing inputs in README.md #37

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,16 @@ Optional. Runs checks against the baseline file provided.
Optional. Defines the [ktlint](https://ktlint.github.io/) version to use.
The default value is `latest`.

### `name`

Optional. Reviewdog report name. See [checkstyle-format](https://github.com/reviewdog/reviewdog/tree/master#checkstyle-format) for details.
The default value is `ktlint`.

### `file_glob`

Optional. Defines a file glob to identify files to be checked.
The default value is an empty string.

## Example usage

```yml
Expand Down