https://github.com/naftali100/vue-tooling-template
vue template with complete tooling setup (typescript, tailwind, vitest, eslint, prettier, lint-staged)
https://github.com/naftali100/vue-tooling-template
dx template tooling vue vue3
Last synced: 12 months ago
JSON representation
vue template with complete tooling setup (typescript, tailwind, vitest, eslint, prettier, lint-staged)
- Host: GitHub
- URL: https://github.com/naftali100/vue-tooling-template
- Owner: naftali100
- License: mit
- Created: 2023-07-30T09:45:59.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-28T15:36:13.000Z (about 2 years ago)
- Last Synced: 2025-03-31T11:42:50.133Z (about 1 year ago)
- Topics: dx, template, tooling, vue, vue3
- Language: Vue
- Homepage:
- Size: 564 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# vue-tooling-template
## Based on `pnpm create vue@latest`
This template should help get you started developing with Vue 3 in Vite.
## Recommended IDE Setup
[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin).
## Type Support for `.vue` Imports in TS
TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking. In editors, we need [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin) to make the TypeScript language service aware of `.vue` types.
If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a [Take Over Mode](https://github.com/johnsoncodehk/volar/discussions/471#discussioncomment-1361669) that is more performant. You can enable it by the following steps:
1. Disable the built-in TypeScript Extension
1. Run `Extensions: Show Built-in Extensions` from VSCode's command palette
2. Find `TypeScript and JavaScript Language Features`, right click and select `Disable (Workspace)`
2. Reload the VSCode window by running `Developer: Reload Window` from the command palette.
## Customize configuration
See [Vite Configuration Reference](https://vitejs.dev/config/).
## Project Setup
```sh
pnpm install
```
### Compile and Hot-Reload for Development
```sh
pnpm dev
```
### Type-Check, Compile and Minify for Production
```sh
pnpm build
```
### Run Unit Tests with [Vitest](https://vitest.dev/)
```sh
pnpm test
```
### Lint with [ESLint](https://eslint.org/)
```sh
pnpm lint
```
### Format with [Prettier](https://prettier.io/)
```sh
pnpm format
```