https://github.com/tsuyoshicho/action-textlint

Run textlint with reviewdog on pull requests to improve document writing experience.
https://github.com/tsuyoshicho/action-textlint

reviewdog textlint

Last synced: 3 months ago
JSON representation

Run textlint with reviewdog on pull requests to improve document writing experience.

• Host: GitHub
• URL: https://github.com/tsuyoshicho/action-textlint
• Owner: tsuyoshicho
• License: cc0-1.0
• Created: 2019-09-26T04:30:39.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2024-08-05T12:49:58.000Z (3 months ago)
• Last Synced: 2024-08-05T14:44:05.366Z (3 months ago)
• Topics: reviewdog, textlint
• Language: Shell
• Homepage:
• Size: 981 KB
• Stars: 64
• Watchers: 4
• Forks: 5
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

• project-awesome - tsuyoshicho/action-textlint - Run textlint with reviewdog on pull requests to improve document writing experience. (Shell)

README

        
# GitHub Action: Run textlint with reviewdog

## notice

action-textlint use textlint within npm ecosystem.

## detail

[![Release](https://github.com/tsuyoshicho/action-textlint/workflows/release/badge.svg)](https://github.com/tsuyoshicho/action-textlint/releases)

This action runs [textlint](https://github.com/textlint/textlint) with

[reviewdog](https://github.com/reviewdog/reviewdog) on pull requests to improve

text review experience.

based on [reviewdog/action-vint](https://github.com/reviewdog/action-vint)

[![github-pr-check example](https://user-images.githubusercontent.com/96727/70858620-bdc2fb80-1f48-11ea-9c1a-b5abb5a6566a.png)](https://user-images.githubusercontent.com/96727/70858620-bdc2fb80-1f48-11ea-9c1a-b5abb5a6566a.png)

[![github-pr-review example](https://user-images.githubusercontent.com/96727/70858610-a1bf5a00-1f48-11ea-84c4-7ee7392548e6.png)](https://user-images.githubusercontent.com/96727/70858610-a1bf5a00-1f48-11ea-84c4-7ee7392548e6.png)

Notice:

This action is `composition action`. It need `npm ci`.

You accept below one:

- Your workflow manually setup to run `npm ci`.

- This action automatic run `npm ci`.

## Inputs

### `github_token`

**Required**. Default is `${{ 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-check,github-pr-review].

Default is github-pr-review.

It's same as `-reporter` flag of reviewdog.

github-pr-review can use Markdown and add a link to rule page in reviewdog reports.

### `filter_mode`

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

Default is added.

### `fail_on_error`

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

Default is `false`.

### `reviewdog_flags`

Optional. Additional reviewdog flags

### `textlint_flags`

textlint arguments (i.e. target dir:`doc/*`)

### `package_manager`

Optional. Package manager used in the repository [npm,yarn,pnpm]

Default is `npm`.

## Customizes

`.textlintrc` put in your repo.

And need textlint included in project package.json .

## Example usage

### [.github/workflows/reviewdog.yml](.github/workflows/reviewdog.yml)

```yml

name: reviewdog

on: [pull_request]

jobs:

  textlint:

    name: runner / textlint

    runs-on: ubuntu-latest

    steps:

      - name: Checkout

        uses: actions/checkout@v2

        with:

          submodules: true

      - name: Setup node/npm

        uses: actions/setup-node@v1

        with:

          node-version: '15'

      - name: textlint-github-pr-check

        uses: tsuyoshicho/action-textlint@v3

        with:

          github_token: ${{ secrets.github_token }}

          reporter: github-pr-check

          textlint_flags: "doc/**"

      - name: textlint-github-check

        uses: tsuyoshicho/action-textlint@v3

        with:

          github_token: ${{ secrets.github_token }}

          reporter: github-check

          textlint_flags: "doc/**"

      - name: textlint-github-pr-review

        uses: tsuyoshicho/action-textlint@v3

        with:

          github_token: ${{ secrets.github_token }}

          reporter: github-pr-review

          textlint_flags: "doc/**"

```