https://github.com/jeromeetienne/jsdoced.js

Test your javascript with jsdoc!
https://github.com/jeromeetienne/jsdoced.js

Last synced: 16 days ago
JSON representation

Test your javascript with jsdoc!

• Host: GitHub
• URL: https://github.com/jeromeetienne/jsdoced.js
• Owner: jeromeetienne
• Created: 2015-01-29T01:12:26.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2016-04-11T21:35:16.000Z (over 8 years ago)
• Last Synced: 2024-04-24T15:23:56.832Z (7 months ago)
• Language: JavaScript
• Homepage: http://jsdocedjs.org
• Size: 2.1 MB
• Stars: 36
• Watchers: 4
• Forks: 1
• Open Issues: 5
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
jsdoced.js

==============

Tool which read your javascript code with jsdoc and ensure your jsdoc is respected when it is executed.

You write your javascript files as usual, you add classic jsdoc to it because you are a nice guy. Now ```jsdoced.js yourCode.js``` will produce a ```yourCode.jsdoced.js``` code. It is the same as ```youCode.js``` but includes all the checks to ensure your jsdoc is respected.

It uses [better.js](http://betterjs.org) to perform this testing during execution.

As better.js works run in browser and node.js, you can use that in any javascript. To run the produces betterjs code, just include [better.js](https://github.com/jeromeetienne/better.js/blob/master/build/better.js)

To see how to easily include it in your software, be sure to check [this workflow](https://github.com/jeromeetienne/better.js/blob/master/contribs/jsdoced.js/WORKFLOW.md).

## Inline Help

```bash

$ jsdoced.js -h

Usage: jsdoced.js [options] file.js file2.js...

Makes sure jsdoc is respected during execution.

More about better.js at http://betterjs.org

Options:

	-m, --source-map	Generate source map file. file.js into file.js.map

	-d DIR			Write generated code into DIR with a folder hierachie similar to relative

		path to the original file.js.

	-o, --output    	Output file (default STDOUT).

	-s, --strict-jsdoc	If @return or no @param are undefined in jsdoc, check it is nothing during execution

	-p,--privatize-class	Privatize the classes

	--log	Log events on stderr

	--property	Enable Better.Property (beta)

	--noproperty	Disable Better.Property (beta)

	-h	Display inline help

	-v	Display version

servecachedir [DIR]	server this directory as cache directory. default to .betterjs

```