fix: swapped ts-check comments to checkJs in tsconfig (#1171)

t3-oss · Feb 6, 2023 · efe8b7f · efe8b7f · vercel · Feb 6, 2023
1 parent 7b7a160
commit efe8b7f
Show file tree

Hide file tree

Showing 9 changed files with 8 additions and 8 deletions.
diff --git a/.changeset/tough-bees-serve.md b/.changeset/tough-bees-serve.md
@@ -0,0 +1,5 @@
+---
+"create-t3-app": patch
+---
+
+fix: swap `@ts-check` comments to `checkJs: true` in scaffolded app's tsconfig
diff --git a/cli/template/base/src/env/client.mjs b/cli/template/base/src/env/client.mjs
@@ -1,4 +1,3 @@
-// @ts-check
 import { clientEnv, clientSchema } from "./schema.mjs";
 
 const _clientEnv = clientSchema.safeParse(clientEnv);

diff --git a/cli/template/base/src/env/schema.mjs b/cli/template/base/src/env/schema.mjs
@@ -1,4 +1,3 @@
-// @ts-check
 import { z } from "zod";
 
 /**

diff --git a/cli/template/base/src/env/server.mjs b/cli/template/base/src/env/server.mjs
@@ -1,4 +1,3 @@
-// @ts-check
 /**
  * This file is included in `/next.config.mjs` which ensures the app isn't built with invalid env vars.
  * It has to be a `.mjs`-file to be imported there.

diff --git a/cli/template/extras/src/env/schema/with-auth-prisma.mjs b/cli/template/extras/src/env/schema/with-auth-prisma.mjs
@@ -1,4 +1,3 @@
-// @ts-check
 import { z } from "zod";
 
 /**

diff --git a/cli/template/extras/src/env/schema/with-auth.mjs b/cli/template/extras/src/env/schema/with-auth.mjs
@@ -1,4 +1,3 @@
-// @ts-check
 import { z } from "zod";
 
 /**

diff --git a/cli/template/extras/src/env/schema/with-prisma.mjs b/cli/template/extras/src/env/schema/with-prisma.mjs
@@ -1,4 +1,3 @@
-// @ts-check
 import { z } from "zod";
 
 /**

diff --git a/cli/tsconfig.json b/cli/tsconfig.json
@@ -4,7 +4,8 @@
     "baseUrl": "./",
     "paths": {
       "~/*": ["./src/*"]
-    }
+    },
+    "checkJs": true
   },
   "include": ["src", ".eslintrc.cjs"]
 }
diff --git a/www/src/pages/en/faq.md b/www/src/pages/en/faq.md
@@ -46,7 +46,7 @@ Now, we realize this path doesn't work for everyone. So, if you feel like you've
 
 As per [T3-Axiom #3](/en/introduction#typesafety-isnt-optional), we take typesafety as a first class citizen. Unfortunately, not all frameworks and plugins support TypeScript which means some of the configuration files have to be `.js` files.
 
-We try to emphasize that these files are JavaScript for a reason, by explicitly declaring each file's type (`cjs` or `mjs`) depending on what's supported by the library it is used by. Also, all the `js` files in this project are still typechecked using a `@ts-check` comment at the top.
+We try to emphasize that these files are JavaScript for a reason, by explicitly declaring each file's type (`cjs` or `mjs`) depending on what's supported by the library it is used by. Also, all the `js` files in this project are still typechecked using a checkJs option in the compiler (tsconfig).
 
 ## I'm struggling to add i18n to my app. Is there any reference I can use?