Skip to content

Latest commit

 

History

History
171 lines (123 loc) · 3.07 KB

README.md

File metadata and controls

171 lines (123 loc) · 3.07 KB
Raw

changelog License

vue-plugin-boilerplate

Boilerplate for vue 2&3 plugin development 🟩📦

GitHub stars

Sponsorship 💖
GitHub
Buy me a coffee

Features

  • 📦 Vue2 & Vue3 support
  • ⚡️ Optimized
  • 🦾 TypeScript support
  • 👶🏻 Easy
  • 🏗️ Module formats
  • 📁 Clean structure

Tech Stack

  • vue-demi for Vue2 & Vue3 support
  • Rollup
  • Pug
  • Scss
  • Typescript
  • Husky
  • Eslint
  • Stylelint
  • Prettier
  • Conventional Commit
  • Commitlint
  • Commitizen
  • Changelogen for release management

Installation

Clone this repo or create new repo from this template repo

git clone https://github.com/selimdoyranli/vue-plugin-boilerplate.git

Development

This project requires node 18.x.x version

Vue3

yarn build:vue3 # build for vue3
# Dev

cd dev/vue3

yarn install
yarn dev

Vue2

yarn build:vue2 # build for vue2
# Dev

cd dev/vue2

yarn install
yarn dev

Vue 2&3

yarn build # build for vue2 and vue3

Linter

# run eslint
yarn lint:eslint

# run eslint fix
yarn lint:eslint:fix

# run stylelint
yarn lint:stylelint

# run stylelint fix
yarn lint:stylelint:fix

# run prettier
yarn prettier

# check types
yarn type:check

Git

Using Conventional Commits, commitizen, commitizen cli

# add files
git add .

# generate commit message
yarn commit # or yarn cz

# push
git push

Release & Changelog

Using changelogen for release & changelog management, arguments are the same as changelogen

# run changelogen
yarn changelog

Sponsorship

You can sponsor me for the continuity of my projects:

License

MIT License

Copyright (c) selimdoyranli [email protected]