MyAwesomePlugin

A Vue.js Plugin

Installation

npm install --save my-awesome-plugin

Usage

Bundler (Webpack, Rollup)

import Vue from 'vue'
import MyAwesomePlugin from 'my-awesome-plugin'
// You need a specific loader for CSS files like https://github.com/webpack/css-loader
import 'my-awesome-plugin/dist/my-awesome-plugin.css'

Vue.use(MyAwesomePlugin)

Browser

<!-- Include after Vue -->
<!-- Local files -->
<link rel="stylesheet" href="my-awesome-plugin/dist/my-awesome-plugin.css"></link>
<script src="my-awesome-plugin/dist/my-awesome-plugin.js"></script>

<!-- From CDN -->
<link rel="stylesheet" href="https://unpkg.com/my-awesome-plugin/dist/my-awesome-plugin.css"></link>
<script src="https://unpkg.com/my-awesome-plugin"></script>

Development

Launch visual tests

npm run dev

Launch Karma with coverage

npm run dev:coverage

Build

Bundle the js and css of to the dist folder:

npm run build

Publishing

The prepublish hook will ensure dist files are created before publishing. This way you don't need to commit them in your repository.

# Bump the version first
# It'll also commit it and create a tag
npm version
# Push the bumped package and tags
git push --follow-tags
# Ship it 🚀
npm publish

License

MIT