| 1 | [](https://travis-ci.org/jasmine/jasmine-npm)
|
| 2 |
|
| 3 | # The Jasmine Module
|
| 4 |
|
| 5 | The `jasmine` module is a package of helper code for developing Jasmine projects for Node.js.
|
| 6 |
|
| 7 | The core of jasmine lives at https://github.com/jasmine/jasmine and is `jasmine-core` in npm.
|
| 8 |
|
| 9 | ## Contents
|
| 10 |
|
| 11 | This module allows you to run Jasmine specs for your Node.js code. The output will be displayed in your terminal by default.
|
| 12 |
|
| 13 | ## Documentation
|
| 14 |
|
| 15 | http://jasmine.github.io/2.4/node.html
|
| 16 |
|
| 17 | ## Installation
|
| 18 | ```sh
|
| 19 | # Local installation:
|
| 20 | npm install --save-dev jasmine
|
| 21 |
|
| 22 | # Global installation
|
| 23 | npm install -g jasmine
|
| 24 | ```
|
| 25 |
|
| 26 | ## Initializing
|
| 27 |
|
| 28 | To initialize a project for Jasmine
|
| 29 |
|
| 30 | `jasmine init`
|
| 31 |
|
| 32 | To seed your project with some examples
|
| 33 |
|
| 34 | `jasmine examples`
|
| 35 |
|
| 36 | ## Usage
|
| 37 |
|
| 38 | To run your test suite
|
| 39 |
|
| 40 | `jasmine`
|
| 41 |
|
| 42 | ## Configuration
|
| 43 |
|
| 44 | Customize `spec/support/jasmine.json` to enumerate the source and spec files you would like the Jasmine runner to include.
|
| 45 | You may use dir glob strings.
|
| 46 | More information on the format of `jasmine.json` can be found in [the documentation](http://jasmine.github.io/2.4/node.html#section-Configuration)
|
| 47 |
|
| 48 | Alternatively, you may specify the path to your `jasmine.json` by setting an environment variable:
|
| 49 |
|
| 50 | `jasmine JASMINE_CONFIG_PATH=relative/path/to/your/jasmine.json`
|
| 51 |
|
| 52 | ## Support
|
| 53 |
|
| 54 | Jasmine Mailing list: [jasmine-js@googlegroups.com](mailto:jasmine-js@googlegroups.com)
|
| 55 | Twitter: [@jasminebdd](http://twitter.com/jasminebdd)
|
| 56 |
|
| 57 | Please file issues here at Github
|
| 58 |
|
| 59 | Copyright (c) 2008-2016 Pivotal Labs. This software is licensed under the MIT License.
|