Test

docs: initial guide and structure for api reference #13

	name: Test

	on:
	- push
	- pull_request

	jobs:
	test:
	runs-on: ubuntu-latest
	permissions:
	# Required to checkout the code
	contents: read
	# Required to put a comment into the pull-request
	pull-requests: write
	steps:
	- uses: actions/checkout@v4
	- uses: actions/setup-node@v4
	with:
	node-version: 20
	- name: Install
	run: npm ci
	- name: Run tests
	run: npx vitest --coverage.enabled true
	- name: 'Report Coverage'
	# Set if: always() to also generate the report if tests are failing
	# Only works if you set `reportOnFailure: true` in your vite config as specified above
	if: always()
	uses: davelosert/vitest-coverage-report-action@v2
	- name: "Upload Coverage"
	uses: actions/upload-artifact@v4
	with:
	name: coverage-${{ matrix.branch }}
	path: coverage
	- name: Run linting
	run: npm run lint
	- name: Check formatting
	run: npx prettier . --check

	report-coverage:
	needs: test
	runs-on: ubuntu-latest
	steps:
	- name: "Download Coverage Artifacts"
	uses: actions/download-artifact@v4
	with:
	name: coverage-${{ github.head_ref }}
	path: coverage
	- uses: actions/download-artifact@v4
	with:
	name: coverage-main
	path: coverage-main
	- name: "Report Coverage"
	uses: davelosert/vitest-coverage-report-action@v2
	with:
	json-summary-compare-path: coverage-main/coverage-summary.json

Provide feedback