karma-runner/karma

Document usePolling option in karma.config.js

Open

#2074 opened on Apr 28, 2016

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

Description

Expected behavior

Seeing all available options that materially affect the test harness here

Actual behavior

I don't see usePolling; which solves the problem of auto-watching mounted source files in Docker containers; cf. this SO thread.

Enviroment Details

  • Karma version (output of karma --version): 0.13.9
  • Relevant part of your karma.config.js file
    ...
    // won't work in a Docker container
    autoWatch: true,

    autoWatchBatchDelay: 1000,

    usePolling: true,
    ...

This makes it work with the following output from docker-compose logs, e.g.

image

image

Contributor guide

Tech stack
javascript
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
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.
clear
Prerequisites
basic knowledge of Karmafamiliarity with markdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
Locate the configuration file documentation at http://karma runner.github.io/0.13/config/configuration file.html. Add a section describing the 'usePolling' option, including its purpose (to enable file watching in Docker containers) and a usage example. Reference the linked Docker issue and Stack Overflow thread for context.