Copyright (c) 2012, Lawrence S. Maccherone, Jr.
Enables the use of Sencha's JSDuck for documenting CoffeeScript projects.
You can then run jsduck on jsduckify's output to generate beautiful documentation for your CoffeeScript project.
Your CoffeeScript source is also included in the output wrapped in javascript block comments
(/*
…*/
) which allows users of the documentation to see your CoffeeScript when the user
of the resulting documentation clicks on "view source".
Here is what running jsduckify looks like when run against itself.
jsduckify
in the root of your CoffeeScript module and it has reasonable
defaults for all output. It uses the name of the name of the module (in package.json
)for documentation output.Usage:
jsduckify [options] [module_directory (default .)]
Options:
--help, -h : Displays this help
--prefix, -p <prefix> : Specifies the root to prefix all documentation (default: <module_name>)
--output, -o <output_directory> : Output directory (default: <prefix>_jsduckify)
--docsoutput, -d <doc_directory>: JSDuck output directory (default: <module_name>_jsduckify_JSDuckDocs)
--noduck, -n : Tells jsduckify not to call JSDuck when done duckifying
--readme, -r : Tells jsduckify to use the README.md as the docs for the main file
Let's require it
{duckifyFiles, documentExportsAPI} = require('./')
Let's give it a very simple bit of CoffeeScript source code containing a properly formatted block comment header.
source = """
callSomething(anything)
###
@class MyClass
documentation for MyClass here
###
class MyClass
"""
Let's call it and output the results.
exportsAPI = documentExportsAPI('./')
sourceFileMap = {'MyClass.coffee': source}
duckifiedFileMap = duckifyFiles(sourceFileMap, 'myPrefix', exportsAPI)
for filename, outputSource of duckifiedFileMap
console.log("Duckified #{filename}...")
console.log(outputSource)
# /* <CoffeeScript>
# callSomething(anything)
#
# </CoffeeScript> */
# /**
# * @class myPrefix.MyClass
# * documentation for MyClass here
# */
# /* <CoffeeScript>
# class MyClass
# </CoffeeScript> */
npm install jsduckify --save-dev
The above command installs jsduckify into your current node_modules and adds it to the devDependencies section of your package.json
###…###
docstrings to JavaScript block comments /*…*/
require
-able CoffeeScript node module and uses the exports API to audit
that you've covered all of the APICopyright (c) 2012, Lawrence S. Maccherone, Jr.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.