Write unit tests against your Vue components using mocha and vue-test-utils
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib
src
test
.babelrc
.gitignore
LICENSE
README.md
core.js
index.js
package-lock.json
package.json
setup.js
webpack.config.js

README.md

vunit - Vue unit testing tools

Description

Unit testing for Vue components. This tool allows you to easily test your Vue components using mocha and vue-test-utils. It is based on the following documents:

Installation

npm install --save-dev @rei/vunit

Basic Usage

Running Unit Tests

npx vunit --spec=<glob-to-specs> [--watch]

Running Test Coverage

npx vunit --spec=<glob-to-specs> --coverage [--watch]

Creating Unit Tests

See the vue-test-utils documentation for creating unit tests using vue-test-utils.

Create your spec files via mocha syntax.

Update npm test Script(s)

Add test script to your package.json:

{
    ...
    "scripts": {
        "test": "vunit --spec=<glob-to-specs>"
    },
    ...
}

Command-line Options

The following options are available to the tool:

spec:               {String}    The path glob to your Vue unit tests (required)
webpack-config:     {String}    The path to your webpack.config.js (optional)
watch:              {String}    Comma-separated list of directories to watch for changes, e.g. 
--watch=src,test (optional).
coverage:           {None}      Flag indicating whether or not to run coverage.

Programmatic API

To use package via programmatic API, just require the module and call the exposed run command with above options passed in as an object:

const vunit = require('vunit');
vunit.run({
    spec: '/glob/to/specs',
    ...
});