@vzellweg-org/osu-vue-component-library v1.2.0

osu-vue-component-library

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

Recommended IDE Setup

VSCode + Volar (and disable Vetur).

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 Volar to make the TypeScript language service aware of .vue types.

Customize configuration

See Vite Configuration Reference.

Project Setup

yarn install

Compile and Hot-Reload for Development

yarn run dev

Type-Check, Compile and Minify for Production

yarn run build

Run Unit Tests with Vitest

yarn run test:unit

Run End-to-End Tests with Cypress

yarn run test:e2e:dev

This runs the end-to-end tests against the Vite development server. It is much faster than the production build.

But it's still recommended to test the production build with test:e2e before deploying (e.g. in CI environments):

yarn run build
yarn run test:e2e

Lint with ESLint

yarn run lint

Library Setup

Build Library

yarn build-lib

Linking to a Local Repo During Development

When making changes to this repo, you may want to test it's integrations with other projects on your system.

In the osu-vue-component-library project directory, run:

yarn link

This creates the global link id osu-vue-component-library in your system

Navigate to the directory of the project you wish to reference the updated library, then run:

yarn link osu-vue-component-library

TODO: Deploy Library

Coming Soon...