Monorepo project template for developing vue3.x compatible libraries.
Pre-setup project for behavior validation and documentation.
✔️ 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
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 |
package name | version | remarks |
---|---|---|
vue | ^3.2.47 | |
typescript | ^5.0.2 | |
vite | ^4.3.8 | |
package name | version | remarks |
---|---|---|
nuxt | ^3.5.1 | |
@takuma-ru/vue-library-docs | ^1.3.0 |
We use volta to manage node and yarn versioning.
yarn
yarn dev:lib
yarn build:lib
You can run the vite+vue3 project created in examples/demo to check the operation of the built package.
yarn dev:demo
- Create a new npm access token. Document
- Set the token to the
NPM_TOKEN
secret in the repository settings. Document - Set the token to the
USER_EMAIL
secret in the repository settings. This token is used to set the author of the commit.
Without thinking, check out the branch and get to work.
(Don't work on the main branch!)
Once the implementation is complete, create a 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!
none
none
This template was created by @takuma-ru