public class | source

Plugin

You can directly use instance of this class. plugin

Plugin system for your plugin.

Test:

Plugin:

Constructor Summary

Public Constructor
public	constructor create instance.

Member Summary

Private Members
private	_plugins: *

Method Summary

Public Methods
public	init(plugins: Array<{name: string, option: object}>) initialize with plugin property.
public	onComplete() handle complete
public	onHandleAST(ast: AST, filePath: string, code: string): * handle AST.
public	onHandleCode(code: string, filePath: string): string handle code.
public	onHandleCodeParser(parser: function(code: string), option: object, filePath: string, code: string): * handle code parser.
public	onHandleConfig(config: ESDocConfig): ESDocConfig handle config.
public	onHandleHTML(html: string, fileName: string): string handle HTML.
public	onHandleTag(tag: Tag): Tag handle tag.
public	onStart() handle start.

Private Methods
private	_execHandler(handlerName: string, ev: PluginEvent, giveOption: boolean) exec plugin handler.

Public Constructors

public constructor source

create instance.

Private Members

private _plugins: * source

Public Methods

public init(plugins: Array<{name: string, option: object}>) source

initialize with plugin property.

Params:

Name	Type	Attribute	Description
plugins	Array<{name: string, option: object}>		expect config.plugins property.

Name

Type

Attribute

Description

plugins

Array<{name: string, option: object}>

expect config.plugins property.

public onComplete() source

handle complete

public onHandleAST(ast: AST, filePath: string, code: string): * source

handle AST.

Params:

Name	Type	Attribute	Description
ast	AST		original ast.
filePath	string		source code file path.
code	string		original code. * @returns {AST} handled AST.

Return:

public onHandleCode(code: string, filePath: string): string source

handle code.

Params:

Name	Type	Attribute	Description
code	string		original code.
filePath	string		source code file path.

Name

Type

Attribute

Description

code

string

original code.

filePath

string

source code file path.

Return:

string

handled code.

public onHandleCodeParser(parser: function(code: string), option: object, filePath: string, code: string): * source

handle code parser.

Params:

Name	Type	Attribute	Description
parser	function(code: string)		original js parser.
option	object		default Espree options.
filePath	string		source code file path.
code	string		original code. * @returns {function(code: string)} handled parser.

Return:

public onHandleConfig(config: ESDocConfig): ESDocConfig source

handle config.

Params:

Name	Type	Attribute	Description
config	ESDocConfig		original esdoc config.

Name

Type

Attribute

Description

config

ESDocConfig

original esdoc config.

Return:

ESDocConfig

handled config.

public onHandleHTML(html: string, fileName: string): string source

handle HTML.

Params:

Name	Type	Attribute	Description
html	string		original HTML.
fileName	string		the fileName of the HTML file.

Name

Type

Attribute

Description

html

string

original HTML.

fileName

string

the fileName of the HTML file.

Return:

string

handled HTML.

public onHandleTag(tag: Tag): Tag source

handle tag.

Params:

Name	Type	Attribute	Description
tag	Tag		original tag(s).

Name

Type

Attribute

Description

tag

Tag

original tag(s).

Return:

Tag	handled tag.

public onStart() source

handle start.

Private Methods

private _execHandler(handlerName: string, ev: PluginEvent, giveOption: boolean) source

exec plugin handler.

Params:

Name	Type	Attribute	Description
handlerName	string		handler name(e.g. onHandleCode)
ev	PluginEvent		plugin event object.
giveOption	boolean	optional default: false	if true, event has plugin option.