This is the base class for all plugins that load and possibly transform files when they are loaded. Different from other plugins, these plugins trigger for each file that is loaded (if they applies to the file). See the FlowrAnalyzerFilesContext.addFile for more information on how files are loaded and managed.

It is upt to the construction to ensure that no two file plugins applies to the same file, otherwise, the loading order of these plugins will determine which plugin gets to process the file.

See DefaultFlowrAnalyzerFilePlugin for the no-op default implementation.

Hierarchy (View Summary)

Hierarchy-Diagram

UML class diagram of FlowrAnalyzerFilePlugin

Constructors

Properties

description: string

A short description of what the plugin does.

name: string

A unique, human-readable name of the plugin.

type: FileLoad = PluginType.FileLoad

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