Skip to content

Commit 8479205

Browse files
committed
chore: update debugging section in readme
1 parent 71cafae commit 8479205

File tree

2 files changed

+10
-1
lines changed

2 files changed

+10
-1
lines changed

README.md

+9-1
Original file line numberDiff line numberDiff line change
@@ -237,7 +237,15 @@ For example, if you want to only include files in the `app` folder, but exclude
237237

238238
## Debugging
239239

240-
Run tests with `DEBUG=code-coverage` environment variable to see log messages
240+
This plugin uses [debug](https://github.com/visionmedia/debug) module to output additional logging messages from its [task.js](task.js) file. This can help with debugging errors while saving code coverage or reporting. In order to see these messages, run Cypress from the terminal with environment variable `DEBUG=code-coverage`. Example using Unix syntax to set the variable:
241+
242+
```shell
243+
$ DEBUG=code-coverage npm run dev
244+
...
245+
code-coverage reset code coverage in interactive mode +0ms
246+
code-coverage wrote coverage file /code-coverage/.nyc_output/out.json +28ms
247+
code-coverage saving coverage report using command: "nyc report --report-dir ./coverage --reporter=lcov --reporter=clover --reporter=json" +3ms
248+
```
241249

242250
## License
243251

task.js

+1
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,7 @@ module.exports = {
9999
command,
100100
args.join(' ')
101101
)
102+
debug('current working directory is %s', process.cwd())
102103
return execa(command, args, { stdio: 'inherit' })
103104
}
104105
}

0 commit comments

Comments
 (0)