Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Capitalized 'Jasmine' twice and clarified how spec files are identified. #413

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Capitalized 'Jasmine' twice and clarified how spec files are identified. #413

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 11 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ jasmine-node

[![Build Status](https://secure.travis-ci.org/spaghetticode/jasmine-node.png)](http://travis-ci.org/spaghetticode/jasmine-node)

This node.js module makes the wonderful [Pivotal Lab's jasmine](http://github.com/pivotal/jasmine)
This node.js module makes the wonderful [Pivotal Lab's Jasmine](http://github.com/pivotal/jasmine)
spec framework available in node.js.

jasmine
Expand Down Expand Up @@ -53,10 +53,16 @@ Write the specifications for your code in `*.js` and `*.coffee` files in the `sp
You can use sub-directories to better organise your specs. In the specs use `describe()`, `it()` etc. exactly
as you would in client-side jasmine specs.

**Note**: your specification files must be named as `*spec.js`, `*spec.coffee` or `*spec.litcoffee`,
which matches the regular expression `/spec\.(js|coffee|litcoffee)$/i`;
otherwise jasmine-node won't find them!
For example, `sampleSpecs.js` is wrong, `sampleSpec.js` is right.
**Note**: Your specification files must be named as `*spec.js`, `*spec.coffee` or `*spec.litcoffee`,
which matches the regular expression `/spec\.(js|coffee|litcoffee)$/i`,
otherwise jasmine-node won't run them!

Another interesting point is that jasmine-node does a case-insensitive match against
the final `spec` in the file name, but it requires that the `.js`, `.coffee`, or `.litcoffee` suffix
must be all lowercase.

For example, `sampleSpecs.js` and `sampleSpec.JS` won't match or run, but `sampleSpec.js`, `sampleSPEC.js`
and `sample_spec.js` will run because they match the pattern.

If you have installed the npm package, you can run it with:

Expand Down