@ephox/mcagar

Tinymce agar wrapper

Stats

StarsIssuesVersionUpdatedCreatedSize
@ephox/mcagar
9,7757857.0.210 days ago5 years agoMinified + gzip package size for @ephox/mcagar in KB

Readme

Description

mcagar is a tinymce specific wrapping of agar's testing infrastructure. It is only a collection of modules.

Installation

mcagar is available as an npm package. You can install it via the npm package @ephox/mcagar

Installation for development

You need to use yarn to install the mcagar devDependencies since npm doesn't support package aliasing and that is used in the package.json.

Install from npm

npm install @ephox/mcagar

Usage

Only modules inside the api package should be used in other projects. All other modules are implementation detail. There are two types of modules available: BDD and Pipelines.

BDD modules are useful when testing using behavior-driven development testing, such as with Mocha. For information, see the BDD testing documentation.

Pipeline modules are an in-house testing framework that relies on Agar Step and Chains to create a pipeline of actions to perform. The pipeline syntax is, at the time of writing, slowly being removed and will eventually be deprecated. For information, see the Pipeline testing documentation.

Running tests

The tests can be run using bedrock via yarn test. Note, this will only run the tests on Chrome and will require chromedriver. You can use bedrock directly to test on other browsers. See bedrock for more details.

To run the tests on Chrome:

$ yarn test

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.