mockme-plugin-js

A mockme plugin to include mocks in JS files.

How to install

Install with NPM

1$ npm i -D @betheweb/mockme-plugin-js

Install with Bun

1$ bun add -D @betheweb/mockme-plugin-js

Install with PNPM

1$ pnpm add -D @betheweb/mockme-plugin-js

How to use it

Just import it in the mockme config file and add it to the plugins section.

1import mockmePluginJs from '@betheweb/mockme-plugin-js';
2
3export default {
4  plugins: [mockmePluginJs()],
5};

This plugin does not transform the code in the source files, so the mocks generated by them should follow the mockme mocks schema. If the file exports a function, the function will be invoked and the config will be passed to it.

Configuration

input

Input accepts either a single path or an array of paths where each of them points to a file. Paths can also be a glob expression.

Example:

1import mockmePluginJs from '@betheweb/mockme-plugin-js';
2
3export default {
4  plugins: [
5    mockmePluginJs({
6      input: ['demo/mocks.js', 'fixtures/*.mock.js'],
7    }),
8  ],
9};

Mock files

These are examples of files that will return valid mocks:

Example of single mock object:

1export default {
2  request: {
3    method: 'GET',
4    path: '/api/v1/books/:id',
5  },
6  response: ({ params }) => {
7    if (params.id < 0) {
8      return {
9        body: { message: `Id ${params.id} is not a valid identifier.` },
10        status: 404,
11      };
12    } else {
13      return {
14        body: { id: params.id, title: 'Mr. Fox' },
15      };
16    }
17  },
18};

Example of multiple mock objects:

1export default [
2  {
3    tags: ['foo', 'bar'],
4    request: {
5      method: 'GET',
6      path: '/api/v1/books/:id',
7    },
8    response: ({ params }) => ({
9      body: {
10        id: params.id,
11        title: 'Mr. Fox',
12      },
13    }),
14  },
15  {
16    request: {
17      method: 'GET',
18      path: '/api/v2/books/:id',
19    },
20    response: ({ params }) => ({
21      body: {
22        id: params.id,
23        title: 'Mr. Fox',
24        pages: 123,
25      },
26    }),
27  },
28];

Example using a function to generate mocks:

1export default function (config) {
2  return [
3    { id: 1, title: 'Mr. Fox' },
4    { id: 2, title: 'Harry Potter' },
5  ].map(({ id, title }) => ({
6    request: { method: 'GET', path: `/api/v1/books/${id}` },
7    response: { body: { id, title } },
8  }));
9}