Vue 3 + Typescript + Vite

This template should help get you started developing with Vue 3 and Typescript in Vite.

Recommended IDE Setup

VSCode + Vetur. Make sure to enable vetur.experimental.templateInterpolationService in settings!

If Using <script setup>

<script setup> is a feature that is currently in RFC stage. To get proper IDE support for the syntax, use Volar instead of Vetur (and disable Vetur).

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 use the following:

If Using Volar

Run Volar: Switch TS Plugin on/off from VSCode command palette.

If Using Vetur

1. Install and add @vuedx/typescript-plugin-vue to the plugins section in tsconfig.json
2. Delete src/shims-vue.d.ts as it is no longer needed to provide module info to Typescript
3. Open src/main.ts in VSCode
4. Open the VSCode command palette
5. Search and run "Select TypeScript version" -> "Use workspace version"

Committing, releasing and publishing

Pre-requisites

Add NPM publish key as "NPM_SECRET" in Github repository secrets.

Commits

Since release versioning is based on commits, those need to respect conventional commits standard.
When you are ready to commit, use npm run commit and follow the instructions from commitizen.

Release

To release, use npm run release, and push like you would normally, without publishing yet. (This updates package.json, package-lock.json and CHANGELOG.md)
Take note of the new version.

Publishing

To publish, manually create a new release from the Github repository main page, using the release tag given at the release step.
A package will be built from the lib and uploaded to the NPM registry.