karma-runner/karma

Support console.dir for pretty-printed object dumps when captureConsole=true

Open

#1,763 opened on Dec 21, 2015

View on GitHub
 (1 comment) (10 reactions) (0 assignees)JavaScript (11,918 stars) (1,703 forks)batch import
help wantedtype: feature

Description

Sometimes when debugging I want to dump to console a pretty-printed object.

Normally in browser I'd use console.dir. In karma, this prints nothing, since dir is not listed here. I can use console.dir but the output is an ugly non-readable one-liner.

So the scope of this issue would be to

  1. enable logging for console.dir when captureConsole is true
  2. enhance a stringifier to be whitespace-aware (behing the flag), and pass that flag to the stringifier when logging from console.dir.
  3. maybe also change the depth in case of console.dir to be more than 3.

Would you be interested in receiving a PR with those changes?

Contributor guide

Tech stack
javascript
Domain
testing
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
JavaScriptKarma internals
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Examine how console methods are captured in client/karma.js around line 70, and see how console.log is stringified. Add console.dir support and modify the stringifier to optionally preserve whitespace and increase depth for dir. Check if there are any existing tests for console capture.