spec

An event-driven JavaScript unit testing library.

npm install spec
16 downloads in the last week
87 downloads in the last month

Spec

Build Status

Spec is an event-driven unit testing library. It provides several convenience methods for writing unit tests, and includes a configurable test runner that allows you to create routines for setting up and tearing down tests, handling assertions, failures, and errors, and logging test results.

Spec is environment and framework-agnostic: it has no external dependencies, and is compatible with web browsers, CommonJS environments, and JavaScript engines. It is also capable of testing both synchronous and asynchronous code.

Downloads

Current Version: 1.0.1

If you're a Node user, Spec is available on npm:

$ npm install spec

The annotated source code is available for your perusal.

Compatibility

Spec has been tested with the following web browsers, CommonJS environments, and JavaScript engines.

Web Browsers

CommonJS Environments

  • Node 0.2.6 and higher
  • Narwhal 0.3.2 and higher
  • RingoJS 0.4 and higher

JavaScript Engines

Contributing to Spec

Check out a working copy of the Spec source code with Git:

$ git clone git://github.com/kitcambridge/spec.git

If you'd like to contribute a feature or bug fix, you can fork Spec, commit your changes, and send a pull request. Please avoid submitting patches that are application- or environment-specific; Spec doesn't try to cover every possible testing scenario. Please make sure to update the unit tests in the test directory as well.

Alternatively, you may use the GitHub issue tracker to submit bug reports and feature requests. For the former, please make sure that you detail how to reproduce the bug, including the environments that exhibit it.

Coding Guidelines

In addition to the following Prototype-inspired guidelines, please follow the conventions already established in the code.

  • Spacing: Use two spaces for indentation. No tabs.
  • Naming: Keep variable and method names concise but descriptive. index and callback are preferable to i and fn.
  • Functions: Use named function expressions to aid in debugging. Avoid anonymous functions.
  • Comments: Significant changes and new methods should be annotated with comments.
  • Lint: Make sure that your changes pass JSHint. A configuration file is included in the repository; to check the source code for problems, install the JSHint command-line utility via {sudo} npm install -g jshint and run jshint.

Contributors

MIT License

Copyright © 2011-2014 Kit Cambridge.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

npm loves you