Liking cljdoc? Tell your friends :D

karma-reporter CircleCI

A plugin for running ClojureScript tests with Karma.

Installation

The easiest way is to keep karma-reporter as a dependency in your project.clj:

Clojars Project

To be able to execute your ClojureScript tests with Karma, you have to install karma-cljs-test adapter. You can simply do it by:

npm install karma-cljs-test --save-dev

And of course, you need Karma. If you haven't installed it yet, follow these instructions.

Configuration

// karma.conf.js
module.exports = function(config) {
  var root = 'target/public/dev'// same as :output-dir

  config.set({
    frameworks: ['cljs-test'],

    files: [
      root + '/goog/base.js',
      root + '/cljs_deps.js',
      root + '/app.js',// same as :output-to
      {pattern: root + '/*.js', included: false},
      {pattern: root + '/**/*.js', included: false}
    ],

    client: {
      // main function
      args: ['app.test_runner.run']
    },

    // singleRun set to false does not work!
    singleRun: true
  })
}

Usage

(ns app.test-runner
  (:require [jx.reporter.karma :refer-macros [run-tests run-all-tests]]
            [foo.bar-test]))

(enable-console-print!)

; runs all tests in all namespaces
(defn ^:export run-all [karma]
  (run-all-tests karma))

; runs all tests in all namespaces - only namespaces with names matching
; the regular expression will be tested
(defn ^:export run-all-regex [karma]
  (run-all-tests karma #".*-test$"))

; runs all tests in the given namespaces
(defn ^:export run [karma]
  (run-tests karma 'foo.bar-test))

To execute tests from command line:

./node_modules/.bin/karma start

To execute tests from REPL (will use :cljs.test/default reporter):

(app.test-runner/run nil)

Can you improve this documentation?Edit on GitHub

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close