56 lines
3.0 KiB
JavaScript
56 lines
3.0 KiB
JavaScript
/*global app: true, describe: true, expect: true, it: true, jasmine: true */
|
|
|
|
describe("plugins", function() {
|
|
var myGlobal = require('jsdoc/util/global');
|
|
myGlobal.jsdocPluginsTest = myGlobal.jsdocPluginsTest || {};
|
|
|
|
require('jsdoc/plugins').installPlugins(['test/fixtures/testPlugin1',
|
|
'test/fixtures/testPlugin2'], app.jsdoc.parser);
|
|
|
|
var docSet = jasmine.getDocSetFromFile("test/fixtures/plugins.js", app.jsdoc.parser);
|
|
|
|
it("should fire the plugin's event handlers", function() {
|
|
expect(myGlobal.jsdocPluginsTest.plugin1.fileBegin).toBeDefined();
|
|
expect(myGlobal.jsdocPluginsTest.plugin1.fileBegin).toEqual(true);
|
|
expect(myGlobal.jsdocPluginsTest.plugin1.beforeParse).toBeDefined();
|
|
expect(myGlobal.jsdocPluginsTest.plugin1.beforeParse).toEqual(true);
|
|
expect(myGlobal.jsdocPluginsTest.plugin1.jsdocCommentFound).toBeDefined();
|
|
expect(myGlobal.jsdocPluginsTest.plugin1.jsdocCommentFound).toEqual(true);
|
|
expect(myGlobal.jsdocPluginsTest.plugin1.symbolFound).toBeDefined();
|
|
expect(myGlobal.jsdocPluginsTest.plugin1.symbolFound).toEqual(true);
|
|
expect(myGlobal.jsdocPluginsTest.plugin1.newDoclet).toBeDefined();
|
|
expect(myGlobal.jsdocPluginsTest.plugin1.newDoclet).toEqual(true);
|
|
expect(myGlobal.jsdocPluginsTest.plugin1.fileComplete).toBeDefined();
|
|
expect(myGlobal.jsdocPluginsTest.plugin1.fileComplete).toEqual(true);
|
|
|
|
expect(myGlobal.jsdocPluginsTest.plugin2.fileBegin).toBeDefined();
|
|
expect(myGlobal.jsdocPluginsTest.plugin2.fileBegin).toEqual(true);
|
|
expect(myGlobal.jsdocPluginsTest.plugin2.beforeParse).toBeDefined();
|
|
expect(myGlobal.jsdocPluginsTest.plugin2.beforeParse).toEqual(true);
|
|
expect(myGlobal.jsdocPluginsTest.plugin2.jsdocCommentFound).toBeDefined();
|
|
expect(myGlobal.jsdocPluginsTest.plugin2.jsdocCommentFound).toEqual(true);
|
|
expect(myGlobal.jsdocPluginsTest.plugin2.symbolFound).toBeDefined();
|
|
expect(myGlobal.jsdocPluginsTest.plugin2.symbolFound).toEqual(true);
|
|
expect(myGlobal.jsdocPluginsTest.plugin2.newDoclet).toBeDefined();
|
|
expect(myGlobal.jsdocPluginsTest.plugin2.newDoclet).toEqual(true);
|
|
expect(myGlobal.jsdocPluginsTest.plugin2.fileComplete).toBeDefined();
|
|
expect(myGlobal.jsdocPluginsTest.plugin2.fileComplete).toEqual(true);
|
|
});
|
|
|
|
it("should add the plugin's tag definitions to the dictionary", function() {
|
|
var test = docSet.getByLongname("test");
|
|
|
|
expect(test[0].longname).toEqual("test");
|
|
expect(test[0].foo).toEqual(true);
|
|
});
|
|
|
|
it("should call the plugin's visitNode function", function() {
|
|
expect(myGlobal.jsdocPluginsTest.plugin1.visitNode).toBeDefined();
|
|
expect(myGlobal.jsdocPluginsTest.plugin1.visitNode).toEqual(true);
|
|
});
|
|
|
|
it("should not call a second plugin's visitNode function if the first stopped propagation", function() {
|
|
expect(myGlobal.jsdocPluginsTest.plugin2.visitNode).not.toBeDefined();
|
|
});
|
|
});
|