How to debug Cucumber in Visual Studio Code (VSCode)?

Question

I was trying to debug Cucumber scenarios in Visual Studio code and made below changes in the launch.json.

{
            "name": "e2e",
            "type": "node",
            "request": "launch",
            "program": "${workspaceRoot}\\node_modules\\.bin\\cucumber-js",
            "stopOnEntry": false,
            "args": ["--no-timeouts", "--colors"],
            "cwd": "${workspaceRoot}",
            "runtimeExecutable": null,
            "outFiles": [
                "${workspaceRoot}\\features\\step_definitions\\*.js"
            ]
},

However, I am not able run a debug session using the above configuration. The step def. files I created in JavaScript. So, just need a help on the script above if that looks fine?

Breakpoint somewhere in the code! The question above is to validate my config. script in `launch.json` for cucumber. Hope it is clear to you now.. — , Oct 19 '17 at 16:18

score 15 · Accepted Answer · edited Oct 30 '18 at 14:58

You could try below configuration to make your debug working in VS Code. In the outFiles give your feature file path.

{
    "name": "e2e",
    "type": "node",
    "request": "launch",
    "program": "${workspaceRoot}/node_modules/cucumber/bin/cucumber.js",
    "outFiles": [
        "${workspaceRoot}/features/*.feature"
    ]
}

============================================
UPDATE AS OF cucumber ^5.0.2:

{
    "name": "NPM Cukes",
    "type": "node",
    "request": "launch",
    "console": "integratedTerminal",
    "program": "${workspaceRoot}/node_modules/cucumber/bin/cucumber-js",
    "args": [
        "path/to/features/**/*.feature",
        "-r",
        "path/to/steps/**/*",
        "--tags",
        "@your-tags"
    ]
}

If you want to debug only CURRENT feature, add this to launch.json

{
    "type": "node",
    "request": "launch",
    "program": "${workspaceFolder}/node_modules/.bin/cucumber-js",
    "args": ["${relativeFile}"],
    "name": "Cukes current",
    "console": "integratedTerminal",
    "internalConsoleOptions": "neverOpen",
    "windows": {
        "program": "${workspaceFolder}/node_modules/cucumber/bin/cucumber"
    }
}

the program has now moved (my version is 7.3.2) to `@cucumber/cucumber`. — iamsimonsmale, Mar 08 '22 at 08:55

Benny Meade · Answer 2 · 2019-02-03T16:24:27.890

Tweaking the answer from Mukesh Rawat plus ensuring additional file paths were correct, got it working for me, :

Launch.json

{
    "name": "DebugMode",
    "type": "node",
    "request": "launch",
    "program": "${workspaceRoot}/node_modules/cucumber/bin/cucumber-js",
    "args": [
        "${workspaceRoot}/features/*.feature",
        "--tags", "@debug"
    ]
}

Workspace.json

{
    "cucumberautocomplete.steps": [
        "features/steps/*.js"
    ],
    "cucumberautocomplete.syncfeatures": "features/*.feature",
    "cucumberautocomplete.strictGherkinCompletion": true,
    "settings": {},
    "folders": [
        {
            "path": "/Users/{me}/Documents/{project folder}/{project name}"
        }
    ]
}

Package.json

"scripts": {
    "debug": "node --inspect=1337 --debug-brk --nolazy node_modules/cucumber/bin/cucumber-js --tags @debug --format json:./reports/report.json",

CucumberTest.feature

@debug
Scenario: Validate I can get debug working

score 3 · Answer 3 · edited Mar 15 '18 at 00:22

3

When working with Ruby, it could be used on this way to run specific feature files:

{
    "name": "Cucumber",
    "type": "Ruby",
    "request": "launch",
    "cwd": "${workspaceRoot}",
    "program": "${workspaceRoot}/bin/cucumber",
    "args": [
        "--tags", "@Mytags",
        ]
}

edited Mar 15 '18 at 00:22

Stephen Rauch

47,830
31
106
135

answered Mar 15 '18 at 00:00

Marco De Jesus

31
4

score 0 · Answer 4 · edited Aug 29 '20 at 12:22

0

This works

{
    "name": "DebugMode",
    "type": "node",
    "request": "launch",
    "program": "${workspaceRoot}/node_modules/cucumber/bin/cucumber-js",
    "args": [
        "${workspaceRoot}/features/*.feature",
        "--tags", "@debug"
    ]
}

edited Aug 29 '20 at 12:22

General Grievance

4,555
31
31
45

answered Aug 29 '20 at 04:21

Jagadeesh

41
1
8

score 0 · Answer 5 · answered Jul 09 '22 at 21:01

Here's the simplest way I've found to run Cucumber.js in the VS Code debugger:

Set JavaScript debugger auto attach to "onlyWithFlag" (Ctrl+Shift+P, type "Toggle Auto Attach")
Run Cucumber.js as follows: node --inspect ./node_modules/.bin/cucumber-js <args...>
For convenience, set an NPM run script in your test project for "debug" so you can run this as npm run debug -- <args...>

score 0 · Answer 6 · answered Jan 23 '23 at 20:41

with the latest Cucumber, Playwright, typescript as of January 2023 - F5 (run in VSCode) - set debugger in ts step files and use .vscode/launch.json (you might tweak your reports location)

{
  "version": "0.1.0",
  "configurations": [
    {
      "name": "debugMode",
      "type": "node",
      "request": "launch",      
      "console": "integratedTerminal",
      "internalConsoleOptions": "neverOpen", 
      "program": "node_modules/@cucumber/cucumber/bin/cucumber-js",
      "args": [
        "./features/*.feature",
        "--require-module",
        "ts-node/register",
        "--require", 
        "./steps/*.steps.ts",        
        "--tags",
        "@demoX",       
        "--format", "progress",
        "--format", "json:./Reports/cucumber_report.json"    
      ]
    }
  ]
}

How to debug Cucumber in Visual Studio Code (VSCode)?

6 Answers6

Linked