Skip to content

Template for creating a library with a fully customized environment.

License

Notifications You must be signed in to change notification settings

hywax/vite-vanilla-library-template

Repository files navigation

Vite Vanilla Library Template

Template for creating a library with a fully customized environment.

Features

  • ✨ Fully customized eslint configuration based on the config by Antfu
  • 🧪 Write tests quickly and conveniently with vitest
  • 🤝 Supports conventional commits
  • 💅 Generate beautiful changelogs with changelogen
  • ♾️ GitHub CI for your build
  • 📢 Issue templates
  • 📝 Pull request template
  • 🤖 Ready configuration for renovatebot with renovate-config
  • 🚀 Library releases with just one command

Get started

GitHub Template

This is a template repo. Click the green Use this template button to get started.

Git Clone

git clone https://github.com/hywax/vite-vanilla-library-template.git
cd vite-vanilla-library-template
pnpm install

Usage

The template contains the following scripts:

  • dev - Start the development server
  • build - Build for production
  • release - Generate changelog and npm publish
  • lint - Checks your code for any linting errors
  • test - Run all tests
  • test:watch - Run all tests with watch mode
  • test:coverage - Run all tests with code coverage report
  • prepare - Script for setting up husky hooks

Used by

If you are using this template, feel free to open a PR to add your project to the list.

License

This template was created under the MIT License.