https://github.com/huacnlee/autocorrect-action

GitHub action for use AutoCorrect as lint
https://github.com/huacnlee/autocorrect-action

auto-correct autocorrect github-actions linter

Last synced: 2 months ago
JSON representation

GitHub action for use AutoCorrect as lint

• Host: GitHub
• URL: https://github.com/huacnlee/autocorrect-action
• Owner: huacnlee
• License: mit
• Created: 2021-07-19T15:59:13.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2025-04-09T08:53:24.000Z (3 months ago)
• Last Synced: 2025-05-07T13:04:44.820Z (2 months ago)
• Topics: auto-correct, autocorrect, github-actions, linter
• Language: Shell
• Homepage:
• Size: 34.2 KB
• Stars: 11
• Watchers: 3
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# autocorrect-action

GitHub Action to use [AutoCorrect](https://github.com/huacnlee/autocorrect) for lint.

https://github.com/huacnlee/autocorrect



## Usage

```yml

steps:

  - uses: actions/checkout@v4

  - name: AutoCorrect

    uses: huacnlee/autocorrect-action@v2

```

## Use NPM version AutoCorrect

```yml

steps:

  - uses: actions/checkout@v4

  - name: AutoCorrect

    uses: huacnlee/autocorrect-action@v2

    with:

      use_npm: true

```

## Enable ReviewDog for Report

```yml

steps:

  - uses: actions/checkout@v4

  - name: AutoCorrect

    uses: huacnlee/autocorrect-action@v2

  - name: Report ReviewDog

    if: failure()

    uses: huacnlee/autocorrect-action@v2

    env:

      REVIEWDOG_GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}

    with:

      reviewdog: true

```



### Only check changed file by PR

```yml

steps:

  - uses: actions/checkout@v4

  - name: AutoCorrect

    uses: huacnlee/autocorrect-action@v2

    with:

      args: --lint --no-diff-bg-color $(git diff --diff-filter=AM --name-only ${{ github.event.pull_request.base.sha }}}

````