feat: add vitest suite + first test #29

.gitignore

@@ -1,5 +1,6 @@
 node_modules
 dist
+coverage/
 
 # Yarn v2
 .pnp.*

package.json

@@ -16,11 +16,13 @@
     }
   },
   "scripts": {
-    "dev": "vite",
     "build": "vite build && tsc",
     "build:demo": "vite build --mode development",
+    "coverage": "vitest run --coverage",
+    "dev": "vite",
+    "preversion": "yarn build",
     "preview": "vite preview",
-    "preversion": "yarn build"
+    "test": "vitest"
   },
   "repository": {
     "type": "git",
@@ -33,8 +35,10 @@
   },
   "homepage": "https://github.com/teritorio/maplibre-gl-teritorio-cluster#readme",
   "devDependencies": {
+    "@vitest/coverage-v8": "2.1.5",
     "typescript": "^5.6.2",
-    "vite": "^5.4.4"
+    "vite": "^5.4.4",
+    "vitest": "^2.1.5"
   },
   "dependencies": {
     "@turf/bbox": "^7.1.0",

src/teritorio-cluster.ts

@@ -1,5 +1,5 @@
 import type { FitBoundsOptions, GeoJSONSource, LngLatLike, MapGeoJSONFeature, MapSourceDataEvent } from 'maplibre-gl'
-import { LngLat, Marker, Point } from 'maplibre-gl'
+import { LngLat, Marker, Point, type Map as MapGL } from 'maplibre-gl'
 import {
   clusterRenderDefault,
   markerRenderDefault,
@@ -43,7 +43,7 @@ type FeatureMatch = FeatureInClusterMatch | MapGeoJSONFeature
 const UnfoldedClusterClass = 'teritorio-unfolded-cluster'
 
 export class TeritorioCluster extends EventTarget {
-  map: maplibregl.Map
+  map: MapGL
   clusterLeaves: Map<string, MapGeoJSONFeature[]>
   clusterMaxZoom: number
   clusterMinZoom: number
@@ -64,7 +64,7 @@ export class TeritorioCluster extends EventTarget {
   unfoldedClusterMaxLeaves: number
 
   constructor(
-    map: maplibregl.Map,
+    map: MapGL,
     sourceId: string,
     options?: {
       clusterMaxZoom?: number,

tests/index.test.ts

@@ -0,0 +1,53 @@
+import { describe, it, expect, beforeEach } from 'vitest'
+import { TeritorioCluster } from '../src/teritorio-cluster'
+import { Map as MapGL } from 'maplibre-gl'
+
+describe('TeritorioCluster', () => {
+  let map: MapGL
+  let cluster: TeritorioCluster
+
+  beforeEach(() => {
+    // Create a mock map
+    map = new MapGL({ container: 'map'})
+
+    // Initialize the cluster
+    cluster = new TeritorioCluster(map, 'sourceId')
+  })
+
+  it('should initialize with default values', () => {
+    expect(cluster.map).toMatchObject(map)
+    expect(cluster.clusterLeaves).toBeInstanceOf(Map)
+    expect(cluster.clusterLeaves.size).toBe(0)
+    expect(cluster.clusterMaxZoom).toBe(17)
+    expect(cluster.clusterMinZoom).toBe(0)
+
+    // Should have the default render function
+    expect(cluster.clusterRender).toBeUndefined()
+
+    expect(cluster.featuresMap).toBeInstanceOf(Map)
+    expect(cluster.featuresMap.size).toBe(0)
+    expect(cluster.fitBoundsOptions).toMatchObject({ padding: 20 })
+    expect(cluster.initialFeature).toBeUndefined()
+
+    // Should have the default render function
+    expect(cluster.markerRender).toBeUndefined()
+
+    expect(cluster.markerSize).toBe(24)
+    expect(cluster.markersOnScreen).toBeInstanceOf(Map)
+    expect(cluster.markersOnScreen.size).toBe(0)
+    expect(cluster.pinMarker).toBeNull()
+
+    // Should have the default render function
+    expect(cluster.pinMarkerRender).toBeUndefined()
+
+    expect(cluster.selectedClusterId).toBeNull()
+    expect(cluster.selectedFeatureId).toBeNull()
+    expect(cluster.sourceId).toBe('sourceId')
+    expect(cluster.ticking).toBeFalsy()
+
+    // Should have the default render function
+    expect(cluster.unfoldedClusterRender).toBeUndefined()
+
+    expect(cluster.unfoldedClusterMaxLeaves).toBe(7)
+  })
+})

tests/mocks/maplibre-gl.mock.ts

@@ -0,0 +1,14 @@
+import { vi } from 'vitest'
+
+vi.mock('maplibre-gl', () => {
+  return {
+    Map: vi.fn().mockImplementation(() => ({
+      on: vi.fn(),
+      querySourceFeatures: vi.fn().mockReturnValue([]),
+      getSource: vi.fn().mockReturnValue({
+        getClusterLeaves: vi.fn(),
+      }),
+      fitBounds: vi.fn(),
+    })),
+  }
+})

vitest.config.ts

@@ -0,0 +1,10 @@
+import { defineConfig } from 'vitest/config'
+
+export default defineConfig({
+  test: {
+    coverage: {
+      reporter: ['text', 'json', 'html'],
+    },
+    setupFiles: './tests/mocks/maplibre-gl.mock.ts',
+  },
+})