Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add lint-staged and reviewdog #31

Merged
merged 1 commit into from
Jul 24, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
78 changes: 78 additions & 0 deletions .github/workflows/reviewdog.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
name: Auto review with reviewdog

on:
- pull_request

permissions:
contents: read
pull-requests: write

jobs:
textlint:
runs-on: ubuntu-latest
env:
REVIEWDOG_GITHUB_API_TOKEN: ${{ github.token }}
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Detect package manager
id: detect-package-manager
run: |
if [ -f "${{ github.workspace }}/yarn.lock" ]; then
echo "manager=yarn" >> $GITHUB_OUTPUT
echo "command=install" >> $GITHUB_OUTPUT
echo "runner=yarn" >> $GITHUB_OUTPUT
exit 0
elif [ -f "${{ github.workspace }}/package.json" ]; then
echo "manager=npm" >> $GITHUB_OUTPUT
echo "command=ci" >> $GITHUB_OUTPUT
echo "runner=npx --no-install" >> $GITHUB_OUTPUT
exit 0
else
echo "Unable to determine package manager"
exit 1
fi

- name: Setup Node
uses: actions/setup-node@v4
with:
node-version: "20"
cache: ${{ steps.detect-package-manager.outputs.manager }}

- name: Install dependencies
run: ${{ steps.detect-package-manager.outputs.manager }} ${{ steps.detect-package-manager.outputs.command }}

- name: Setup reviewdog
uses: reviewdog/action-setup@v1
with:
reviewdog_version: latest

- name: Fetch base branch
run: git fetch origin ${{github.base_ref}} --depth=1

- name: Run textlint with reviewdog
run: |
git diff -z --diff-filter=ACMR --name-only origin/${{github.base_ref}} HEAD \
| xargs -0 ${{ steps.detect-package-manager.outputs.runner }} textlint --fix || true

git diff -z --diff-filter=ACMR --name-only origin/${{github.base_ref}} HEAD \
| xargs -0 ${{ steps.detect-package-manager.outputs.runner }} textlint -f checkstyle \
| reviewdog -f=checkstyle \
-name=textlint \
-reporter=github-pr-review \
-filter-mode=added \
-fail-on-error=false \
-level=warning

TMPFILE=$(mktemp -p ${{runner.temp}})
git diff > "${TMPFILE}"
git stash -u && git stash drop || true

reviewdog \
-f=diff \
-f.diff.strip=1 \
-name=textlint-fix \
-reporter=github-pr-review \
-filter-mode=diff_context \
-level=warning < "${TMPFILE}"
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,3 +108,10 @@ Lint
```sh
> textlint source/_posts
```

Lint with lint-staged(staged files only)

```sh
git add source/_posts
npx lint-staged
```
Loading