Fix type declaration location when importing JSON (#27)

onfido · Sep 3, 2020 · cc34619 · cc34619
1 parent e87395d
commit cc34619
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 2 deletions.
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@onfido/api",
-  "version": "1.5.1",
+  "version": "1.5.2",
   "description": "Node.js library for the Onfido API",
   "keywords": [
     "onfido",

diff --git a/src/ignoreJson.d.ts b/src/ignoreJson.d.ts
@@ -0,0 +1,2 @@
+// Using resolveJsonModule with TypeScript and importing package.json causes issues because it causes rootDir to change to . instead of ./src, which means generated type declarations get output in dist/src rather than just dist. Since rollup inserts JSON directly we can just ignore JSON modules in TypeScript.
+declare module "*.json";
diff --git a/test/tsconfig.json b/test/tsconfig.json
@@ -3,6 +3,7 @@
   "include": ["./**/*"],
   "compilerOptions": {
     "baseUrl": "../",
+    "resolveJsonModule": true,
     "paths": {
       "onfido-node": ["src/index"]
     }

diff --git a/tsconfig.json b/tsconfig.json
@@ -9,7 +9,7 @@
     "sourceMap": true,
     "declaration": true,
     "esModuleInterop": true,
-    "resolveJsonModule": true
+    "rootDir": "src"
   },
   "include": ["src/**/*"]
 }
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		// Using resolveJsonModule with TypeScript and importing package.json causes issues because it causes rootDir to change to . instead of ./src, which means generated type declarations get output in dist/src rather than just dist. Since rollup inserts JSON directly we can just ignore JSON modules in TypeScript.
		declare module "*.json";