Skip to main content

Getting started

Adding specflow-emulator on your project​

// with npm
$ npm install -D specflow-emulator

// or with yarn
$ yarn add -D specflow-emulator

// or with pnpm
$ pnpm add -D specflow-emulator

Configuration​

Under the hood

To make specflow-emulator work, we use jest-cucumber under the hood, we only provide support for Jest and Vitest

Vitest​

Using vitest, you have to add some configuration on vite.config.js:

export default defineConfig({
  test: {
    globals: true,
    include: [
      "**/*.{test,spec}.{js,mjs,cjs,ts,mts,cts,jsx,tsx}",
      "**/*.steps.js",
    ],
    environment: "choose your environnement here" // see: https://vitest.dev/guide/environment.html,
    setupFiles: ["./setupTests.js"],
    watch: true,
    deps: {
      inline: ["specflow-emulator"],
    },
  },
});

Then setup your setup test file like this :

import { loadSteps } from "specflow-emulator";

await loadSteps();

Jest​

Using jest, you have to had some configuration on your package.json or your jest.config.js:

"jest": {
"transformIgnorePatterns": [
      "node_modules/(?!specflow-emulator)/"
    ],
    "testMatch": [
      "**/__tests__/**/*.[jt]s?(x)",
      "**/?(*.)+(spec|test|steps).[jt]s?(x)"
    ],
}

Then setup your setup test file like this :

import { loadStepsJest } from "specflow-emulator";

loadStepsJest();

Does this work with Vue/React​

Yes, nothing is related with Vue.js or React.js, you can do some test with them.

Examples here : React / Javascript Examples