chore(geld): update dependencies for testing and coverage, add test scripts, and refine .npmignore

Author: mezotv

.github/workflows/coverage.yml

@@ -0,0 +1,36 @@
+name: Coverage
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  coverage:
+    runs-on: ubuntu-latest
+    
+    steps:
+    - uses: actions/checkout@v4
+    
+    - name: Setup Node.js
+      uses: actions/setup-node@v4
+      with:
+        node-version: '20'
+        
+    - name: Setup pnpm
+      uses: pnpm/action-setup@v2
+      with:
+        version: 8
+        
+    - name: Install dependencies
+      run: pnpm install
+      
+    - name: Run tests with coverage
+      run: cd packages/geld && pnpm coverage
+      
+    - name: Generate coverage badge
+      uses: jpb06/jest-badges-action@latest
+      with:
+        branches: main
+        coverage-summary-path: packages/geld/coverage/coverage-summary.json 

packages/geld/.npmignore

@@ -2,3 +2,6 @@
 node_modules
 tsconfig.json
 src/
+test/
+coverage/
+vitest.config.ts

packages/geld/README.md

@@ -2,6 +2,8 @@
 
 A comprehensive TypeScript/JavaScript library for financial operations and validations. Currently featuring IBAN (International Bank Account Number) validation and formatting, with more financial tools planned for future releases.
 
+![Coverage](./coverage/badges/coverage.svg)
+
 > 'Geld' means 'money' in German, Dutch and Afrikaans. That's why we chose that name for our financial tools.
 
 ## Installation

packages/geld/package.json

@@ -31,19 +31,20 @@
   },
   "homepage": "https://rivo.gg/projects/geld",
   "funding": {
-
     "type": "github",
-
     "url": "https://github.com/sponsors/rivo-gg"
-
   },
   "scripts": {
     "dev": "tsc --watch",
-    "build": "tsc"
+    "build": "tsc",
+    "test": "vitest",
+    "coverage": "vitest run --coverage"
   },
   "devDependencies": {
     "@rivo-gg/tsconfig": "workspace:*",
-    "typescript": "latest"
+    "@vitest/coverage-v8": "^3.2.1",
+    "typescript": "latest",
+    "vitest": "^3.2.1"
   },
   "sideEffects": false
 }

packages/geld/test/iban.test.ts

@@ -0,0 +1,99 @@
+import { describe, it, expect } from "vitest";
+import { iban } from "../index";
+
+describe("IBAN Validation", () => {
+  it("should validate correct IBANs", () => {
+    const validIbans = [
+      "DE89370400440532013000",
+      "GB29NWBK60161331926819",
+      "FR1420041010050500013M02606",
+      "NL91ABNA0417164300",
+    ];
+
+    for (const validIban of validIbans) {
+      expect(iban.isValid(validIban)).toBe(true);
+    }
+  });
+
+  it("should not validate incorrect IBANs", () => {
+    const invalidIbans = [
+      "DE89370400440532013001",
+      "GB29NWBK6016133192681",
+      "FR1420041010050500013M0260699",
+      "XX91ABNA0417164300",
+      "",
+      "NOT-AN-IBAN",
+    ];
+
+    for (const invalidIban of invalidIbans) {
+      expect(iban.isValid(invalidIban)).not.toBe(true);
+    }
+  });
+
+  it("should validate IBANs with spaces when clean option is true", () => {
+    const formattedIbans = [
+      "DE89 3704 0044 0532 0130 00",
+      "GB29 NWBK 6016 1331 9268 19",
+      "FR14 2004 1010 0505 0001 3M02 606",
+    ];
+
+    for (const formattedIban of formattedIbans) {
+      expect(iban.isValid(formattedIban, true)).toBe(true);
+    }
+  });
+});
+
+describe("IBAN Formatting", () => {
+  it("should format IBANs with default spacing", () => {
+    const testCases = [
+      {
+        input: "DE89370400440532013000",
+        expected: "DE89 3704 0044 0532 0130 00",
+      },
+      {
+        input: "GB29NWBK60161331926819",
+        expected: "GB29 NWBK 6016 1331 9268 19",
+      },
+    ];
+
+    for (const { input, expected } of testCases) {
+      expect(iban.printFormat(input)).toBe(expected);
+    }
+  });
+
+  it("should format IBANs with custom separator", () => {
+    const testCases = [
+      {
+        input: "DE89370400440532013000",
+        separator: "-",
+        expected: "DE89-3704-0044-0532-0130-00",
+      },
+      {
+        input: "GB29NWBK60161331926819",
+        separator: "*",
+        expected: "GB29*NWBK*6016*1331*9268*19",
+      },
+    ];
+
+    for (const { input, separator, expected } of testCases) {
+      expect(iban.printFormat(input, separator)).toBe(expected);
+    }
+  });
+
+  it("should clean and format IBANs with special characters", () => {
+    const testCases = [
+      {
+        input: "DE89-3704.0044/0532-0130-00",
+        expected: "DE89 3704 0044 0532 0130 00",
+      },
+      {
+        input: "GB29/NWBK.6016-1331.9268.19",
+        expected: "GB29 NWBK 6016 1331 9268 19",
+      },
+    ];
+
+    for (const { input, expected } of testCases) {
+      expect(iban.printFormat(input)).toBe(expected);
+    }
+  });
+});

packages/geld/tsconfig.json

@@ -5,5 +5,5 @@
     "moduleResolution": "node"
   },
   "include": ["src", "index.ts"],
-  "exclude": ["node_modules", "dist"]
+  "exclude": ["node_modules", "dist", "test", "coverage", "vitest.config.ts"]
 }

packages/geld/vitest.config.ts

@@ -0,0 +1,11 @@
+import { defineConfig } from 'vitest/config';
+
+export default defineConfig({
+  test: {
+    coverage: {
+      provider: 'v8',
+      reporter: ['text', 'json-summary', 'html'],
+      reportsDirectory: './coverage'
+    },
+  },
+});