1.0.0 • Published 7 years ago

jsdoc-plugin-testspec v1.0.0

Weekly downloads
2
License
MIT
Repository
github
Last release
7 years ago

Project logo

npm release Travis Dependency Status Codestyle badge Join the chat

JSDoc plugin which connects inline comments & mocha tests specs with docs elements.

Patreon User Twitter User

Description

JPST (jsdoc-plugin-testSpec) is jsdoc's plugin which connects inline comments & mocha tests specs with docs elements. Lets see example of files and what is generated with this plugin.

Source:

let t;

/**
 * module:basic~testFunction
 */
function testFunction(){
	// Inline comment.
	// Inline another comment.
}

/**
 * @test module:basic~testFunction
 */
t = describe('<your description>', () => {
	it('first test specification');
	it('second test specification');
});

Results:

Plugin results

Homepage

For more informations please visit projects official homepage.

https://urosjarc.github.io/jsdoc-plugin-testSpec

License

Copyright © 2016 Uroš Jarc

MIT License