npmpackage.info

Gathering detailed insights and metrics for grunt-karma

Other packages similar to grunt-karma

grunt-karma-coveralls

2.5.4

An npm module for using Karma and Coveralls with Grunt

grunt-karma-sonar

0.2.29

Grunt plugin for integrating karma reports with sonar

grunt-cmp-karma

0.0.2

Grunt karma ranner for cmp components

karma-sourcemap-loader

0.4.0

Karma plugin that locates and loads existing javascript source map files.

Gathering detailed insights and metrics for grunt-karma

grunt-karma

Grunt plugin for Karma.

4.0.2

468

MIT

JavaScript

25.15 kB

45,482,537 2.3

Installations

npm install grunt-karma

Pull Requests

Open

18

Total

184

Closed

98

Merged

68

Issues

Open

39

Total

142

Closed

103

Releases

v4.0.2

Published on 11 May 2021

v4.0.1

Published on 11 May 2021

v4.0.0

Published on 14 Apr 2020

v3.0.2

Published on 09 Apr 2019

v3.0.1

Published on 24 Nov 2018

v3.0.0

Published on 08 Sept 2018

View all 41 releases

Developer

karma-runner

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

Typescript Support

No

Node Version

12.22.1

NPM Version

6.14.4 Statistics

468 Stars

241 Commits

116 Forks

10 Watching

16 Branches

57 Contributors

Updated on 05 Aug 2024

Bundle Size

71.58 kB

Minified

25.15 kB

Minified + Gzipped

Bundlephobia

Languages

JavaScript (100%)

Total Downloads

Cumulative downloads

Total Downloads

45,482,537

Last day

27.2%

17,211

Compared to previous day

Last week

5.5%

89,028

Compared to previous week

Last month

11.9%

354,106

Compared to previous month

Last year

-3%

4,111,108

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

grunt-karma

Grunt plugin for Karma

This current version uses karma@^3.0.0. For using older versions see the old releases of grunt-karma.

Getting Started

From the same directory as your project's Gruntfile and package.json, install karma and grunt-karma with the following commands:

1$ npm install karma --save-dev
2$ npm install grunt-karma --save-dev

Once that's done, add this line to your project's Gruntfile:

1grunt.loadNpmTasks('grunt-karma');

Config

Inside your Gruntfile.js file, add a section named karma, containing any number of configurations for running karma. You can either put your config in a [karma config file] or leave it all in your Gruntfile (recommended).

Here's an example that points to the config file:

1karma: {
2  unit: {
3    configFile: 'karma.conf.js'
4  }
5}

Here's an example that puts the config in the Gruntfile:

1karma: {
2  unit: {
3    options: {
4      files: ['test/**/*.js']
5    }
6  }
7}

You can override any of the config file's settings by putting them directly in the Gruntfile:

1karma: {
2  unit: {
3    configFile: 'karma.conf.js',
4    port: 9999,
5    singleRun: true,
6    browsers: ['PhantomJS'],
7    logLevel: 'ERROR'
8  }
9}

To change the logLevel in the grunt config file instead of the karma config, use one of the following strings: OFF, ERROR, WARN, INFO, DEBUG

The files option can be extended "per-target" in the typical way Grunt handles files:

1karma: {
2  options: {
3    files: ['lib/**/*.js']
4  },
5  unit: {
6    files: [
7      { src: ['test/**/*.js'] }
8    ]
9  }
10}

When using the "Grunt way" of specifying files, you can also extend the file objects with the options supported by karma:

1karma: {
2  unit: {
3    files: [
4      { src: ['test/**/*.js'], served: true },
5      { src: ['lib/**/*.js'], served: true, included: false }
6    ]
7  }
8}

Config with Grunt Template Strings in `files`

When using template strings in the files option, the results will flattened. Therefore, if you include a variable that includes an array, the array will be flattened before being passed to Karma.

Example:

1meta: {
2  jsFiles: ['jquery.js','angular.js']
3},
4karma: {
5  options: {
6    files: ['<%= meta.jsFiles %>','angular-mocks.js','**/*-spec.js']
7  }
8}

Sharing Configs

If you have multiple targets, it may be helpful to share common configuration settings between them. Grunt-karma supports this by using the options property:

