test: add module tests (#61)

* test: 💍 write initial basic and disabled tests with vitest

* test: 💍 correctly test that we can disable svgo

* docs: ✏️ update example for disabling svgo

* test: 💍 add tests for svgoOptions overrides

* test: 💍 update test name

* ci: 🎡 add tests to ci

* test: 💍 import module directly instead of using string

.github/workflows/ci.yml

@@ -85,3 +85,42 @@ jobs:
 
       - name: Prettier
         run: pnpm run ci:format
+
+  vitest:
+    name: Test
+    timeout-minutes: 15
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code repository
+        uses: actions/checkout@v3
+
+      - name: Setup node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16
+
+      - name: Install pnpm
+        uses: pnpm/action-setup@v2.2.2
+        id: pnpm-install
+        with:
+          version: 7.9.5
+          run_install: false
+
+      - name: Get pnpm store directory
+        id: pnpm-cache
+        run: |
+          echo "::set-output name=pnpm_cache_dir::$(pnpm store path)"
+
+      - name: Setup pnpm cache
+        uses: actions/cache@v3
+        with:
+          path: ${{ steps.pnpm-cache.outputs.pnpm_cache_dir }}
+          key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
+          restore-keys: |
+            ${{ runner.os }}-pnpm-store-
+
+      - name: Install dependencies
+        run: pnpm install
+
+      - name: Vitest
+        run: pnpm run test

.prettierignore

@@ -1,5 +1,5 @@
 dist
 **/node_modules
-playground/.nuxt
+**/.nuxt
 **/*.d.ts
 **/pnpm-lock.yaml

README.md

@@ -112,7 +112,7 @@ import { defineNuxtConfig } from 'nuxt'
 
 export default defineNuxtConfig({
   modules: ['nuxt-svgo'],
-  svgoOptions: {
+  svgo: {
     svgo: false
   }
 })

package.json

@@ -42,7 +42,9 @@
     "format": "prettier --write \"**/*.{js,jsx,ts,tsx,vue,md,mdx,gql,graphql,json,yml,yaml}\"",
     "lint": "eslint --ext .js,.ts, --fix .",
     "prepack": "nuxt-module-build",
-    "prepare": "husky install"
+    "prepare": "husky install",
+    "test": "NUXT_TELEMETRY_DISABLED=1 pnpm nuxi prepare test/fixtures/basic && JITI_ESM_RESOLVE=1 vitest run --dir test",
+    "test:dev": "NUXT_TELEMETRY_DISABLED=1 NUXT_TEST_DEV=true pnpm test:fixtures"
   },
   "dependencies": {
     "@nuxt/kit": "npm:@nuxt/kit-edge@latest",
@@ -59,6 +61,7 @@
     "@cpsoinos/eslint-config-typescript": "0.2.2",
     "@cpsoinos/prettier-config": "0.0.0",
     "@nuxt/module-builder": "latest",
+    "@nuxt/test-utils": "3.0.0-rc.13",
     "@nuxtjs/eslint-config-typescript": "latest",
     "@types/svgo": "2.6.4",
     "commitizen": "4.2.5",
@@ -67,7 +70,8 @@
     "husky": "8.0.1",
     "nuxt": "3.0.0-rc.13",
     "pnpm": "7.9.5",
-    "prettier": "2.7.1"
+    "prettier": "2.7.1",
+    "vitest": "^0.24.5"
   },
   "commitlint": {
     "extends": [

playground/custom.d.ts

@@ -0,0 +1,6 @@
+// custom.d.ts
+declare module '*.svg' {
+  import type { DefineComponent } from 'vue'
+  const component: DefineComponent
+  export default component
+}