• Stars
    star
    173
  • Rank 210,815 (Top 5 %)
  • Language
    JavaScript
  • License
    BSD 2-Clause "Sim...
  • Created over 11 years ago
  • Updated about 3 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Yeoman generator for Karma

Karma generator Build Status

See the Karma documentation for more info.

Why Karma?

Karma runs the tests in the browser, but reports them in the CLI. This greatly improves your workflow by giving you constant, accurate feedback on the status of your tests.

Usage

Install it globally npm install -g generator-karma.

Running yo karma will generate a config file for your project: karma.conf.js. It will then install the npm dependencies.

By default, running yo karma will generate a pretty boring (and almost useless) config file. The real power is using the options to specify almost every part of the config file.

Options

There are a lot of options going on here. None of them are required and most are probably only useful when used with other generators calling this one.

Options are specified after yo karma. Example:

yo karma --skip-install --frameworks=jasmine --app-files='app/**/*.js,public/**/*.js'

The full list:

  • --frameworks Type: String, Default: 'jasmine'

Specifies which testing frameworks to use (CSV list). Example --frameworks=mocha,chai,requirejs,sinon

  • --browsers Type: String, Default: 'PhantomJS'

What browsers to test in (CSV list).

  • --app-files Type: String, Default: ''

List of application files (CSV list). There are purely the files you edit that make up your test.

  • --test-files Type: String, Default: ''

List of test files (CSV list), including spec and mock files.

  • --files-comments Type: String, Default: ''

List of comments to add to files properties. It can be used to support bower dependencies wiring using wiredep.

  • --exclude-files Type: String, Default: ''

List of files to exclude (CSV list). Files you don't want tested.

  • --plugins Type: String, Default: ''

Specify Karma plugins (npm modules). Use the full name like karma-junit-reporter.

  • --bower-components Type: String, Default: ''

Optional components to use for testing (CSV list of components).

  • --bower-components-path Type: String, Default: 'bower_components'

Directory where Bower components are installed, if not in the default location.

  • --base-path Type: String, Default: ''

Will be used to resolve files and exclude in the karma.conf.js file.

  • --web-port Type: Number, Default: 8080

Web server port to run Karma from.

  • --template-path Type: String, Default: '../templates'

If you would like to specify a different template to use, give the path to that folder.

  • --config-file Type: String, Default: ''

The config file name to write to. Useful if you want a different name like karma-e2e.conf.js.

  • --config-path Type: String, Default: './test'

Path where the config files should be written to. This is where the karma.conf.js file will be placed.

Composing With This Generator

This generator is now able to work with other generators. Any option specified above can be passed in. All of the csv type arguments can also accept arrays.

To use this, first include it as a devDependencies in the calling generator.

Next, include the code to actually use it:

this.composeWith('karma:app', {
  options: {
    frameworks: ['mocha', 'chai', 'sinon']
    ]
  }
}, {
  local: require.resolve('generator-karma/generators/app/index.js')
});

Migrating from version 1: The CoffeeScript and Gruntfile options have been remove. This is to make this generator more streamlined. Those should be built on top of this generator if people want a generator with that functionality.

Configuration

Karma can be configured by editing karma.conf.js. See the documentation page on the config file for an exhaustive list of options.

Contribute

See the contributing docs

License

BSD-2-Clause

More Repositories

1

yeoman

Yeoman - a set of tools for automating development workflow
10,023
star
2

generator-angular

Yeoman generator for AngularJS
JavaScript
5,749
star
3

generator-webapp

A gulp.js generator for modern webapps
JavaScript
3,773
star
4

yo

CLI tool for running Yeoman generators
JavaScript
3,755
star
5

generator-chrome-extension

Scaffold out a Chrome extension
JavaScript
2,596
star
6

update-notifier

Update notifications for your CLI app
JavaScript
1,742
star
7

grunt-usemin

[UNMAINTAINED] Replaces references to non-optimized scripts or stylesheets into a set of HTML files (or any templates/views)
JavaScript
1,224
star
8

generator-generator

Generate a Yeoman generator
JavaScript
1,213
star
9

generator

Rails-inspired generator system that provides scaffolding for your apps
TypeScript
1,172
star
10

yeoman-app

A desktop app that scaffolds projects using Yeoman
JavaScript
988
star
11

generator-webapp_DEPRECATED

Yeoman generator that scaffolds out a front-end web app
JavaScript
980
star
12

generator-polymer

Scaffold out a Polymer project
JavaScript
931
star
13

generator-mobile

Scaffold out a mobile project based on Web Starter Kit
JavaScript
918
star
14

configstore

Easily load and persist config without having to think about where and how
JavaScript
853
star
15

yeoman.io

Yeoman website
CSS
790
star
16

generator-backbone

Scaffold out a Backbone.js project
JavaScript
639
star
17

generator-node

Create a Node.js module
JavaScript
577
star
18

insight

Node.js module to help you understand how your tool is being used by anonymously reporting usage metrics to Google Analytics
JavaScript
554
star
19

bower-requirejs

[DEPRECATED] Automagically wire-up installed Bower components into your RequireJS config
JavaScript
376
star
20

generator-chromeapp

Scaffold out a Chrome app
JavaScript
311
star
21

stringify-object

Stringify an object/array like JSON.stringify just without all the double-quotes
JavaScript
302
star
22

grunt-filerev

[DEPRECATED] File revving
JavaScript
260
star
23

yosay

Tell Yeoman what to say
JavaScript
207
star
24

grunt-bower-requirejs

[DEPRECATED] Grunt task - Automagically wire-up installed Bower components into your RequireJS config
JavaScript
199
star
25

generator-bootstrap

Yeoman generator for Bootstrap
JavaScript
187
star
26

environment

Yeoman runtime environment
JavaScript
123
star
27

generator-jquery

Generate a jQuery plugin
JavaScript
85
star
28

generator-gruntfile

Create a basic Gruntfile with yo.
JavaScript
74
star
29

doctor

Detect potential issues with users system that could prevent Yeoman from working correctly
JavaScript
61
star
30

yeoman-assert

Assert utility from yeoman
JavaScript
53
star
31

yeoman-generator-list

JavaScript
52
star
32

yeoman-test

Test utilities for Yeoman generators
TypeScript
42
star
33

generator-mocha

Yeoman generator for Mocha
JavaScript
42
star
34

generator-gruntplugin

Create a gruntplugin module with yo, including Nodeunit unit tests.
JavaScript
35
star
35

generator-jasmine

Yeoman generator for Jasmine
JavaScript
34
star
36

yeoman-character

The Yeoman character in your CLI. Like wat.
JavaScript
22
star
37

yeoman-welcome

Yeoman welcome message used in generators
JavaScript
19
star
38

media

Yeoman logo and artwork
15
star
39

generator-commonjs

Generate a CommonJS module
JavaScript
15
star
40

insight-dashboard

[DEPRECATED] Insight into Yeoman
CSS
11
star
41

Hackathons

Running a Yeoman hackathon? Start here for ideas, tips, and goals
10
star
42

html-wiring

[DEPRECATED] Set of utilities to update HTML files
JavaScript
10
star
43

cli-list

Parse comma-separated argument lists.
JavaScript
8
star
44

yeoman-remote

Fetch packages and archives from remote resources with cache support
JavaScript
8
star
45

generator-dummytest

JavaScript
3
star
46

generator-dummy

Dummy generator used for unit testing purpose
JavaScript
2
star