README.md

Note

This is a template for creating a new Vue 3 composable. It includes a basic structure for the composable, testing, documentation, and playgrounds. If you encounter any issue please open an issue on GitHub.

🪝 vue-composable-starter

A minimalist starting point for your next Vue 3 composable.

• 🧩 TypeScript by default
• 📦 PNPM as package manager
• 🤹 Testing using Vitest
• ☑️ Linting using @antfu/eslint-config
• 🌐 Nuxt 3 as a playground
• 📸 Playgrounds using Vite and Nuxt
• 🚚 Built using unbuild
• 📚 Documentation using Vitepress

Workflow

1. Install the dependencies

pnpm install

2. Develop your composable

pnpm dev:nuxt

3. Test your composable

pnpm test

To-Do

• Edit package.json name, description, repository and author keys.
• Rename all vue-composable-starter with your package name.
• Rename VueComposableStarterPluginOptions with your plugin options.
• Edit README.md.
• Implement your composable.
• Test your composable.
• Document your composable. pnpm docs:dev
• Publish

Contributing

You are more than welcome to improve this starter template.

Just submit your changes via pull request.

If you are making a fix on the template, you can use the main branch and send a pull request.