npm install --save-dev livedoc-mocha
"test": "mocha --require livedoc-mocha"
这个脚本将启动 Mocha 并加载 livedoc-mocha 插件。
例如,在 tests/ 文件夹中创建一个 hello.spec.js 测试文件,内容如下:
const assert = require('assert');
describe('Hello', () => {
it('should return hello world', () => {
assert.strictEqual('Hello World', 'Hello World');
});
});
npm run test
输出结果如下:
Hello
✓ should return hello world
1 passing (2ms)
这表明测试已经成功运行。
例如,在 hello.spec.js 文件中添加 livedoc 标记:
const assert = require('assert');
/**
* @type {LivedocFSM}
* @desc Hello world测试
*/
describe('Hello', () => {
/**
* @Livedoc
* @desc 返回hello world
*/
it('should return hello world', () => {
assert.strictEqual('Hello World', 'Hello World');
});
});
npm run test
输出结果如下:
Hello
✓ should return hello world
1 passing (2ms)
Livedoc stats:
{
"specs": 1,
"tests": 1,
"suites": 1,
"assertions": 1,
"time": 2,
"livedoc": 1,
"livedocTime": 0
}
这表明 livedoc-mocha 插件已经成功加载和解析文档标记。