Skip to content

Commit 2682bff

Browse files
authoredNov 27, 2018
feat(docs): callout the key debug strategies. (#3219)
1 parent 4e87902 commit 2682bff

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed
 

Diff for: ‎docs/intro/05-troubleshooting.md

+12-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,16 @@
11
pageTitle: Troubleshooting
22
menuTitle: Troubleshooting
33

4-
Here you'll find a list of the most common problems and how to solve it.
4+
### How Do I Debug a karma issue?
5+
6+
Many issues can be solved by reading the `debug log` or by using the `browsers devtools`:
7+
8+
#### Use `--log-level debug` to investigate server-side issues, especially configuration issues.
9+
The `DEBUG` log includes a copy of the final 'config': note that plugins can alter the config and sometimes the settings you applied do not give the result you expected. The log includes both core `karma` lines and lines from plugins: use the logging prefix to determine if your issue may need to be reported to a karma plugin.
10+
11+
#### Use `--no-single-run` to investigate browser-side issues, especially global errors in test files.
12+
The `--no-single-run` option causes the server to print a URL and wait. Open the URL in a browser and use the browsers devtools to investigate the problem. Typically you will want to open the URL, then click the DEBUG link in the upper right corner. That opens a new window with cleaner code for debugging.
513

6-
Note: If you can't find the solution for your issue here you can also ask for help in the [mailing-list](https://groups.google.com/d/forum/karma-users) or [Stack Overflow](http://stackoverflow.com/questions/tagged/karma-runner).
714

815
### I'm getting an error during the installation related to the ```ws``` module, how can I solve it?
916
This is a common Windows [issue](https://github.com/einaros/ws/issues/178), the compilation of the native [ws](https://www.npmjs.org/package/ws) module fails. Anyways, ```ws``` has a fallback JS implementation which NPM should take care using it. All you need to do is make sure that you're using an up-to-date version of NPM. To do that you can:
@@ -41,3 +48,6 @@ Try to remove `karma` and `karma-*` modules from your `node_modules` first (for
4148

4249
### My tests are running really slow. What's going on?
4350
Make sure the Karma's tab is active. Browsers give inactive tabs only minimum CPU.
51+
52+
Note: If you can't find the solution for your issue here you can also ask for help in the [mailing-list](https://groups.google.com/d/forum/karma-users) or [Stack Overflow](http://stackoverflow.com/questions/tagged/karma-runner).
53+

0 commit comments

Comments
 (0)