min-karma

Minimal Karma runner Setup and Package — Start testing now!

Karma

Karma is a JavaScript Test Runner, one of the most popular and friendliest for beginners. The most notable advantage of Karma is testing in real browsers. See this StackOverflow answer for more information about Karma usage.

On the AngularJS team, we rely on testing and we always seek better tools to make our life easier. That's why we created Karma - a test runner that fits all our needs.

Why?

• Many setups are bloated with unnecessary options and packages.
• Start clean and minimal and extend as you go.
• Add single package to your project instead of many, to get your tests up and running.

Use cases

• You have a project and want to add unit/integration/whatever tests — install the package.
• You want to quickly evaluate Karma runner and play with in a clean folder — clone or download the repository.

Features

• Minimal functional Karma config file.
• Use as repository (git clone) or package (npm install).
• Installs all testing packages as dependencies, no need to install them manually.
• Automatically and gracefully (without overwriting) copied to your project directory:

  • Basic testing example inside demo folder.

  • Minimal functional configuration file karma.conf.js:

    module.exports = function (config) {
      config.set({
        frameworks: ['jasmine'],
        files: [
          'demo/**/*.js'
        ],
        browsers: ['Chrome']
      })
    }

If you are new to Node

Download and Install Node.js, see How do I get started with Node.js for more information.

To use as separate Repository:

Clone

git clone https://github.com/dmitriz/min-karma

or simply Download this Repository, unzip it and cd min-karma-master.

Install dependencies

npm install --save-dev

To use as Package (add to your project):

In your main project directory (should contain package.json):

npm install min-karma --save

Getting started

Run your tests:

karma start

Now try to edit files inside demo folder and see how karma is watching and updating your test results.

Basic testing demo — inside demo folder

// function to test
function add (a, b) {
  return a + b
}

// the test
describe('Addition', function () {
  it('should add numbers', function () {
    expect(add(2, 4)).toBe(6)
    expect(add(2, 4)).not.toBe(2)
  })
})

Tip. Keep your tests next to their testees for better cohesion. Avoid putting them into separate folders (like tests) away from your code.

Enjoy!