1karma: {
2  options: {
3    configFile: 'karma.conf.js',
4    port: 9999,
5    browsers: ['Chrome', 'Firefox']
6  },
7  continuous: {
8    singleRun: true,
9    browsers: ['PhantomJS']
10  },
11  dev: {
12    reporters: 'dots'
13  }
14}

In this example the continuous and dev targets will both use the configFile and port specified in the options. But the continuous target will override the browser setting to use PhantomJS, and also run as a singleRun. The dev target will simply change the reporter to dots.

Running tests

There are three ways to run your tests with karma:

Karma Server with Auto Runs on File Change

Setting the autoWatch option to true will instruct karma to start a server and watch for changes to files, running tests automatically:

1karma: {
2  unit: {
3    configFile: 'karma.conf.js',
4    autoWatch: true
5  }
6}

Now run $ grunt karma

Karma Server with Grunt Watch

Many Grunt projects watch several types of files using grunt-contrib-watch. Config karma like usual (without the autoWatch option), and add background:true:

1karma: {
2  unit: {
3    configFile: 'karma.conf.js',
4    background: true,
5    singleRun: false
6  }
7}

The background option will tell grunt to run karma in a child process so it doesn't block subsequent grunt tasks.

The singleRun: false option will tell grunt to keep the karma server up after a test run.

Config your watch task to run the karma task with the :run flag. For example:

1watch: {
2  //run unit tests with karma (server needs to be already running)
3  karma: {
4    files: ['app/js/**/*.js', 'test/browser/**/*.js'],
5    tasks: ['karma:unit:run'] //NOTE the :run flag
6  }
7},

In your terminal window run $ grunt karma:unit:start watch, which starts the karma server and the watch task. Now when grunt watch detects a change to one of your watched files, it will run the tests specified in the unit target using the already running karma server. This is the preferred method for development.

Single Run

Keeping a browser window & karma server running during development is productive, but not a good solution for build processes. For that reason karma provides a "continuous integration" mode, which will launch the specified browser(s), run the tests, and close the browser(s). It also supports running tests in PhantomJS, a headless webkit browser which is great for running tests as part of a build. To run tests in continous integration mode just add the singleRun option:

1karma: {
2  unit: {
3    configFile: 'config/karma.conf.js',
4  },
5  //continuous integration mode: run tests once in PhantomJS browser.
6  continuous: {
7    configFile: 'config/karma.conf.js',
8    singleRun: true,
9    browsers: ['PhantomJS']
10  },
11}

The build would then run grunt karma:continuous to start PhantomJS, run tests, and close PhantomJS.

Using additional client.args

You can pass arbitrary client.args through the commandline like this:

1$ grunt karma:dev watch --grep=mypattern

License

MIT License

Stable Version

The latest stable version of the package.

Stable Version

4.0.2

CRITICAL

9.8/10

Summary

Grunt-karma vulnerable to prototype pollution

Affected Versions

<= 4.0.1

Patched Versions

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

4

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

Security-Policy

Determines if the project has published a security policy.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Reason

