README

@amjs/vue-tools

npm

Provides development tools for VueJS based projects with Webpack4 and JEST.

Installation

$ npm i --save @amjs/vue-tools

Usage

Add following scripts to package.json file:

{
    "scripts": {
       "dev": "NODE_ENV=dev node node_modules/@amjs/vue-tools/scripts/server.js",
       "build": "NODE_ENV=pro node node_modules/@amjs/vue-tools/scripts/build.js",
       "test": "NODE_ENV=test node node_modules/@amjs/vue-tools/scripts/jest.js",
       "format": "prettier --config node_modules/@amjs/vue-tools/.prettierrc --write 'src/**/*.js'",
       "lint:css": "sass-lint --config node_modules/@amjs/vue-tools/.sass-lint.yml -v",
       "lint:js": "eslint --fix --config node_modules/@amjs/vue-tools/.eslintrc.yml --ext .js src tests",
       "e2e": "node node_modules/@amjs/vue-tools/scripts/e2e chrome && node node_modules/.bin/nightwatch"
    }
}

Tools

@amjs/vue-tools provides a set-up of tools to use in any VueJS project.

VueJS configuration

Just add following line to project's entry point:

import '@amjs/vue-tools/config/vue';

Fetch mock for tests

Just add following line to test file:

import '%/tests/utils/fetch';

VueJS instance renderer for tests

// test file
import renderer from '%/tests/utils/renderer';
import MyComponent from 'my-component-path';

// Create a snapshot:
it('Snapshot', async () =>
    expect(await renderer(MyComponent, null, true)).toMatchSnapshot());

// Create instance
it('Instance', async () =>
{
    const props = {
        key: 'value'
    };
    const inst = await renderer(MyComponent, props);
    expect(inst.key).toBe('value');
});

Usage no npm install needed!