using a tsconfig.json file with cucumber-js

When using cucumber-js with TypeScript, I can’t figure out how to get a tsconfig.json to take effect.

cucumber version: 5.0.0 node version: v8.11.3 os: OS X El Capitan 10.11.6

At my project’s root, I’ve got a package.json that contains:

{
  "name": "...",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test-features": "cucumber-js test/features --require-module ts-node/register --require 'test/features/**/*.ts'",
    ...

Also at project root, a tsconfig.json file that contains something like:

{
  "compilerOptions": {
    "baseUrl": ".", // This must be specified if "paths" is.
    "paths": {
      "*": [
        "src/commands/*"
      ] // This mapping is relative to "baseUrl"
    }
  }
}

To run cucumber, I type npm run test-features

Issue Analytics

State:
Created 5 years ago
Comments:23 (4 by maintainers)

Top GitHub Comments

3reactions

adamf321commented, Feb 23, 2022

In case any else stumbles upon this trying to get baseUrl to work with ts-node / cucumber-js…

You need to create a setup file:

// cucumber.setup.js

require("ts-node").register({
  transpileOnly: true,
  require: ["tsconfig-paths/register"],
  compilerOptions: {
    "module": "commonjs",
    "resolveJsonModule": true,
    "baseUrl": ".",
  },
});

require: ["tsconfig-paths/register"] was the part which tripped me up.

Then reference it in your cucumber config file:

// cucumber.js

module.exports = {
  default: [
    "--require cucumber.setup.js",
    "--require tests/bdd/**/*.ts",
    "--publish-quiet",
  ].join(" "),
};

3reactions

scotch83commented, Sep 24, 2020

@arjunjh10