Class: UsageParser

Defined in:

src\components\usage.coffee

Overview

Parses example files

Variables Summary

name =

"UsageParser"

Instance Method Summary

# (void) run(pkg) Includes the files from the examples directory as usage examples.

Constructor Details

# (void) constructor(options)

Creates a new UsageParser addUsage can optionally be given as an array of strings that will be concatenated by the module. This is to enhance readability of package.json

Parameters:

(options) ( Object ) — An optional set of options

Options Hash: (options):

encoding ( String ) — Encoding for reading the file ['utf-8']
replaceReferences ( Boolean ) — Replace '../' in examples with pkg name [true]
addUsage ( String ) — Additional text for the usage section ['']
exampleDir ( String ) — Examples dir to be used unless in package.json ['examples']

Instance Method Details

# (void) run(pkg)

Includes the files from the examples directory as usage examples. If this.options.replaceModuleReferences is true, Strings of the form '../' and "../" will be replaced by the package name, so that require("../") will show as require('my-package-name'). @returns [Promise