https://github.com/wtnabe/example-vue-ts-fc-jsx
ViteとVue 3でTypeScriptとJSXを利用したFnuctional Componentを書いてみるテスト
https://github.com/wtnabe/example-vue-ts-fc-jsx
jsdoc jsx typescript vue
Last synced: 4 months ago
JSON representation
ViteとVue 3でTypeScriptとJSXを利用したFnuctional Componentを書いてみるテスト
- Host: GitHub
- URL: https://github.com/wtnabe/example-vue-ts-fc-jsx
- Owner: wtnabe
- License: mit
- Created: 2023-05-05T02:13:54.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-12T11:53:43.000Z (8 months ago)
- Last Synced: 2024-11-13T09:44:43.207Z (6 months ago)
- Topics: jsdoc, jsx, typescript, vue
- Language: Vue
- Homepage:
- Size: 41 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Vue 3 + TypeScript + JSX + Vite + JSDoc sample project
## 実現したこと
* Vite x Vue 3 x JSX x TypeScript の環境
* JSDoc x JSX x TypeScript の環境
* Functional Component に対するそれっぽい JSDoc ドキュメンテーション
* type annotation を含まない `.vue` に対する JSDoc ドキュメンテーション
Functional Component に対する JSDoc ドキュメンテーションは Vue だけでなく React など他のプロジェクトでも使えるはず
### 実現していないこと
`.vue` に対して TypeScript を書きつつ JSDoc で parse できるようにすること（JavaScript に対してはドキュメントを書ける）
## 追加した設定
* npm create vite で vue-ts のプロジェクトをセットアップ
* vite plugin で `@vitejs/plugin-vue-jsx` を追加
* README では `defineComponent` を利用していないと JSX が書けないように読めるが、実際には Functional Component でも動作する
* `vite@^2` では動作しないので `vite@^3` 以上に上げる（これを書いている時点で vite の最新メジャーバージョンは 4）
* `tsconfig.json` に jsx 関連の項目を Vue で処理するように設定
* JSDoc でも TypeScript と JSX を処理できるように `jsdoc-babel` plugin と babel の設定を追加
* `@babel/preset-typescript` + `tsconfig.json` で `.tsx` は処理できるが `.jsx` は処理できないので `@babel/plugin-syntax-jsx` も添える
* JSDoc で `.vue` に対する特別な tag を追加する `jsdoc-vue3js` を追加
## Recommended IDE Setup
- [VS Code](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar)
## Type Support For `.vue` Imports in TS
Since TypeScript cannot handle type information for `.vue` imports, they are shimmed to be a generic Vue component type by default. In most cases this is fine if you don't really care about component prop types outside of templates. However, if you wish to get actual prop types in `.vue` imports (for example to get props validation when using manual `h(...)` calls), you can enable Volar's Take Over mode by following these steps:
1. Run `Extensions: Show Built-in Extensions` from VS Code's command palette, look for `TypeScript and JavaScript Language Features`, then right click and select `Disable (Workspace)`. By default, Take Over mode will enable itself if the default TypeScript extension is disabled.
2. Reload the VS Code window by running `Developer: Reload Window` from the command palette.
You can learn more about Take Over mode [here](https://github.com/johnsoncodehk/volar/discussions/471).