https://github.com/reviewdog/action-remark-lint

Run remark-lint with Reviewdog :dog:
https://github.com/reviewdog/action-remark-lint

annotations docker gh-action github-actions github-actions-docker linter markdown remark-lint reviewdog

Last synced: 3 days ago
JSON representation

Run remark-lint with Reviewdog :dog:

• Host: GitHub
• URL: https://github.com/reviewdog/action-remark-lint
• Owner: reviewdog
• License: mit
• Created: 2020-01-25T03:09:19.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-09-16T14:29:10.000Z (11 days ago)
• Last Synced: 2024-09-19T17:02:03.950Z (8 days ago)
• Topics: annotations, docker, gh-action, github-actions, github-actions-docker, linter, markdown, remark-lint, reviewdog
• Language: Shell
• Homepage: https://github.com/reviewdog/reviewdog
• Size: 219 KB
• Stars: 5
• Watchers: 28
• Forks: 9
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Reviewdog/action-remark-lint GitHub Action

[![Test](https://github.com/reviewdog/action-remark-lint/workflows/Test/badge.svg)](https://github.com/reviewdog/action-remark-lint/actions?query=workflow%3ATest)

[![reviewdog](https://github.com/reviewdog/action-remark-lint/workflows/reviewdog/badge.svg)](https://github.com/reviewdog/action-remark-lint/actions?query=workflow%3Areviewdog)

[![depup](https://github.com/reviewdog/action-remark-lint/workflows/depup/badge.svg)](https://github.com/reviewdog/action-remark-lint/actions?query=workflow%3Adepup)

[![release](https://github.com/reviewdog/action-remark-lint/workflows/release/badge.svg)](https://github.com/reviewdog/action-remark-lint/actions?query=workflow%3Arelease)

[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/reviewdog/action-remark-lint?logo=github&sort=semver)](https://github.com/reviewdog/action-remark-lint/releases)

[![action-bumpr supported](https://img.shields.io/badge/bumpr-supported-ff69b4?logo=github&link=https://github.com/haya14busa/action-bumpr)](https://github.com/haya14busa/action-bumpr)

![action screenshot](https://user-images.githubusercontent.com/17570430/102060312-4ee5e000-3df2-11eb-8c82-767afeccd8db.png)

![action screenshot](https://user-images.githubusercontent.com/17570430/102059912-d3842e80-3df1-11eb-9b0a-2e04eab5e294.png)

This action runs [remark-lint](https://github.com/remarkjs/remark-lint) with [reviewdog](https://github.com/reviewdog/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](https://github.com/remarkjs/remark-lint) linter.

```yml

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](https://github.com/remarkjs/remark/tree/HEAD/packages/remark-cli)).

## Inputs

### `github_token`

**Optional**. The [GITHUB_TOKEN](https://docs.github.com/en/free-pro-team@latest/actions/reference/authentication-in-a-workflow). 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](https://github.com/remarkjs/remark-lint). 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](https://github.com/reviewdog/action-suggester). You can find examples of how this is done can be found in [rickstaa/action-remark-lint](https://github.com/rickstaa/action-remark-lint/)