Typedef

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

Static Public

public Cmd: Object source

Commander.js command.

public Command: Object source

Command outline used to generate Commander commands and documentation.

Properties:

Name	Type	Attribute	Description
command	string
description	string
options	Option[]
examples	Example[]

Example:

{
    command: "release",
    description: "Bundles source for release.",
    options: [{
         flag: "-v, --verbose",
         description: "Output verbose error messages."
    }],
    examples: [{
         command: "-o path/to/target",
         description: "Bundled at path/to/target."
    }]
}

public Config: Object source

Project config.

Properties:

Name	Type	Attribute	Description
links	{files: string[], directories: []}		Paths used by Linker.
mybb_root	string		Absolute path to MyBB root.
vendor	string		Vendor name, e.g. `shinka` in `shinka-cli`. Used by Releaser.
code	string		Plugin codename, e.g. `cli` in `shinka-cli`. Used by Releaser.
version	string		Semantic version. Used by Releaser.

Example:

{
     links: {
         files: ["to/a/file", "to/another/file"],
         directories: ["to/a/dir", "to/another/dir"]
     },
     mybb_root: "C:/path/to/mybb/root",
     vendor: "shinka",
     code: "cli",
     version: "0.0.1-a"
}

public Example: Object source

Example outline used to generate --help output.

Properties:

Name	Type	Attribute	Description
command	string
description	string	nullable: true

Example:

{
    command: "-o path/to/target",
    description: "Bundled at path/to/target."
}

public LinkError: Object source

Properties:

Name	Type	Attribute	Description
path	string
error	Error

Example:

{
    path: "path/to/file",
    error: {
         code: "EEOT"
    }
}

See:

Linker

public LogObject: Object source

Object with #log method used to output progress.

Properties:

Name	Type	Attribute	Description
log	function

Example:

class Logger {
    log(msg) {
         console.log(msg);
     }
}

{
     log: (msg) => console.log(msg)
}

console

See:

Logger

public Option: Object source

Option outline used to generate Commander commands.

Properties:

Name	Type	Attribute	Description
flag	string
description	string	nullable: true

Example:

{
    flag: "-v, --verbose",
    description: "Output verbose error messages."
}

public Verbs: Object source

Strings used to build messages.

Properties:

Name	Type	Attribute	Description
past	string
present	string
gerund	string

Example:

{
     past: "Linked",
     present: "Link"
     gerund: "Linking"
}