docs: note about IDE support, close #6

Author: antfu

README.md

@@ -86,15 +86,32 @@ const Vue2SFC = transform(`
 `)
 ```
 
+## IDE
+
+We recommend using [VS Code](https://code.visualstudio.com/) with [Volar](https://github.com/johnsoncodehk/volar) to get the best experience (You might want to disable Vetur if you have it).
+
+When using Volar, you will need to install `@vue/runtime-dom` as devDependencies to make it work on Vue 2.
+
+```bash
+npm i -D @vue/runtime-dom
+```
+
+[Learn more](https://github.com/johnsoncodehk/volar#using)
+
+###### ESLint
+
+If you are using ESLint, you might get `@typescript-eslint/no-unused-vars` warning with `<script setup>`. You can disable it and add `noUnusedLocals: true` in your `tsconfig.json`, Volar will infer the real missing locals correctly for you. 
+
 ## Status
 
-- [x] POC
+- [x] PoC
 - [x] Components registration
 - [x] Compile time macros `defineProps` `defineEmits` `withDefaults`
+- [x] Global types
 - [x] Merge with normal scripts
 - [x] Vite plugin
 - [x] Webpack plugin
-- [x] Global types
+- [x] Nuxt module
 - [ ] Top-level await
 
 ## How?

examples/nuxt/package.json

@@ -16,6 +16,7 @@
     "@nuxt/types": "^2.15.8",
     "@nuxt/typescript-build": "^2.1.0",
     "@nuxtjs/composition-api": "^0.27.0",
+    "@vue/runtime-dom": "^3.2.4",
     "vue2-script-setup-transform": "workspace:*"
   }
 }

examples/nuxt/tsconfig.json

@@ -10,6 +10,7 @@
     ],
     "esModuleInterop": true,
     "allowJs": true,
+    "noUnusedLocals": true,
     "sourceMap": true,
     "strict": true,
     "noEmit": true,

package.json

@@ -56,6 +56,7 @@
     "@types/jest": "^27.0.1",
     "@types/node": "^16.7.1",
     "@vue/composition-api": "^1.1.1",
+    "@vue/runtime-dom": "^3.2.4",
     "bumpp": "^6.0.6",
     "eslint": "^7.32.0",
     "eslint-plugin-jest": "^24.4.0",