HOV-56 | sets up vitest and action for test

.github/workflows/run-tests-on-pr.yml

@@ -0,0 +1,39 @@
+name: Run test on PR
+
+on:
+  pull_request:
+    branches: [main]
+jobs:
+  build:
+    name: test code
+    timeout-minutes: 15
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 2
+
+      - uses: pnpm/action-setup@v2.0.1
+        with:
+          version: 6.32.2
+
+      - name: Setup Node.js environment
+        uses: actions/setup-node@v3
+        with:
+          node-version: "16.x"
+          cache: "pnpm"
+          registry-url: "https://registry.npmjs.org"
+
+      - name: Install dependencies
+        run: pnpm install --no-frozen-lockfile
+
+      - name: Test
+        run: pnpm test
+
+      - name: Build
+        run: pnpm publish-build

lib/package.json

@@ -8,9 +8,8 @@
   "types": "dist/types/index.d.ts",
   "private": false,
   "repository": {
-    "url": "https://github.com/antstackio/hover-design.git",
     "type": "git",
-    "directory": "lib"
+    "url": "git+https://github.com/antstackio/hover-design.git"
   },
   "keywords": [
     "react",
@@ -29,7 +28,9 @@
     "tsc": "tsc",
     "ladle": "ladle serve",
     "serve": "vite preview",
-    "watch": "nodemon --watch src/ -e ts,tsx --exec \"tsc && vite build && tsc --emitDeclarationOnly\""
+    "watch": "nodemon --watch src/ -e ts,tsx --exec \"tsc && vite build && tsc --emitDeclarationOnly\"",
+    "test": "vitest",
+    "coverage": "vitest run --coverage"
   },
   "dependencies": {
     "@ladle/react": "^2.3.0",
@@ -53,16 +54,13 @@
     "typescript": "^4.3.2",
     "vite": "^2.6.4",
     "vite-plugin-dts": "^0.9.9",
-    "vite-tsconfig-paths": "^3.4.0"
+    "vite-tsconfig-paths": "^3.4.0",
+    "vitest": "^0.23.4"
   },
   "peerDependencies": {
     "react": "^17.0.0 || ^18.0.0",
     "react-dom": "^17.0.0 || ^18.0.0"
   },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/antstackio/hover-design.git"
-  },
   "publishConfig": {
     "access": "public"
   }

lib/src/utils/tests/object-utils.test.ts

@@ -0,0 +1,9 @@
+import { describe, test, expect } from "vitest";
+import { eliminateUndefinedKeys } from "../object-utils";
+describe("Object Utils Test", () => {
+  test("should eliminate undefined keys", () => {
+    const record = { a: 1, b: undefined, c: 3 };
+    const eliminated = eliminateUndefinedKeys(record);
+    expect(eliminated).toEqual({ a: 1, c: 3 });
+  });
+});

lib/vite.config.ts

@@ -11,25 +11,25 @@ export default defineConfig({
   plugins: [
     react(),
     vanillaExtractPlugin({ identifiers: "short" }),
-    tsconfigPaths()
+    tsconfigPaths(),
   ],
   resolve: {
-    alias: [{ find: "src", replacement: resolve(__dirname, "src") }]
+    alias: [{ find: "src", replacement: resolve(__dirname, "src") }],
   },
   build: {
     lib: {
       entry: resolve(__dirname, "src/index.ts"),
       fileName: (format) => `hover-react.${format}.js`,
       formats: ["es"],
-      name: "@hover-design/react"
+      name: "@hover-design/react",
     },
     rollupOptions: {
       external: Object.keys(pkg.peerDependencies),
       output: {
         globals: {
-          react: "React"
-        }
-      }
-    }
-  }
+          react: "React",
+        },
+      },
+    },
+  },
 });

lib/vitest.config.ts

@@ -0,0 +1,13 @@
+import { mergeConfig } from "vite";
+import { defineConfig } from "vitest/config";
+import viteConfig from "./vite.config";
+
+export default mergeConfig(
+  viteConfig,
+  defineConfig({
+    test: {
+      exclude: ["dist/*", ".turbo/*", "node_modules/*"],
+      include: ["src/**/*.{test,spec}.{js,mjs,cjs,ts,mts,cts,jsx,tsx}"],
+    },
+  })
+);

package.json

@@ -16,6 +16,7 @@
   "scripts": {
     "prebuild": "test \"$CI\" = true && npx pnpm install -r --store=node_modules/.pnpm-store || echo skiping pnpm install",
     "build": "turbo run build",
+    "test": "turbo run test",
     "dev": "turbo run dev --no-cache --parallel --continue",
     "publish-build": "turbo run build --scope=@hover-design/react --no-deps --include-dependencies",
     "ladle": "turbo run ladle --scope=@hover-design/react --no-deps --include-dependencies"