import Plugin from 'esdoc-plugin-require-coverage/src/Plugin.js'

public class | source

Plugin

The require-coverage plugin

Static Member Summary

Static Public Members
public static get	DefaultOptions: Object The default options to use

Private Members
private	_coverageFilePath: * Path to the coverage.json file generated by ESDoc
private	_required: Number The coverage percentage required

Public Methods
public	checkCoverage() Checks the docs coverage against the limit specified in options
public	handleConfig(config: Object) Handles configuration passed in esdoc.json
public	handleOptions(options: Object) Handles options passed through the plugin key inside esdoc.json

The default options to use

Name	Type	Attribute	Description
required	Number	default: 90	The coverage percentage required

Path to the coverage.json file generated by ESDoc

The coverage percentage required

Checks the docs coverage against the limit specified in options

Error	Throws an error if coverage.json-file cannot be found
Error	Throws an error if coverage percentage is less than required

Handles configuration passed in esdoc.json

Name	Type	Attribute	Description
config	Object		The ESDoc configuration stored inside esdoc.json
config.destination	String		Needed for plugin to work

Handles options passed through the plugin key inside esdoc.json

Name	Type	Attribute	Description
options	Object	optional	The options to use
options.required	Number	optional default: Plugin.DefaultOptions.required	The coverage percentage required