Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

karma-chrome-launcher

karma-runner7.8mMIT3.2.0TypeScript support: definitely-typed

A Karma plugin. Launcher for Chrome and Chrome Canary.

karma-plugin, karma-launcher, chrome

readme

karma-chrome-launcher

js-standard-style npm version npm downloads

Build Status Dependency Status devDependency Status

Launcher for Google Chrome, Google Chrome Canary and Google Chromium.

Installation

The easiest way is to keep karma-chrome-launcher as a devDependency in your package.json, by running

$ npm i -D karma-chrome-launcher

Configuration

// karma.conf.js
module.exports = function(config) {
  config.set({
    browsers: ['Chrome', 'Chrome_without_security'], // You may use 'ChromeCanary', 'Chromium' or any other supported browser

    // you can define custom flags
    customLaunchers: {
      Chrome_without_security: {
        base: 'Chrome',
        flags: ['--disable-web-security', '--disable-site-isolation-trials']
      }
    }
  })
}

The --user-data-dir is set to a temporary directory but can be overridden on a custom launcher as shown below. One reason to do this is to have a permanent Chrome user data directory inside the project directory to be able to install plugins there (e.g. JetBrains IDE Support plugin).

customLaunchers: {
  Chrome_with_debugging: {
    base: 'Chrome',
    chromeDataDir: path.resolve(__dirname, '.chrome')
  }
}

You can pass list of browsers as a CLI argument too:

$ karma start --browsers Chrome,Chrome_without_security

Headless Chromium with Puppeteer

The Chrome DevTools team created Puppeteer - it will automatically install Chromium for all platforms and contains everything you need to run it from within your CI.

Available Browsers

Note: Headless mode requires a browser version >= 59

  • Chrome (CHROME_BIN)
  • ChromeHeadless (CHROME_BIN)
  • Chromium (CHROMIUM_BIN)
  • ChromiumHeadless (CHROMIUM_BIN)
  • ChromeCanary (CHROME_CANARY_BIN)
  • ChromeCanaryHeadless (CHROME_CANARY_BIN)
  • Dartium (DARTIUM_BIN)

Usage

$ npm i -D puppeteer karma-chrome-launcher
// karma.conf.js
process.env.CHROME_BIN = require('puppeteer').executablePath()

module.exports = function(config) {
  config.set({
    browsers: ['ChromeHeadless']
  })
}

For more information on Karma see the homepage.

changelog

3.2.0 (2023-04-20)

Features

  • add process.env.ProgramW6432 as root location for binaries (12a73db)

3.1.1 (2022-03-09)

Bug Fixes

  • artificially trigger a release (83fdc3c)

3.1.0 (2019-08-13)

Features

  • add --disable-dev-shm-usage flag to headless (137005d)

3.0.0 (2019-07-12)

Features

  • allow overriding of the default debug port (26ae9f4), closes #187

2.2.0 (2017-06-23)

Features

2.1.1 (2017-05-05)

Bug Fixes

  • add disable-renderer-backgrounding flag (6bfc170), closes #123

2.1.0 (2017-05-02)

Features

  • add support for custom user-data-dir in Chromium (579fcfc), closes #89
  • add support for headless Chrome/ChromeCanary (7446181)

2.0.0 (2016-08-18)

Features

  • Chromium support for Linux, Darwin and Windows (33e8d82)

1.0.1 (2016-05-02)

0.2.3 (2016-03-22)

Features

  • config: Allow --user-data-dir to be set in launcher properties (2c0b7f4)

0.2.2 (2015-12-01)

Bug Fixes

  • chrome will ignore command line flags it does not yet know about (426e7c3)

0.2.1 (2015-10-07)

Bug Fixes

  • ChromeCanary: on Linux (archlinux), it can be named google-chrome-unstable (28cb5b0)

<a name"0.2.0">

0.2.0 (2015-06-23)

Bug Fixes

  • Use fs-access shim for file detection. (6355ca88, closes #53)

<a name"0.1.9">

0.1.9 (2015-06-23)

<a name"0.1.8">

0.1.8 (2015-06-23)

<a name"0.1.7">

0.1.7 (2015-06-23)

<a name"0.1.6">

0.1.6 (2015-06-23)

Bug Fixes

  • jsFlags: un-quote --js-flags flag and automatically merge with presets (4509c277)

<a name"0.1.5">

0.1.5 (2015-06-23)

Bug Fixes

  • better error when DARTIUM_BIN not set (27462e86)

<a name"0.1.4">

0.1.4 (2015-06-23)

Bug Fixes

  • the translation is now disabled on launch (b2f389ba)

<a name"0.1.3">

0.1.3 (2015-06-23)

Features

  • Launcher: Add Dartium launcher. (ae81c0c1)

<a name"0.1.2">

0.1.2 (2015-06-23)

<a name"0.1.12">

0.1.12 (2015-06-23)

<a name"0.1.11">

0.1.11 (2015-06-23)

<a name"0.1.10">

0.1.10 (2015-06-23)

Bug Fixes

  • better error when DARTIUM_BIN not set (27462e86)
  • the translation is now disabled on launch (b2f389ba)
  • jsFlags: un-quote --js-flags flag and automatically merge with presets (4509c277)

Features

  • disable popup blocking by default (2cdace9e)
  • Launcher: Add Dartium launcher. (ae81c0c1)

<a name"0.1.1">

0.1.1 (2015-06-23)

Bug Fixes

  • handle Chrome location on Windows (62df3014)
  • correct Chrome path on Windows (9ebd9974, closes #2)

<a name"0.1.0">

0.1.0 (2015-06-23)

<a name"0.0.2">

0.0.2 (2015-06-23)

Features