mock-nodecg

A mock of some of the NodeCG APIs that can be used in unit tests, for both Node.js and the browser. Meant to be used with NodeCG v1.

Install

mock-nodecg is available on both npm and bower, and can be used in both Node.js and the browser.

npm:

npm install --save-dev mock-nodecg

bower:

bower install --save-dev nodecg/mock-nodecg

Table of Contents

• Node.js Example
• web-component-tester Example
• Features
• Planned Features
• Contributing

Node.js Example

See the nodecg-utility-obs tests for an example of using mock-nodecg in server-side Node.js tests using AVA.

web-component-tester Example

See the nodecg-widget-obs tests for an example of using mock-nodecg in client-side browser tests using web-component-tester.

Features

• Mocks sendMessage, listenFor, Replicant and NodeCG's Logger class with sinon stubs.

Planned Features

• None currently, but feel free to open an issue or a pull request.

Contributing

The mock-nodecg team enthusiastically welcomes contributions and project participation! There's a bunch of things you can do if you want to contribute! The Contributor Guide has all the information you need for everything from reporting bugs to contributing entire new features. Please don't hesitate to jump in if you'd like to, or even ask us questions if something isn't clear.

All participants and maintainers in this project are expected to follow Code of Conduct, and just generally be kind to each other.

Please refer to the Changelog for project history details, too.