vite-vue-ts-template

extended version of vite's official vue-ts template.

additional features:

• Vue Devtools.
• eslint for linting.
• vitest + testing-library for testing.
• prettier + lefthook hook for code formatting.
• github actions for continuous integration.

Install

# install dependencies.
npm i

# (optional) install pre-commit hook.
npm run precommit:configure

Develop

npm run dev

Build

npm run build

Test

npm test

# run vitest in watch mode.
npm run test:watch

# collect coverage.
npm run test:coverage

Lint

npm run lint

Format

npm run fmt

Preview

Serves the content of ./dist over a local http server.

npm run preview

---

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.