86 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw
Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
Warn: Project is vulnerable to: GHSA-fwr7-v2mv-hh25
Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7
Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x
Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
Warn: Project is vulnerable to: GHSA-9vvw-cc9w-f27h
Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
Warn: Project is vulnerable to: GHSA-h6ch-v84p-w6p9
Warn: Project is vulnerable to: GHSA-ff7x-qrg7-qggm
Warn: Project is vulnerable to: GHSA-j4f2-536g-r55m
Warn: Project is vulnerable to: GHSA-r7qp-cfhv-p84w
Warn: Project is vulnerable to: GHSA-74fj-2j2h-c42q
Warn: Project is vulnerable to: GHSA-pw2r-vq6v-hr8c
Warn: Project is vulnerable to: GHSA-jchw-25xp-jwwc
Warn: Project is vulnerable to: GHSA-cxjh-pqwp-8mfp
Warn: Project is vulnerable to: GHSA-957j-59c2-j692
Warn: Project is vulnerable to: GHSA-ww39-953v-wcq6
Warn: Project is vulnerable to: GHSA-pfrx-2q88-qq97
Warn: Project is vulnerable to: GHSA-qh2h-chj9-jffq
Warn: Project is vulnerable to: GHSA-m5pj-vjjf-4m3h
Warn: Project is vulnerable to: GHSA-j383-35pm-c5h4
Warn: Project is vulnerable to: GHSA-rm36-94g8-835r
Warn: Project is vulnerable to: GHSA-765h-qjxv-5f44
Warn: Project is vulnerable to: GHSA-f2jv-r9rf-7988
Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
Warn: Project is vulnerable to: GHSA-rc47-6667-2j5j
Warn: Project is vulnerable to: GHSA-6x33-pw7p-hmpq
Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37
Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22
Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp
Warn: Project is vulnerable to: GHSA-2pr6-76vf-7546
Warn: Project is vulnerable to: GHSA-8j8c-7jfh-h6hx
Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
Warn: Project is vulnerable to: GHSA-7x7c-qm48-pq9c
Warn: Project is vulnerable to: GHSA-rc3x-jf5g-xvc5
Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
Warn: Project is vulnerable to: GHSA-82v2-mx6x-wq7q
Warn: Project is vulnerable to: GHSA-5v2h-r2cx-5xgj
Warn: Project is vulnerable to: GHSA-rrrm-qjm4-v8hf
Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m / GHSA-xvch-5gv4-984h
Warn: Project is vulnerable to: GHSA-w7rc-rwvf-8q5r
Warn: Project is vulnerable to: GHSA-r683-j2x4-v87g
Warn: Project is vulnerable to: GHSA-px4h-xg32-q955
Warn: Project is vulnerable to: GHSA-93f3-23rq-pjfp
Warn: Project is vulnerable to: GHSA-jmqm-f2gx-4fjv
Warn: Project is vulnerable to: GHSA-pw54-mh39-w3hc / GHSA-xgh6-85xh-479p
Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
Warn: Project is vulnerable to: GHSA-r2j6-p67h-q639
Warn: Project is vulnerable to: GHSA-x2pg-mjhr-2m5x
Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
Warn: Project is vulnerable to: GHSA-44c6-4v22-4mhx
Warn: Project is vulnerable to: GHSA-4x5v-gmq8-25ch
Warn: Project is vulnerable to: GHSA-fxwf-4rqh-v8g3
Warn: Project is vulnerable to: GHSA-25hc-qcg6-38wj
Warn: Project is vulnerable to: GHSA-xfhh-g9f5-x4m4
Warn: Project is vulnerable to: GHSA-qm95-pgcg-qqfq
Warn: Project is vulnerable to: GHSA-cqmj-92xf-r6r9
Warn: Project is vulnerable to: GHSA-vx3p-948g-6vhq
Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9
Warn: Project is vulnerable to: GHSA-r628-mhmh-qjhw
Warn: Project is vulnerable to: GHSA-9r2w-394v-53qc
Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh
Warn: Project is vulnerable to: GHSA-qq89-hq3f-393p
Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v
Warn: Project is vulnerable to: GHSA-38fc-wpqx-33j7
Warn: Project is vulnerable to: GHSA-662x-fhqg-9p8v
Warn: Project is vulnerable to: GHSA-394c-5j6w-4xmx
Warn: Project is vulnerable to: GHSA-78cj-fxph-m83p
Warn: Project is vulnerable to: GHSA-fhg7-m89q-25r3
Warn: Project is vulnerable to: GHSA-g78m-2chm-r7qv
Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
Warn: Project is vulnerable to: GHSA-72mh-269x-7mh5
Warn: Project is vulnerable to: GHSA-h4j5-c7cj-74xg
Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh
Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp

Score

2.3

/10

Last Scanned on 2024-11-18

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to grunt-karma

Other packages similar to grunt-karma

grunt-karma

Installations

Pull Requests

18

184

98

68

Issues

39

142

103

Releases

Developer

karma-runner

Developer Guide

CommonJS

No

12.22.1

6.14.4

Statistics

Bundle Size

71.58 kB

25.15 kB

Languages

Total Downloads

45,482,537

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Peer Dependencies

Dev Dependencies

grunt-karma

Getting Started

Config

Here's an example that points to the config file:

Here's an example that puts the config in the Gruntfile:

Config with Grunt Template Strings in files

Sharing Configs

Running tests

Karma Server with Auto Runs on File Change

Karma Server with Grunt Watch

Single Run

Using additional client.args

License

Stable Version

4.0.2

CRITICAL

10

10

4

0

0

0

0

0

0

0

2.3

/10

Config with Grunt Template Strings in `files`