karma-runner/karma

Feature request: Provide an "is debug" signal

Open

#2809 opened on Aug 14, 2017

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

Description

@Krinkle is introducing Karma to the jQuery test suite, and it looks like our custom context file will be fairly complex. To avoid code duplication, I'd like to reuse it for a custom debug file, but we cannot because there's apparently no documented way to detect that it's being used for debug.

Expected behaviour

Something like an %IS_DEBUG% directive that gets replaced with true or false so debug-specific processing can happen dynamically.

Actual behaviour

We have to use something like /^[/]debug\b/.test(location.pathname), but I don't think /debug.html is actually part of your public API (though it is mentioned on the troubleshooting page).

Contributor guide

Tech stack
javascriptnodejs
Domain
testingtooling
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.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
JavaScriptNode.jsKarma middlewaredirectives
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
The issue requests adding an `%IS DEBUG%` directive similar to existing directives in `lib/middleware/karma.js`. Investigate how directives are currently processed (lines 235-240) and implement a new directive that resolves to `true` or `false` based on whether the request path contains `/debug`. Consider updating the troubleshooting page to document this feature. There is a related PR (#3744) in the jQuery test suite that may provide context.