# karma-jspm

> Include jspm module loader for karma runs; allows dynamic loading of src and test files and modules

Latest version **2.2.3** (published 2017-04-02) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install karma-jspm
pnpm add karma-jspm
yarn add karma-jspm
bun add karma-jspm
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.2.3 |
| Published | 2017-04-02 |
| First published | 2014-08-19 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 73 |
| Author | Max Peterson |
| Maintainers | bitcollage, computmaxer |
| Keywords | karma-plugin, karma-adapter, jspm |

## Links

- npm: https://www.npmjs.com/package/karma-jspm
- Repository: https://github.com/Workiva/karma-jspm
- Homepage: https://github.com/Workiva/karma-jspm#readme
- Issues: https://github.com/Workiva/karma-jspm/issues
- npm.io page: https://npm.io/package/karma-jspm

## Dependencies (1)

- [glob](https://npm.io/package/glob.md) ~7.0.5

## Recent versions

- 2.2.3 (latest) — 2017-04-02
- 2.2.2 — 2017-03-02
- 2.2.1 — 2017-02-16
- 2.2.0 — 2016-07-11
- 2.1.1 — 2016-05-12
- 2.1.0 — 2016-03-21
- 2.0.2 — 2015-10-26
- 2.0.1 — 2015-08-19
- 2.0.1-beta.2 — 2015-08-12
- 2.0.1-beta.1 — 2015-07-20
- 2.0.0-beta.1 — 2015-07-07
- 1.1.5 — 2015-05-08
- 1.1.4 — 2015-02-02
- 1.1.3 — 2015-01-19
- 1.1.2 — 2015-01-05
- … 10 more at https://npm.io/package/karma-jspm/versions

## README

# karma-jspm  [![Build Status](https://travis-ci.org/Workiva/karma-jspm.svg?branch=master)](https://travis-ci.org/Workiva/karma-jspm)

karma-jspm includes the jspm module loader for karma runs. This allows dynamic loading of src/test files and modules. No longer do you need to worry about browserifying your src or tests before every test run!

##Installation##

Available in npm: `npm install karma-jspm --save-dev`

**This plugin assumes you are using jspm in your project.** You will need to have a `config.js` in the root of your project (though this is configurable) as well as a `jspm_packages` directory containing systemjs and the es6-module-loader.

**This plugin can now support JSPM 0.17 beta**
##Configuration##

*karma.conf.js*

Include this plugin in your frameworks:

```js
frameworks: ['jspm', 'jasmine'],
```

Karma auto loads plugins unless you specify a plugins config. If you have one, you'll also need to add it there:

```js
plugins: ['karma-jspm', 'karma-phantomjs-launcher'],
```

The `loadFiles` configuration tells karma-jspm which files should be dynamically loaded via systemjs *before* the tests run. Globs or regular file paths are acceptable. 


**You should not include these in the regular karma files array.** karma-jspm takes care of this for you.

```js
jspm: {
    // Edit this to your needs
    loadFiles: ['src/**/*.js', 'test/**/*.js']
}
```

That's it!


###Optional Configuration###

You may have named your jspm `config.js` file or `jspm_packages` directory something else. In this case simply add that to the jspm configuration in *karma.conf.js*:

```js
jspm: {
    config: "myJspmConfig.js",
    packages: "my_jspm_modules/"
}
```

For JSPM 0.17 Beta, you have to specify the `jspm.browser.js` file.

```js
jspm: {
    browser: "myJspmBrowser.js",
}
```

If you use jspm 0.17 beta >33 and are running tests in a browser without native Promise support (like phantomjs <2.5), you can load a polyfill by adding your file(s) 
in beforeFiles. For example, install babel-polyfill with `npm install --save-dev babel-polyfill` and then add the line below to the karma config:

```js
jspm: {
    beforeFiles: ['node_modules/babel-polyfill/dist/polyfill.js']
}
```

You may want to make additional files/a file pattern available for jspm to load, but not load it right away. Simply add that to `serveFiles`. 
One use case for this is to only put test specs in `loadFiles`, and jspm will only load the src files when and if the test files require them. Such a config would look like this:

```js
jspm: {
    loadFiles: ['test/**/*.js'],
    serveFiles: ['src/**/*.js']
}
```

By default karma-jspm ignores jspm's bundles configuration. To re-enable it, specify the `useBundles` option.

```js
jspm: {
    useBundles: true
}
```

Depending on your framework and project structure it might be necessary to override jspm paths for the testing scenario.
In order to do so just add the `paths` property to the jspm config object in your karma-configuration file, along with the overrides:
 
```js
jspm: {
    paths: {
        '*': 'yourpath/*.js',
        ...
    }
}
``` 

By default the plugin will strip the file extension of the js files. To disable that, specify the `stripExtension` option:

```js
jspm: {
    stripExtension: false
}
```

Most of the time, you do not want to cache your entire jspm_packages directory, but serve it from the disk. This is done by default, but can be reversed as follows:

```js
jspm: {
    cachePackages: true
}
```

---
_Source: https://npm.io/package/karma-jspm · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._