docs: add notes about Nuxt with TS

Author: antfu

README.md

@@ -62,6 +62,37 @@ export default {
 
 Example: [`examples/nuxt`](./examples/nuxt)
 
+###### TypeScript
+
+To use TypeScript with Nuxt, install the [`@nuxtjs/typescript-module`](https://typescript.nuxtjs.org/) but disable the type check:
+
+```bash
+npm i -D @nuxt/typescript-build vue-tsc
+```
+
+```ts
+// nuxt.config.js
+export default {
+  buildModules: [
+    ['@nuxt/typescript-build', { typeCheck: false }],
+    '@nuxtjs/composition-api/module',
+    'vue2-script-setup-transform/nuxt',
+  ],
+}
+```
+
+And then use [`vue-tsc`](https://github.com/johnsoncodehk/volar) to do the type check at build time:
+
+```jsonc
+// package.json
+{
+  "scripts": {
+    "dev": "nuxt",
+    "build": "vue-tsc --noEmit && nuxt build",
+  }
+}
+```
+
 <br></details>
 
 <details>

examples/nuxt/nuxt.config.js

@@ -1,7 +1,10 @@
 export default {
   buildModules: [
-    '@nuxt/typescript-build',
+    // we disable the type check and left it to `vue-tsc`
+    ['@nuxt/typescript-build', { typeCheck: false }],
+    // @vue/composition-api support
     '@nuxtjs/composition-api/module',
+    // install the transformer
     'vue2-script-setup-transform/nuxt',
   ],
 }

examples/nuxt/package.json

@@ -3,7 +3,7 @@
   "private": true,
   "scripts": {
     "dev": "nuxt",
-    "build": "nuxt build",
+    "build": "vue-tsc --noEmit && nuxt build",
     "start": "nuxt start",
     "generate": "nuxt generate"
   },
@@ -16,6 +16,7 @@
     "@nuxt/typescript-build": "^2.1.0",
     "@nuxtjs/composition-api": "^0.27.0",
     "@vue/runtime-dom": "^3.2.4",
+    "vue-tsc": "^0.3.0",
     "vue2-script-setup-transform": "workspace:*"
   }
 }

examples/nuxt/tsconfig.json

@@ -9,6 +9,7 @@
       "DOM"
     ],
     "esModuleInterop": true,
+    "skipLibCheck": true,
     "allowJs": true,
     "sourceMap": true,
     "strict": true,
@@ -24,7 +25,8 @@
     },
     "types": [
       "@types/node",
-      "@nuxt/types"
+      "@nuxt/types",
+      "vue2-script-setup-transform/types"
     ]
   },
   "exclude": [