The base class every plugin to be used with the FlowrAnalyzer must extend. Please do not create plugins directly based on this class, but use the classes referenced alongside the PluginType values! For example, if you want to create a plugin that determines the loading order of files, extend FlowrAnalyzerLoadingOrderPlugin instead. These classes also provide sensible overrides of FlowrAnalyzerPlugin.defaultPlugin to be used when no plugin of this type is registered or triggered.

Type Parameters

  • In = unknown
  • Out extends AsyncOrSync<unknown> = In

Hierarchy (View Summary)

Implements

Hierarchy-Diagram

UML class diagram of FlowrAnalyzerPlugin

Constructors

Properties

description: string

A short description of what the plugin does.

name: string

A unique, human-readable name of the plugin.

The type of the plugin, determining when and for what purpose it is applied during the analysis.

version: SemVer

The version of the plugin, ideally following semver.

Methods