GitHub Action: Run stylelint with reviewdog

This action runs stylelint with reviewdog on pull requests to improve code review experience.

Inputs

`github_token`

Required. Must be in form of github_token: ${{ secrets.github_token }}'.

`level`

Optional. Report level for reviewdog [info,warning,error]. It's same as -level flag of reviewdog.

`reporter`

Reporter of reviewdog command [github-pr-check,github-pr-review,github-check]. Default is github-pr-check. github-pr-review can use Markdown and add a link to rule page in reviewdog reports.

`stylelint_input`

Optional. Files or glob. Default: **/*.css. It's same as [input] of stylelint.

`stylelint_config`

Optional. It's same as --config flag of stylelint.

Example usage

You also need to install stylelint.

# Example
$ npm install stylelint stylelint-config-recommended -D

You can create stylelint config and this action uses that config too.

.github/workflows/reviewdog.yml

name: reviewdog
on: [pull_request]
jobs:
  stylelint:
    name: runner / stylelint
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v1
      - name: stylelint
        uses: reviewdog/action-stylelint@v1
        with:
          github_token: ${{ secrets.github_token }}
          reporter: github-pr-review # Change reporter.
          stylelint_input: '**/*.css'

tadjohnston/action-stylelint

GitHub Action: Run stylelint with reviewdog

Inputs

github_token

level

reporter

stylelint_input