Svelte Check Action
run svelte-check on the files that change in a pull request and have the errors commented
Svelte Check Action
This action runs svelte-check on the files that change in a PR (by default), then adds a comment which reports any errors in those files. The inspiration came from wanting to have svelte-check run in CI without failing, so that we can progressively fix a codebase with a lot of issues.
Works with svelte-check version 3 & 4. The action runs using Node 20.
Example
name: Svelte Check
on:
- pull_request
jobs:
demo:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
# You can replace these steps with your specific setup steps
# This example assumes Node 22 and pnpm 8
- name: Setup Node 22
uses: actions/setup-node@v4
with:
node-version: 22
registry-url: https://registry.npmjs.org/
- name: Setup PNPM
uses: pnpm/[email protected]
with:
version: 8.12.1
- name: Install
run: pnpm install
# Run the svelte check action
- name: Svelte Check
uses: ghostdevv/svelte-check-action@v1
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
This will add a comment to your PRs with any errors, for example:
Options
| Option | Description | Default |
|---|---|---|
paths |
The folder(s) to run svelte-check in, one per line. It'll only run svelte-check if files in that folder have changed. svelte-kit sync will be ran before diagnostics if SvelteKit is found at the folder package.json. |
. |
filterChanges |
When true only the files that change (in the pull request) will be checked | true |
You can configure the action by passing the options under the with key, for example:
- name: Svelte Check
uses: ghostdevv/svelte-check-action@v1
with:
paths: |
./packages/app
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
