@stackline/karma-chrome-launcher

A Karma plugin. Launcher for Chrome and Chrome Canary.

Documentation | npm | Issues | Repository

Current package version: 1.0.2

Why this package?

@stackline/karma-chrome-launcher is the Stackline-maintained distribution of karma-chrome-launcher@3.2.0. It is an independent continuation of karma-chrome-launcher; original authors and licenses remain credited below.

Compatibility

Installation

npm install @stackline/karma-chrome-launcher

Preserve existing imports and plugin resolution with an npm alias:

npm install karma-chrome-launcher@npm:@stackline/karma-chrome-launcher

Usage and API reference

karma-chrome-launcher

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 @stackline/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.

Credits and original authors

• Original project: karma-chrome-launcher.
• Vojta Jina.
• Mark Ethan Trostler.
• Rogério Vicente.
• dignifiedquire.
• Jonathan Ginsburg.
• rogeriopvl.
• Friedel Ziegelmayer.
• greenkeeperio-bot.
• johnjbarton.
• Mark Trostler.
• Michał Gołębiowski-Owczarek.
• dependabot[bot].
• Andrey Taranov.
• Aymeric Beaumet.
• Filipe Guerra.
• Alexander Fedyashov.
• Darryl Pogue.
• David.
• Florian Richter.
• Florian-R.
• François SIMOND.
• Hai Feng Kao.
• J Rob Gant.
• J. Abbott.
• Jeff Cross.
• Joe Doyle.
• Julien Sanchez.
• Marko Vuksanovic.
• Nicholas Mitchell.
• Parashuram N.
• Stefan Bley.
• Tatsuyuki Ishi.
• Timo Tijhof.
• Vincent Voyer.
• aSemy.
• brutalcrozt.
• cexbrayat.
• daniel rodriguez.
• gkostov.
• semantic-release-bot.
• Copyright (C) 2011-2013 Google, Inc.
• Stackline maintenance: Alexandro Paixao Marques and Stackline contributors.

Original copyright, license notices and contributor acknowledgements remain part of this distribution. Stackline maintenance does not replace authorship of the original work.

License

MIT. See the license and notice files in the repository.

Community and Links

• Stackline website
• GitHub projects
• npm packages
• Reddit community — r/Stackline
• Maintainer LinkedIn

Use this repository's issue tracker for reproducible bugs and feature requests. Join r/Stackline for examples, usage questions and release discussions.