feat(docu): generate coverage badge (#162)

* generate coverage badge

generate coverage badge in docs generation workflow in order to upload
it with the documentation

* include badge in readme, correct image name & json path

* job names, json path

* remove coverage branch from workflow

.github/workflows/deploy.docs.yml

@@ -19,14 +19,26 @@ jobs:
         run: |
           npm install
           npm run build
-          npm link
         working-directory: ./
 
       - name: Build static files
         id: build
-        run: npm install && npm run docs:generate
+        run: npm run docs:generate
         working-directory: ./
 
+      - name: Generate coverage
+        id: coverage
+        run: npm run test:unit
+
+      - name: Create coverage badges
+        id: coverage-badge
+        uses: jaywcjlove/coverage-badges-cli@main
+        with:
+          style: flat
+          source: coverage/coverage-summary.json
+          output: docs/test-coverage.svg
+          jsonPath: total.lines.pct
+
       - name: Upload static files as artifact
         id: deployment
         uses: actions/upload-pages-artifact@v3.0.1

README.md

@@ -1,4 +1,4 @@
-# Utopia UI [![npm version](https://img.shields.io/npm/v/utopia-ui.svg)](https://www.npmjs.com/package/utopia-ui)  ![Build Status](https://img.shields.io/github/actions/workflow/status/utopia-os/utopia-ui/test.build.yml?branch=main) [![Docs Coverage](https://utopia-os.org/utopia-ui/coverage.svg)](https://utopia-os.org/utopia-ui/) ![License](https://img.shields.io/github/license/utopia-os/utopia-ui)
+# Utopia UI [![npm version](https://img.shields.io/npm/v/utopia-ui.svg)](https://www.npmjs.com/package/utopia-ui)  ![Build Status](https://img.shields.io/github/actions/workflow/status/utopia-os/utopia-ui/test.build.yml?branch=main) ![Test Coverage](https://utopia-os.org/utopia-ui/test-coverage.svg) [![Docs Coverage](https://utopia-os.org/utopia-ui/coverage.svg)](https://utopia-os.org/utopia-ui/) ![License](https://img.shields.io/github/license/utopia-os/utopia-ui)
 
 **UI Framework for Real-Life-Networking-Apps**
 

vite.config.ts

@@ -13,6 +13,7 @@ export default defineConfig({
       all: true,
       include: ['src/**/*.{js,jsx,ts,tsx}'],
       exclude: [...configDefaults.exclude, 'src/**/*.cy.tsx'],
+      reporter: ['html', 'json-summary'],
       thresholds: {
         lines: 1,
         functions: 59,