My personal repo template for developing Vue 3 libraries in a monorepo powered by pnpm workspaces
STATE: Still working on this here and ther, but it's working fine, usually
This is a template to use for new Vue 3 library projects. It comes with a lot of useful stuff pre-configured because I'm lazy.
This template is primarily meant for myself (but you can of course you it any way you please!). I wanted a template to quickly reach for when I want to start a new Vue project, especially for libraries.
As such, it is pretty opinionated, and probably does some things in way you don't like, or is missing something you deem essential. That's fine. Fork it and make it your own :)
- ✅ Full Typescript support for the whole dev workflow
- ⚡️ Ergonomic and easy workflow completely powered by Vite & PNPM:
- 🎯 Build your libraries with Vite
- ⛱️ Typechecking & Generating declaration files with
vue-tsc(https://github.com/johnsoncodehk/volar/tree/master/vue-language-tools/vue-tsc) - 🏈 Integrated playground app powered by Vite as well
- 💊 Unit Tests with Vitest
- 🖍 Linting with
eslintandprettier- [PLANNED] linting & fixing for staged files (
lint-staged)
- [PLANNED] linting & fixing for staged files (
- 📚 Documentation powered by Vitepress
- Ready to be deployed to Netlify
see Github wiki: ...(TBD)
All commands can be run directly from the project root like:
pnpm startWe use pnpm to run commands in individual workspaces as needed.
Build everything: library packages, docs and playground app
starts the Vite dev server for the playground app for testing playing around with your libraries manually.
During play, no bundling has to be done as all of the library package's code is compiled JIT in the playground app.
This app can also be used for end-to-end tests (tooling for that currently not included in this template)
Run eslint on all packages
Run vitest unit tests on all packages. Tests will start in watch mode by default. To ru tests once, you can run test-ci instead.