Merge pull request #183 from felix-berlin/test/add-unit-tests

Test/add unit tests

.github/workflows/unit-test.yml

@@ -0,0 +1,41 @@
+name: Unit tests
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+      - beta
+
+jobs:
+  lint:
+    name: Run unit tests
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Setup pnpm 🛠️
+        uses: pnpm/action-setup@v2
+        with:
+          version: 8
+
+      - name: Checkout ✅
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js 🔧
+        uses: actions/setup-node@v4
+        with:
+          node-version: "lts/*"
+          cache: "pnpm"
+
+      - name: Install dependencies 🛠️
+        run: pnpm i
+
+      - name: Run Vitest 🧪
+        run: pnpm run test:unit
+
+      - name: Create coverage report 📝
+        run: pnpm run test:unit:coverage
+
+      - name: Codecov
+        uses: codecov/[email protected]
+        with:
+          directory: ./coverage

.gitignore

@@ -1 +1,2 @@
-node_modules
+node_modules
+tests/unit/coverage

.npmignore

@@ -1,4 +1,6 @@
 .releaserc
+.prettierrc.cjs
+.vitest.config.ts
 renovate.json
 .github
 demo

.prettierrc.cjs

@@ -0,0 +1,11 @@
+module.exports = {
+  plugins: [require.resolve("prettier-plugin-astro")],
+  overrides: [
+    {
+      files: "*.astro",
+      options: {
+        parser: "astro",
+      },
+    },
+  ],
+};

README.md

@@ -6,6 +6,7 @@
 ![npm](https://img.shields.io/npm/v/astro-breadcrumbs?logo=npm&style=flat-square)
 ![GitHub package.json version](https://img.shields.io/github/package-json/v/felix-berlin/astro-breadcrumbs?label=github&logo=github&style=flat-square)
 ![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/felix-berlin/astro-breadcrumbs/release.yml?label=release&logo=github&style=flat-square)
+[![codecov](https://codecov.io/gh/felix-berlin/astro-breadcrumbs/graph/badge.svg?token=8GTWBCTPYZ)](https://codecov.io/gh/felix-berlin/astro-breadcrumbs)
 ![GitHub file size in bytes](https://img.shields.io/github/size/felix-berlin/astro-breadcrumbs/src/Breadcrumbs.astro?label=component%20size&logo=astro&style=flat-square)
 ![GitHub file size in bytes](https://img.shields.io/github/size/felix-berlin/astro-breadcrumbs/src/breadcrumbs.css?label=CSS%20Size&logo=CSS3&style=flat-square)
 ![GitHub file size in bytes](https://img.shields.io/github/size/felix-berlin/astro-breadcrumbs/src/breadcrumbs.scss?label=SCSS%20Size&logo=SASS&style=flat-square)

docs/package.json

@@ -12,7 +12,7 @@
   "dependencies": {
     "@astrojs/starlight": "^0.17.0",
     "astro": "^4.2.6",
-    "astro-breadcrumbs": "^1.8.1",
+    "astro-breadcrumbs": "^1.9.0",
     "astro-matomo": "^1.4.2",
     "sharp": "^0.33.2"
   },

package.json

@@ -15,7 +15,8 @@
   ],
   "scripts": {
     "release": "semantic-release --branches main",
-    "preinstall": "npx only-allow pnpm"
+    "test:unit": "vitest --coverage",
+    "test:unit:coverage": "vitest run --coverage"
   },
   "repository": {
     "type": "git",
@@ -64,7 +65,12 @@
   "devDependencies": {
     "@semantic-release/changelog": "^6.0.3",
     "@semantic-release/git": "^10.0.1",
-    "semantic-release": "^23.0.0"
+    "@vitest/coverage-v8": "^1.2.2",
+    "jsdom": "^24.0.0",
+    "prettier": "^3.2.4",
+    "prettier-plugin-astro": "^0.13.0",
+    "semantic-release": "^23.0.0",
+    "vitest": "^1.2.2"
   },
   "peerDependencies": {
     "astro": "^2.0.0-beta.0 || ^3.0.0 || ^4.0.0"