epmatt/Run Prettier with reviewdog
🐶 Run Prettier with reviewdog to improve code checking, formatting and review experience for your codebase.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| github_token | GITHUB_TOKEN | no | ${{ github.token }} |
| workdir | Working directory relative to the root directory. This is where the action will look for a package.json which declares Prettier as a dependency. Please note that this is different from the directory Prettier will run on, which is defined in the prettier_flags input. Default is `.`. | no | . |
| level | Report level for reviewdog [info,warning,error]. Default is `error`. | no | error |
| reporter | Reporter of reviewdog command [github-check,github-pr-check,github-pr-review]. Default is `github-pr-check`. | no | github-pr-check |
| filter_mode | Filtering mode for the reviewdog command [added,diff_context,file,nofilter]. Default is `added`. | no | added |
| fail_level | If set to `none`, always use exit code 0 for reviewdog. Otherwise, exit code 1 for reviewdog if it finds at least 1 issue with severity greater than or equal to the given level. Possible values: [none,any,info,warning,error] Default is `none`. | — | none |
| fail_on_error | Deprecated, use `fail_level` instead. Exit code for reviewdog when errors are found [true,false]. Default is `false`. | no | false |
| reviewdog_flags | Additional reviewdog flags. Default is ``. | no | "" |
| tool_name | Tool name to use for reviewdog reporter | no | prettier |
| prettier_flags | Flags and args to pass to Prettier. If you override this input, please make sure to append to it the directory which Prettier will run on. The path provided here is relative to the workdir path, provided in the workdir input. Default is `.`, which makes Prettier run on the path provided in the workdir input. | no | . |
Outputs
no outputs