Skip to content


Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
A Karma plugin. Wrap JS or Coffee Files into Commonjs on the fly.
JavaScript CoffeeScript
branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
.npmignore Initial commit Initial commit Initial commit
index.js Semi-colons
package.json Change github-home


Preprocessor which enables you to load CoffeScript or Javascript CommonJS Modules on the fly using custom register and loader code.


The easiest way is to keep karma-commonjs-preprocessor as a devDependency in your package.json.

    "karma": "~0.10"
    "karma-commonjs-preprocessor": "~0.1"

You can simple do it by:

npm install karma-commonjs-preprocessor --save-dev


registerCmd Allows you to set the name of the function to wrap your module into. Default: "require.register"

isCoffeeScript Allows you to force enable or disable wrapping into coffee-script Format. If its set to false we decide based on the file-extension. Default: false

pathReplace Allows you to set filterer function for module names, for example, change all app/file to file. Default: false

        isCoffeeScript: true
        pathReplace: (path) ->
          path.replace(/^app\//, '')

Why not just bundle before running karma?

Creating a single bundle means "recompiling" the bundle anytime any file changes. On big project, this can significantly slow down the development. This plugin processes only files that changed.

How is this different from karma-commonjs?

karma-commonjs is a complete framework handling wrapping, registering and loading all files matching the preprocessor.

The wrapper code of this preprocessor is based on and the mechanism adapted from grunt-commonjs-coffee. It only wraps your code into a registering function.

So if you have existing bundles which are build from brunch or do include brunchs require.js directly you can use this preprocessor.

An example could look like this:

module.exports = (config) ->
    files: [

      'src/**/*.coffee': ['commonjs', 'coffee']
      'spec/**/*.coffee': ['coffee']

    plugins: [

This loads the require.js first and puts require.register into the global namespace. It then packages all coffee Files in the src directoy into commonjs modules and last but not least just executes the specs.

The resulting registering Code looks like this:

window.require.register({'PATH/TO/FILE.JS': function(exports, require, module) {


This plugin is basically a mix between grunt-commonjs-coffee and karma-commonjs.



For more information on Karma see the homepage.

Something went wrong with that request. Please try again.