ESDocCLI
Command Line Interface for esdoc2.
Example:
let cli = new ESDocCLI(process.argv);
cli.exec();
Constructor Summary
Public Constructor | ||
public |
constructor(argv: Object) Create instance. |
Member Summary
Private Members | ||
private |
|
Method Summary
Public Methods | ||
public |
exec() execute to generate document. |
Private Methods | ||
private |
_createConfigFromJSONFile(configFilePath: string): ESDocConfig create config object from config file. |
|
private |
create config object from package.json. |
|
private |
find esdoc2 config file. |
|
private |
show help of esdoc2 |
|
private |
show version of esdoc2 |
Public Constructors
Private Members
private _argv: ESDocCLIArgv source
Public Methods
Private Methods
private _createConfigFromJSONFile(configFilePath: string): ESDocConfig source
create config object from config file.
Params:
Name | Type | Attribute | Description |
configFilePath | string | config file path. |
private _createConfigFromPackageJSON(): ESDocConfig | null source
create config object from package.json.