jsdoc-plugin-testSpec

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

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out /  Change )

Google+ photo

You are commenting using your Google+ account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s

This site uses Akismet to reduce spam. Learn how your comment data is processed.