junwu-cover-editor v0.0.3
CoverComponents
Semantic Versioning
- MAJOR version when you make incompatible API changes,
- MINOR version when you add functionality in a backwards compatible manner, and
- PATCH version when you make backwards compatible bug fixes.
Example: v1.10.20; 1 is major, 10 is minor and 20 is patch.
Updating the package
We use github actions to automate publishing the package. When we increment the version we base it on the commit message:
To increment version we should follow:
- git commit -m "major: < message_here >"
- git commit -m "minor: < message_here >"
- git commit -m "patch: < message_here >"
Example: git commit -m "minor: adding new icon"
To skip version bump and publish, commit message should contain 'skip'.
Example: git commit -m "skip updating README.md"
if commit message does not include either 3 keywords. It will not trigger publish.
please avoid using major, minor or patch wordings except as a prefix in your commit message
Using the package
1. Add .npmrc
@covergo:registry=https://npm.pkg.github.com/
//npm.pkg.github.com/:_authToken=<token_here>
To get your token: https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/creating-a-personal-access-token and make sure you have
read:packages
enabled when you generate your token
2. Installation
npm -i @covergo/cover-components
3. main.js
import { variants } from "@/setups/variants" // folder containing your js variant files
import { makeGetComponentVariants } from "@covergo/cover-components"
app.provide("getComponentVariants", makeGetComponentVariants({ variants }))
4. vue.config.js
By default, babel-loader excludes files inside node_modules dependencies. If you wish to explicitly transpile a dependency module, you will need to add it to the transpileDependencies option in vue.config.js.
https://cli.vuejs.org/core-plugins/babel.html
module.exports = {
transpileDependencies: ["@covergo/cover-components"],
}
5. Importing
import { JButton } from "@covergo/cover-components"