Spectacular Test Runner for JavaScript
JavaScript Cucumber HTML Shell CoffeeScript TypeScript LiveScript
Latest commit 9ff095e Jan 19, 2017 @dignifiedquire dignifiedquire committed on GitHub Merge pull request #2541 from vivganes/devdoc
docs(runner): Document processKillTimeout property
Permalink
Failed to load latest commit information.
bin feat: remove `karma` binary in favor of karma-cli Nov 16, 2013
client feat: upstreamProxy config option to deal with proxies that adjust th… Sep 7, 2016
common refactor(client): Transferred lots of client logic to context, adding… Jun 26, 2016
context feat(client): capture confirm & prompt Jan 14, 2017
docs docs(runner): Document processKillTimeout property Jan 19, 2017
lib Merge pull request #2533 from vivganes/dev Jan 18, 2017
logo chore: add logo Jan 6, 2014
scripts test(travis): Added validate-commit-msg to Travis CI tests Mar 13, 2016
static refactor(client): Transferred lots of client logic to context, adding… Jun 26, 2016
tasks chore: Move to standard JS style. Jun 7, 2015
test Merge pull request #2533 from vivganes/dev Jan 18, 2017
.babelrc test(deps): upgrade to babel@6 Jun 26, 2016
.codeclimate.yml chore: Add .codeclimate.yml Jun 23, 2015
.eslintignore chore: Lint test files. Jun 8, 2015
.eslintrc refactor: Upgrade to eslint@2 Feb 18, 2016
.gitattributes chore: do not change pdf files line endings Jul 16, 2013
.gitignore refactor(client): Transferred lots of client logic to context, adding… Jun 26, 2016
.mailmap chore: update .mailmap to remove duplicate contributors Jan 28, 2013
.npmignore fix(cli): restore shell completion in the npm package Nov 16, 2016
.travis.yml chore: update npm on all node versions May 17, 2016
CHANGELOG.md chore: release v1.4.0 Jan 14, 2017
CODE_OF_CONDUCT.md chore: Add code of conduct May 15, 2015
CONTRIBUTING.md docs(contributing): fix markdown syntax (broken link) Sep 13, 2016
ISSUE_TEMPLATE.md docs(gh): fix typos Aug 22, 2016
LICENSE chore(license): update year Jun 29, 2016
README.md docs(readme): Update appveyor link Mar 19, 2016
appveyor.yml chore: upgrade npm on appveyor as well May 17, 2016
config.tpl.coffee fix(config): corrects spelling in example config template Dec 17, 2015
config.tpl.js fix(config): corrects spelling in example config template Dec 17, 2015
config.tpl.ls fix(config): corrects spelling in example config template Dec 17, 2015
config.tpl.ts feat(config): add support for TypeScript Jul 2, 2016
console.log refactor: make lint happy May 17, 2016
credentials switch saucelabs credentials from voijta to karmarunnerbot Oct 12, 2015
gruntfile.js refactor(client): Transferred lots of client logic to context, adding… Jun 26, 2016
package.json chore: switch from ghooks to husky Jan 15, 2017
requirejs.config.tpl.coffee fix(init): Make the requirejs config template normalize paths Jun 18, 2015
requirejs.config.tpl.js refactor: Upgrade to eslint@2 Feb 18, 2016
thesis.pdf chore: add my thesis Jul 16, 2013
wallaby.js chore: resetup wallabyjs for babel Jun 26, 2016

README.md

Karma

js-standard-style npm version npm downloads

Build Status Build Status Code Climate PRs Welcome Dependency Status devDependency Status

A simple tool that allows you to execute JavaScript code in multiple real browsers.

The main purpose of Karma is to make your test-driven development easy, fast, and fun.

Help and Support

For questions and support please use the mailing list or Gitter. The issue tracker is for bug reports and feature discussions only.

When should I use Karma?

  • You want to test code in real browsers.
  • You want to test code in multiple browsers (desktop, mobile, tablets, etc.).
  • You want to execute your tests locally during development.
  • You want to execute your tests on a continuous integration server.
  • You want to execute your tests on every save.
  • You love your terminal.
  • You don't want your (testing) life to suck.
  • You want to use Istanbul to automagically generate coverage reports.
  • You want to use RequireJS for your source files.

But I still want to use _insert testing library_

Karma is not a testing framework, nor an assertion library. Karma just launches a HTTP server, and generates the test runner HTML file you probably already know from your favourite testing framework. So for testing purposes you can use pretty much anything you like. There are already plugins for most of the common testing frameworks:

If you can't find an adapter for your favourite framework, don't worry and write your own. It's not that hard and we are here to help.

Which Browsers can I use?

All the major browsers are supported, if you want to know more see the browsers page.

Troubleshooting

See FAQ.

I want to use it. Where do I sign?

You don't need to sign anything but here are some resources to help you to get started...

Obligatory Screencast.

Every serious project has a screencast, so here is ours. Just click here and let the show begin.

Installation.

See installation.

Using it.

See configuration.

This is so great. I want to help.

Please, see contributing.

Why did you create this?

Throughout the development of AngularJS, we've been using JSTD for testing. I really think that JSTD is a great idea. Unfortunately, we had many problems with JSTD, so we decided to write our own test runner based on the same idea. We wanted a simple tool just for executing JavaScript tests that is both stable and fast. That's why we use the awesome Socket.io library and Node.js.

My boss wants a license. So where is it?

MIT License