Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/imomaliev/vue-ts
Vite + Vue + TypeScript template
https://github.com/imomaliev/vue-ts
eslint jest pre-commit prettier typescript vite vue
Last synced: 10 days ago
JSON representation
Vite + Vue + TypeScript template
- Host: GitHub
- URL: https://github.com/imomaliev/vue-ts
- Owner: imomaliev
- License: mit
- Created: 2021-07-27T14:30:32.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-21T23:37:32.000Z (15 days ago)
- Last Synced: 2024-10-22T20:37:20.372Z (15 days ago)
- Topics: eslint, jest, pre-commit, prettier, typescript, vite, vue
- Language: JavaScript
- Homepage: https://imomaliev.github.io/vue-ts/
- Size: 417 KB
- Stars: 27
- Watchers: 3
- Forks: 8
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://results.pre-commit.ci/latest/github/imomaliev/vue-ts/main)
# Vue 3 + TypeScript + Vite + Jest
This template should help get you started developing with Vue 3 and TypeScript in Vite. The template uses Vue 3 `` SFCs, check out the [script setup docs](https://vuejs.org/api/sfc-script-setup.html) to learn more.
## 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).
## Project setup
Clone project with [`degit`](https://github.com/Rich-Harris/degit)
```
degit user/repo
```
### Install dependencies
```
npm install
```
### Compiles and hot-reloads for development
```
npm run dev
```
### Compiles and minifies for production
```
npm run build
```
### Preview build
```
npm run serve
```
### Run your unit tests
```
npm run test
```
### Lint
```
npm run lint
```
### Fix files
```
npm run format
```
## Install pre-commit hooks
```
pre-commit install
```
## About
This project is created as a part of a [dev.to](https://dev.to) series [Creating vite vue ts template](https://dev.to/imomaliev/series/13845).