Home Reference Source Test

References

Documenter

summary
public	C Documenter Generates markdown documentation for commands.
public	C Presenter Generates markdown documentation for commands.
public	C Transformer Transforms data into strings for documentation.

Helper

summary
public	C Helper Outputs examples for usage (--help) information.

Linker

summary
public	C Linker Handles creating and destroying symlinks.
public	V verbs: {linking: Verbs, unlinking: Verbs} Strings used in composing messages.

Linker/tests

summary
public	F checkForFile(path: string) Removes a file if it exists.
public	F createFile(originalPath: string, linkPath: string)
public	F createLinks(paths: string[]) Creates symbolic links.
public	F fileExists(path: string): boolean
public	F getLinks(dir: string): string[] Gets files in a directory.
public	F removeFile(path: string): boolean
public	F removeLinks(dir: string) Empties a directory.
public	F resolvePaths(path: string): {originalPath: string, linkPath: string} Resolves file against current working directory and MyBB root.

Logger

summary
public	C Logger Drop-in replacement for console.log.

Releaser

summary
public	C Releaser Bundles source files for release.

Typedef

summary
public	T Cmd: Object Commander.js command.
public	T Command: Object Command outline used to generate Commander commands and documentation.
public	T Config: Object Project config.
public	T Example: Object Example outline used to generate --help output.
public	T LinkError: Object
public	T LogObject: Object Object with #log method used to output progress.
public	T Option: Object Option outline used to generate Commander commands.
public	T Verbs: Object Strings used to build messages.

commands

summary
public	F link(cmd: Command, config: Object) Creates symbolic links for designated files and directories.
public	F release(cmd: Object, config: Object) Bundles source files for release.
public	F relink(cmd: Object, config: Object) Destroys symbolic links for designated files and directories.
public	F unlink(cmd: Object, config: Object) Destroys symbolic links for designated files and directories.

Directories