https://github.com/hywax/vite-vanilla-library-template

Template for creating a library with a fully customized environment.
https://github.com/hywax/vite-vanilla-library-template

eslint starter-template template typescript vanilla-js vite vitest

Last synced: 2 months ago
JSON representation

Template for creating a library with a fully customized environment.

• Host: GitHub
• URL: https://github.com/hywax/vite-vanilla-library-template
• Owner: hywax
• License: mit
• Created: 2023-12-29T11:33:43.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-11-05T19:04:31.000Z (3 months ago)
• Last Synced: 2024-11-07T08:42:49.901Z (2 months ago)
• Topics: eslint, starter-template, template, typescript, vanilla-js, vite, vitest
• Language: TypeScript
• Homepage:
• Size: 527 KB
• Stars: 26
• Watchers: 1
• Forks: 3
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

• fucking-awesome-vite - vite-vanilla-library-template - Starter template TypeScript, ESLint, Vitest, Husky, Conventional Commits, GitHub actions. (Get Started / Templates)
• awesome-vite - vite-vanilla-library-template - Starter template TypeScript, ESLint, Vitest, Husky, Conventional Commits, GitHub actions. (Get Started / Templates)

README

        
# Vite Vanilla Library Template

Template for creating a library with a fully customized environment.

## Features

* ✨ Fully customized [eslint](https://eslint.org/) configuration based on the config by [Antfu](https://github.com/antfu/eslint-config)

* 🧪 Write tests quickly and conveniently with [vitest](https://vitest.dev/)

* 🤝 Supports [conventional commits](https://www.conventionalcommits.org/)

* 💅 Generate beautiful changelogs with [changelogen](https://github.com/unjs/changelogen)

* ♾️ GitHub CI for your build

* 📢 Issue templates

* 📝 Pull request template

* 🤖 Ready configuration for [renovatebot](https://github.com/apps/renovate) with [renovate-config](https://github.com/hywax/renovate-config)

* 🚀 Library releases with just one command

## Get started

### GitHub Template

This is a template repo. Click the green [Use this template](https://github.com/hywax/vite-vanilla-library-template/generate) button to get started.

### Git Clone

```shell

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

* [vitepress-yandex-metrika](https://github.com/hywax/vitepress-yandex-metrika)

* [gotify-client](https://github.com/hywax/gotify-client)

* [lxc-idmapper](https://github.com/hywax/lxc-idmapper)

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](LICENSE).