vue-jest

What is vue-jest?

vue-jest is a Jest transformer for Vue single-file components (SFCs). It allows you to use Jest to test Vue components by transforming the .vue files into a format that Jest can understand.

What are vue-jest's main functionalities?

Transform Vue SFCs

This feature allows Jest to transform Vue single-file components (.vue files) so that they can be tested. The code sample shows how to configure Jest to use vue-jest for transforming .vue files.

module.exports = { transform: { '^.+\.vue$': 'vue-jest' } };

Mocking Vue Components

This feature allows you to mock Vue components and their dependencies during testing. The code sample demonstrates how to use vue-jest with @vue/test-utils to shallow mount a component and mock a translation function.

import { shallowMount } from '@vue/test-utils';
import MyComponent from '@/components/MyComponent.vue';

test('renders a message', () => {
  const wrapper = shallowMount(MyComponent, {
    mocks: {
      $t: msg => msg
    }
  });
  expect(wrapper.text()).toContain('Hello World');
});

Snapshot Testing

This feature allows you to perform snapshot testing on Vue components. The code sample shows how to use vue-jest with @vue/test-utils to create a snapshot of a component's rendered HTML and compare it to a saved snapshot.

import { shallowMount } from '@vue/test-utils';
import MyComponent from '@/components/MyComponent.vue';

test('matches snapshot', () => {
  const wrapper = shallowMount(MyComponent);
  expect(wrapper.html()).toMatchSnapshot();
});

Other packages similar to vue-jest

vue-test-utils

vue-test-utils is the official testing utility library for Vue.js. It provides methods to mount and interact with Vue components in tests. While vue-jest focuses on transforming .vue files for Jest, vue-test-utils provides a more comprehensive set of utilities for testing Vue components.

jest-vue-preprocessor

jest-vue-preprocessor is another Jest transformer for Vue single-file components. It is similar to vue-jest in that it transforms .vue files for Jest, but it is less commonly used and lacks some of the additional features and community support that vue-jest offers.

babel-jest

babel-jest is a Jest transformer that uses Babel to transform JavaScript files. While it is not specific to Vue, it can be used in conjunction with other tools to transform Vue components. It is more general-purpose compared to vue-jest, which is specifically designed for Vue SFCs.

README

vue-jest

A jest preprocessor for jest.

Usage

Add the following lines to your package.json

"jest": {
    "unmockedModulePathPatterns": [
        "<rootDir>/node_modules/vue"
    ],
    "moduleFileExtensions": [
        "js",
        "vue"
    ],
    "scriptPreprocessor": "index.js"
}

Then just see the __tests__ for some examples.

Problems

The mustache syntax is not working, and I have not figure why. So just use v-text and v-html with computed properties.