<commit_before># Stomp over Web Socket 

This is a fork of the work started by [jmsenil](http://github.com/jmesnil/stomp-websocket). The goals of this fork are:

 * Better mocking of a Stomp WebSocket server
   * Eliminating the need for running a broker to test
 * Node.js based testing
   * No need for a browser
 * Stomp/1.1 compatibility
 * Rewrite in CoffeeScript (most contentious, I'm sure)
   * Cleaner/simpler, but still just JavaScript
 * Pluggable WebSocket objects (MozWebSocket, JsSock)

The project now depends on CoffeeScript, Node.js, and Jasmine for development, but in return testing does not depend on the browser. This project infrastructure will lead to better test coverage and better mocking. For this reason, the library will be more suited for building on top of it.

Online [documentation][doc] describes the library API.

## Requirements

 * Node.js and NPM
 * NPM packages
   * coffee-script
   * jasmine-node
   * growl (optional)

## Building and Testing

To build JavaScript:

    cake build

To run tests:

    cake test

To continuously run tests on file changes:

    cake watch

## Browser Tests

* Make sure you have a running Stomp broker which supports the Web Sockets protocol
 (see the [documentation][doc])
* Open in your web browser the project's [test page](browsertests/index.html)
* Check all tests pass

## Use

The project contains an [chat example](example/chat/index.html) using stomp-websockets
to send and receive Stomp messages from a server.

## Authors

 * [jmsenil](http://github.com/jmesnil)
 * <NAME>

[doc]: http://jmesnil.net/stomp-websocket/doc/<commit_msg>updating the readme to be used as canonical<commit_after># Stomp over Web Socket 

The library file is located in `dist/stomp.js`.
It does not require any dependency (except WebSocket support from the browser!)

Online [documentation][doc] describes the library API.

## Development Requirements
For development (testing, building) the project requires Node.js, CoffeeScript, and Jasmine. This allows us to run tests without the browser continuously during development (see `cake watch`). 

 * Node.js and NPM
 * NPM packages
   * coffee-script
   * jasmine-node
   * growl (optional)

## Building and Testing

To build JavaScript:

    cake build

To run tests:

    cake test

To continuously run tests on file changes:

    cake watch

## Browser Tests

* Make sure you have a running Stomp broker which supports the Web Sockets protocol
 (see the [documentation][doc])
* Open in your web browser the project's [test page](browsertests/index.html)
* Check all tests pass

## Use

The project contains an [chat example](example/chat/index.html) using stomp-websockets
to send and receive Stomp messages from a server.

## Todo

 * Stomp/1.1 compatibility
 * Pluggable WebSocket objects (MozWebSocket, JsSock)

## Authors

 * [jmsenil](http://github.com/jmesnil)
 * [<NAME>](http://github.com/progrium)

[doc]: http://jmesnil.net/stomp-websocket/doc/
{'fraction_non_alphanumeric': 0.08119946091644205, 'fraction_numerical': 0.0013477088948787063, 'mean_word_length': 4.066552901023891, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 1, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6141438', 'n_tokens_mistral': 884, 'n_tokens_neox': 836, 'n_words': 363}