Testing

After building VexFlow with grunt, you will have a build/ folder containing files like vexflow-debug.js and vexflow-tests.js.

Load flow.html in a browser to run the tests.

Each class under src/ has a related test under tests/. For example, src/easyscore.ts is tested by tests/easyscore_tests.ts.

Suppose you just implemented a new class called Hello in src/hello.ts.

• To create tests/hello_tests.ts, you can copy one of the existing test files (e.g., tests/barline_tests.ts).
• Modify run.ts to import your test module, and add a line to VexFlowTests.run() to invoke your HelloTests.Start();
• The QUnit assertion methods are all globals (we are using QUnit 1.19.0).
• The VexFlowTests.runTests() method creates a visual test (that targets Canvas and SVG and all available fonts). In most of our tests, we assign const run = VexFlowTests.runTests; to improve code readability (since we run many visual tests).
• If you are testing algorithms & data structures, you can use test(testName, testCallback) directly (it's the global QUnit.test() function). Inside your testCallback method, you can use the QUnit assertion methods like ok, notOk, equal, notEqual, throws.

Other

If you are testing the internals of a class (e.g., private properties), TypeScript and eslint may complain.

You can disable warnings one line at a time with:

// eslint-disable-next-line
// @ts-ignore
obj.privateField = '123';

In extreme circumstances, you can silence TypeScript and eslint warnings for an entire test file by adding these lines to the top of the file:

/* eslint-disable */
// @ts-nocheck

obj.privateField = '123';
obj = unrelatedObjectWithDifferentType;