takuma-ru / vue-lib-template

Template for library development that includes a "Vue3-specific" demo project and a document project

vue-lib-template

Description

Monorepo project template for developing vue3.x compatible libraries.
Pre-setup project for behavior validation and documentation.

📦 Features

✔️ Library development based on .vue files

✔️ Pre-built build configuration

✔️ Publish flow to pre-built npm (by release-it)

✔️ Prebuilt eslint, prettier, stylint configurations

✔️ Pre-built verification environment

✔️ Pre-built documentation projects

🚧 Revamped document page UI

📆 Construction of nuxt3 verification environment

📆 Establishment of test environment

✔️ = Available
🚧 = Work in progress
📆 = Planned

📌 Dependencies / DevDependencies

packages/lib

package name	version	remarks
vue	^3.3.4
sass	^1.62.1
typescript	^5.0.2
vite	^4.3.8
rollup-plugin-typescript2	^0.34.1
vite-plugin-css-injected-by-js	^3.1.1
eslint	^8.41.0	eslint settings
prettier	^3.0.0	prettier settings
stylelint	^15.10.1	stylelint settings

examples/demo

package name	version	remarks
vue	^3.2.47
typescript	^5.0.2
vite	^4.3.8

docs

package name	version	remarks
nuxt	^3.5.1
@takuma-ru/vue-library-docs	^1.3.0

🎉 Installation

0. Click to "Use this template"

1. Install Volta

We use volta to manage node and yarn versioning.

2. Install

yarn

🔨 Development

1. Library Development

yarn dev:lib

2. Build Library

yarn build:lib

3. Operation check

You can run the vite+vue3 project created in examples/demo to check the operation of the built package.

yarn dev:demo

🚀 How to Release package

1. Set Github Secret

1. Create a new npm access token. Document
2. Set the token to the NPM_TOKEN secret in the repository settings. Document
3. Set the token to the USER_EMAIL secret in the repository settings. This token is used to set the author of the commit.

3. Push

Without thinking, check out the branch and get to work.
(Don't work on the main branch!)

4. Create Pull Request

Once the implementation is complete, create a pull request.

5. Merge Pull Request

Once the review is complete, merge.
Merge comments should be changed manually.

• major update: 🚀 bump up version major
• minor update: 🚀 bump up version minor
• patch update: 🚀 bump up version patch

Once merged, release-it CI is automatically executed.
a few moments later....
The package should be released to npm!

Deploy Service

none

ScreenShots

none

---

This template was created by @takuma-ru