feat: add tests for type definitions

.clean-publish

@@ -1,4 +1,5 @@
 {
   "withoutPublish": true,
-  "tempDir": "package"
+  "tempDir": "package",
+  "fields": ["tsd"],
 }

.github/workflows/checks.yml

@@ -26,3 +26,25 @@ jobs:
         uses: andresz1/size-limit-action@master
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
+  typings:
+    runs-on: ubuntu-latest
+    name: typings
+    steps:
+      - name: Checkout the repository
+        uses: actions/checkout@v2
+      - name: Install pnpm
+        uses: pnpm/action-setup@v2.0.1
+        with:
+          version: 6
+      - name: Install Node.js
+        uses: actions/setup-node@v2
+        with:
+          node-version: 16
+          cache: 'pnpm'
+      - name: Install dependencies
+        run: pnpm install
+      - name: Prebuild
+        run: pnpm build
+      - name: Check typings
+        if: success()
+        run: pnpm test:typings

package.json

@@ -38,7 +38,7 @@
   ],
   "sideEffects": false,
   "main": "./src/index.ts",
-  "typings": "./dist/index.d.ts",
+  "types": "./dist/index.d.ts",
   "publishConfig": {
     "main": "./dist/index.cjs",
     "module": "./dist/index.js",
@@ -52,6 +52,7 @@
     "unit": "jest -c jest.config.json",
     "test": "pnpm lint && pnpm unit",
     "test:size": "size-limit",
+    "test:typings": "tsd",
     "lint": "eslint 'src/**/*.ts'",
     "format": "prettier --write src test",
     "release": "standard-version",
@@ -109,10 +110,14 @@
     "simple-git-hooks": "^2.7.0",
     "size-limit": "^7.0.8",
     "standard-version": "^9.3.2",
+    "tsd": "^0.19.1",
     "typescript": "^4.6.2",
     "vite": "^2.8.6",
     "vue": "^3.2.31",
     "vue-loader": "^17.0.0",
     "vuepress": "^0.14.4"
+  },
+  "tsd": {
+    "directory": "./test"
   }
 }

test/ChartsTypes.test-d.ts

@@ -0,0 +1,55 @@
+import { h } from 'vue'
+import { expectError } from 'tsd'
+import { PluginOptionsByType } from 'chart.js'
+
+import { Bar, Radar, Scatter, Doughnut } from '../src'
+
+const chartData = {
+  datasets: []
+}
+
+/**
+ * Should check type-specific props
+ */
+
+h(Radar, {
+  chartData,
+  plugins: {} as PluginOptionsByType<'radar'>
+})
+
+h(Scatter, {
+  chartData,
+  plugins: {} as PluginOptionsByType<'scatter'>
+})
+
+h(Bar, {
+  chartData,
+  chartOptions: {}
+})
+
+expectError(
+  h(Scatter, {
+    chartData,
+    plugins: {} as PluginOptionsByType<'bubble'>
+  })
+)
+
+/**
+ * Should check type-specific options
+ */
+
+h(Doughnut, {
+  chartData,
+  chartOptions: {
+    cutout: '75%'
+  }
+})
+
+expectError(
+  h(Scatter, {
+    chartData,
+    chartOptions: {
+      cutout: '75%'
+    }
+  })
+)