Add tsd for testing types (#164)

silas · Oct 25, 2024 · b234a6e · b234a6e
1 parent 3e81b54
commit b234a6e
Show file tree

Hide file tree

Showing 8 changed files with 619 additions and 36 deletions.
diff --git a/.github/workflows/pr.yml b/.github/workflows/pr.yml
@@ -40,5 +40,8 @@ jobs:
       - name: Install
         run: pnpm install
 
+      - name: Types
+        run: pnpm types
+
       - name: Test
         run: pnpm test
diff --git a/package.json b/package.json
@@ -8,8 +8,7 @@
     "./lib"
   ],
   "dependencies": {
-    "papi": "^1.1.0",
-    "uuid": "^10.0.0"
+    "papi": "^1.1.0"
   },
   "devDependencies": {
     "@types/node": "^22.7.6",
@@ -22,12 +21,14 @@
     "prettier": "^3.3.3",
     "should": "^13.2.1",
     "sinon": "^19.0.2",
-    "temp": "^0.9.4"
+    "temp": "^0.9.4",
+    "tsd": "^0.31.2",
+    "uuid": "^10.0.0"
   },
   "scripts": {
     "format": "prettier -w .",
     "test": "jshint lib test && prettier -c . && nyc mocha -- --recursive --check-leaks && nyc check-coverage --statements 100 --functions 100 --branches 100 --lines 100",
-    "types": "dtslint test/types",
+    "types": "tsd",
     "acceptance": "ACCEPTANCE=true nyc mocha -- test/acceptance --recursive --check-leaks --timeout 30000",
     "acceptanceSetupMacOS": "sudo ifconfig lo0 alias 127.0.0.2 up && sudo ifconfig lo0 alias 127.0.0.3 up"
   },

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/test-d/index.test-d.ts b/test-d/index.test-d.ts
@@ -0,0 +1,7 @@
+import { expectType } from "tsd";
+
+import Consul from "../lib";
+
+const consul = new Consul();
+
+expectType<Consul>(consul);
diff --git a/test/types/.eslintrc b/test/types/.eslintrc
diff --git a/test/types/index.d.ts b/test/types/index.d.ts
diff --git a/test/types/tsconfig.json b/test/types/tsconfig.json
diff --git a/test/types/type-tests.ts b/test/types/type-tests.ts