Merge pull request #28 from QuantForgeOrg/dev

add automatic coverage badge

Author: alaa-eddine

.github/workflows/release.yaml

@@ -24,6 +24,12 @@ jobs:
             - name: Install dependencies
               run: npm ci
 
+            - name: Run tests with coverage
+              run: npx vitest run --coverage
+
+            - name: Generate Coverage Badge
+              run: npx coverage-badge -o coverage.svg
+
             - name: Build project
               run: npm run build:prod:all
 
@@ -36,3 +42,23 @@ jobs:
                   overwrite: true
               env:
                   GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+            - name: Update Coverage Badge in Repo
+              if: success()
+              run: |
+                  git config --global user.name "github-actions[bot]"
+                  git config --global user.email "github-actions[bot]@users.noreply.github.com"
+
+                  # Fetch and checkout the default branch (trying main, falling back to master)
+                  git fetch origin main:main || git fetch origin master:master
+                  BRANCH=$(git show-ref --verify --quiet refs/heads/main && echo "main" || echo "master")
+                  git checkout $BRANCH
+
+                  # Move badge to correct location
+                  mkdir -p .github/badges
+                  mv coverage.svg .github/badges/coverage.svg
+
+                  # Commit and push
+                  git add .github/badges/coverage.svg
+                  git commit -m "docs: update coverage badge [skip ci]" || echo "No changes to commit"
+                  git push origin $BRANCH

README.md

@@ -1,5 +1,6 @@
 [![npm version](https://img.shields.io/npm/v/pinets.svg?style=flat-square)](https://www.npmjs.com/package/pinets)
 [![License: AGPL-3.0](https://img.shields.io/badge/License-AGPL--3.0-blue.svg?style=flat-square)](https://opensource.org/licenses/AGPL-3.0)
+[![Coverage](./.github/badges/coverage.svg)](./.github/badges/coverage.svg)
 [![Documentation](https://img.shields.io/badge/docs-github--pages-blue?style=flat-square)](https://quantforgeorg.github.io/PineTS/)
 [![Reddit](https://img.shields.io/reddit/subreddit-subscribers/QuantForge?style=flat-square&logo=reddit)](https://www.reddit.com/r/QuantForge/)
 

vitest.config.ts

@@ -9,7 +9,7 @@ export default defineConfig({
         include: ['tests/**/*.test.ts'],
         exclude: ['node_modules'],
         coverage: {
-            reporter: ['text', 'text-summary', 'html'],
+            reporter: ['text', 'text-summary', 'html', 'json-summary'],
             reportsDirectory: './coverage',
             include: ['src/**/*.ts'],
             exclude: ['node_modules'],