Reviewdog/action-remark-lint GitHub Action

This action runs remark-lint with reviewdog on pull requests to improve code review experience.

Quick start

In its simplest form, this (composite) action can be used to annotate the changes that are suggested by the remark-lint linter.

name: reviewdog
on: [pull_request]
jobs:
  remark-lint:
    name: runner / remark-lint
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: install remark presets
        run: npm install remark-preset-lint-recommended
        shell: bash
      - name: remark-lint
        uses: reviewdog/action-remark-lint@v5
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          reporter: github-pr-check

Remark presets are also installed when they are specified them in the dependencies field of the package.json while the install_deps flag is enabled. This github action also works with remark-lint configuration files (see the remark-lint documentation).

Inputs

github_token

Optional. The GITHUB_TOKEN. Must be in form of github_token: ${{ secrets.github_token }}. Defaults to ${{ github.token }}.

workdir

Optional. The directory to run remark-lint in. Defaults to ..

remark_args

Optional. Additional remark-lint input arguments. Defaults to "--use=remark-preset-lint-recommended". Default is applied programmatically when no input or config file is found.

install_deps

Optional. Install npm dependencies (i.e. dependencies specified in the package.json). Defaults to true.

annotate

Optional. Annotate remark-lint changes using reviewdog. Defaults to true.

tool_name

Optional. Tool name to use for reviewdog reporter. Defaults to remark-lint.

level

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

reporter

Optional. Reporter of reviewdog command [github-pr-check, github-pr-review, github-check]. Default is github-pr-check.

filter_mode

Optional. Filtering mode for the reviewdog command [added, diff_context, file, nofilter]. Defaults to added.

fail_on_error

Optional. Exit code for when reviewdog when errors are found [true, false]. Defaults to false.

reviewdog_flags

Optional. Additional reviewdog flags. Defaults to "".

Format your code

This action is meant to annotate any possible changes that would need to be made to make your code adhere to the remark-lint linting guidelines. It does not apply these changes to your codebase. If you also want to apply the changes to your repository, you can use the reviewdog/action-suggester. You can find examples of how this is done can be found in rickstaa/action-remark-lint