Wikibase Vue.js Components

A Vue.js component library used in Wikibase projects, inspired by OOUI.

Usage

Installation

Run npm i --save @wmde/wikibase-vuejs-components and ensure you have all necessary peer dependencies installed.

Import

In your style entry point(s), e.g. _main.scss, add

@import '~@wmde/wikibase-vuejs-components/dist/wikibase-vuejs-components.css';

This will import styles for all components included in the library.

Then you can import components, e.g.

import { IndeterminateProgressBar } from '@wmde/wikibase-vuejs-components';

Storybook

You can see the available components and their usage examples at the storybook on doc.wikimedia.org, which is automatically built from the master branch.

Building Docker image

# ensure the node user uses your user id, so you own generated files
docker-compose build --build-arg UID=$(id -u) --build-arg GID=$(id -g) node

# install npm dependencies
docker-compose run --rm node npm install

Development

Run all code quality tools

• docker-compose run --rm node npm test

Run code quality tools individually

• docker-compose run --rm node npm run test:unit runs all unit tests
• docker-compose run --rm node npm run test:lint for linting, docker-compose run --rm node npm run fix for fixing auto-fixable lint errors

Developing with Storybook

There are storybook previews of all components, and new stories should be added for any newly added components. You can run the storybook as follows: docker-compose up storybook

Release a new version

1. Bump the version number in package.json and package-lock.json. You can either edit both files manually, or only edit package.json and let npm install update the lock file.
2. Commit the version number change. The usual commit message is “Bump version to new version”.
3. Push it to Gerrit, and wait for it to be reviewed and merged.
4. Create a new tag, named after the version number with a “v” prefix, e. g. v1.2.3. If you feel like it, you can include a message indicating the changes since the last version (git tag -a v1.2.3), but it can also be a lightweight tag (git tag v1.2.3).
5. Push the tag to Gerrit. It will be automatically mirrored to GitHub, where it will trigger a workflow which will automatically publish the release to NPM.